添加 QueryParams 与 RestTemplate

当我们需要向 RESTful 服务发送请求时，通常会使用 Spring 的 RestTemplate。RestTemplate 封装了许多使发送 HTTP 请求变得更加简单的 API，但有时候我们需要在请求 URL 后添加一些参数，比如查询字符串参数。这时候就需要使用 QueryParams。

什么是 QueryParams？

QueryParams 是指通过在 URI 上添加查询字符串参数来增强 HTTP 请求的技术。查询字符串参数是由多个键值对组成的，使用&符号分割，如下所示：

http://example.com/path?key1=value1&key2=value2

通常情况下，查询字符串参数会在原始 URL 后面添加问号，如下所示：

http://example.com/path?parm1=value1&param2=value2

为什么要使用 QueryParams？

使用 QueryParams 可以让我们更好地控制请求的参数，以获取更灵活的处理能力。

添加 QueryParams 到 RestTemplate

添加 QueryParams 到 RestTemplate 的步骤如下：

1. 设置请求参数，也就是查询字符串参数
2. 将参数添加到 URI 上
3. 发送请求并接受响应

添加查询参数

为了添加查询参数，我们必须先创建一个 MultiValueMap 对象来存储参数值。Spring 框架中使用 MultiValueMap 替代了传统的 Map，并且提供了更多的功能，用于替换 QueryParams。

以下代码演示了如何创建 MultiValueMap 对象，并向其中添加参数值：

MultiValueMap<String, String> map = new LinkedMultiValueMap<>();
map.add("param1", "value1");
map.add("param2", "value2");

将参数添加到 URI 上

当参数添加到 MultiValueMap 对象后，我们需要将它们添加到 URI 上。为此，我们需要使用 UriComponentsBuilder 类，该类允许我们构建一个新的 URI，同时添加查询参数。

以下代码演示了如何使用 UriComponentsBuilder 将参数添加到 URI 上：

UriComponentsBuilder builder = UriComponentsBuilder.fromUriString("http://example.com/path");
builder.queryParams(map);
URI uri = builder.build().toUri();

发送请求并接受响应

现在我们已经准备好发送请求了。为此我们需要使用 RestTemplate 类的 exchange 方法，如下所示：

RestTemplate restTemplate = new RestTemplate();
ResponseEntity<String> responseEntity = restTemplate.exchange(uri, HttpMethod.GET, null, String.class);
String responseBody = responseEntity.getBody();

结论

现在，我们已经掌握了添加 QueryParams 到 RestTemplate 的技巧。通过使用以上步骤，我们可以更好地管理查询参数，以获取更灵活的处理能力。