如何在 Spring RestTemplate 中使用 GET 请求发送参数

java

2024-03-13 07:07:50

使用 RestTemplate GET 请求实现参数化调用

在 RESTful API 开发中，经常需要在请求中传递参数。Spring RestTemplate 提供了便捷的方式来实现参数化 GET 请求，本文将详细介绍其用法。

问题

在使用 RestTemplate 进行 GET 请求时，如果仅设置请求头（不带请求体），并使用 RestTemplate.exchange() 方法，则请求参数无法正常传递。

解决办法

为了解决这个问题，需要使用 UriComponentsBuilder 构建带有查询参数的 URL。具体步骤如下：

1. 创建 UriComponentsBuilder

UriComponentsBuilder builder = UriComponentsBuilder.fromUriString(url);

2. 添加查询参数

builder.queryParam("msisdn", msisdn);
builder.queryParam("email", email);
builder.queryParam("clientVersion", clientVersion);
// ...继续添加其他查询参数

3. 构建带查询参数的 URL

String requestUrl = builder.toUriString();

4. 使用 RestTemplate 发送 GET 请求

HttpEntity entity = new HttpEntity(headers);
HttpEntity<String> response = restTemplate.exchange(requestUrl, HttpMethod.GET, entity, String.class);

示例代码

以下是完整的示例代码：

import org.springframework.http.*;
import org.springframework.web.client.RestTemplate;

public class RestTemplateGetWithParameters {

    public static void main(String[] args) {
        String url = "https://example.com/api/v1/users";

        HttpHeaders headers = new HttpHeaders();
        headers.set("Accept", "application/json");

        UriComponentsBuilder builder = UriComponentsBuilder.fromUriString(url);
        builder.queryParam("msisdn", "1234567890");
        builder.queryParam("email", "user@example.com");
        builder.queryParam("clientVersion", "1.0.0");

        String requestUrl = builder.toUriString();

        HttpEntity entity = new HttpEntity(headers);
        HttpEntity<String> response = restTemplate.exchange(requestUrl, HttpMethod.GET, entity, String.class);

        System.out.println(response.getBody());
    }
}