Spring Framework 6.1 M2 引入了 RestClient，一个新的同步 HTTP 客户端。顾名思义，RestClient 提供了 WebClient 的流畅 API 以及 RestTemplate 的基础设施。

十四年前，当 RestTemplate 在 Spring Framework 3.0 中引入时，我们很快发现，在一个模板式类中暴露 HTTP 的所有功能会导致过多的重载方法。因此，在 Spring Framework 5 中，我们为响应式 WebClient 使用了流畅的 API。通过 RestClient，我们引入了一个 HTTP 客户端，它提供了类似于 WebClient 的 API，并使用 RestTemplate 的消息转换器、请求工厂、拦截器和其他底层组件。

创建 RestClient

您可以使用其中一个静态的 create 方法来创建一个 RestClient。您也可以使用 RestClient::builder 获取一个构建器，该构建器提供更多选项，例如指定要使用的 HTTP 客户端、设置默认 URL、路径变量和标头，或注册拦截器和初始化器。

使用 RestClient::create(RestTemplate)，您可以使用现有 RestTemplate 的配置初始化一个 RestClient。

检索

让我们创建一个 RestClient，使用它设置一个基本的 GET 请求，并使用 retrieve 检索站点的內容作为字符串。

RestClient restClient = RestClient.create();

String result = restClient.get()
  .uri("https://example.com")
  .retrieve()
  .body(String.class);
System.out.println(result);

如果您对响应状态码和标头感兴趣，而不仅仅是内容，则可以使用 toEntity 获取 ResponseEntity。

ResponseEntity<String> result = restClient.get()
  .uri("https://example.com")
  .retrieve()
  .toEntity(String.class);

System.out.println("Response status: " + result.getStatusCode());
System.out.println("Response headers: " + result.getHeaders());
System.out.println("Contents: " + result.getBody());

RestClient 还可以将 JSON 转换为对象，在后台使用 Jackson。事实上，它可以转换 RestTemplate 支持的所有类型，因为它使用相同的消息转换器。消息转换器。请注意 uri 变量的使用，以及 Accept 标头设置为 JSON。

int id = ...
Pet pet = restClient.get()
  .uri("https://petclinic.example.com/pets/{id}", id)
  .accept(APPLICATION_JSON)
  .retrieve()
  .body(Pet.class);

POST

执行 POST 请求同样简单，如下所示

Pet pet = ...
ResponseEntity<Void> response = restClient.post()
  .uri("https://petclinic.example.com/pets/new")
  .contentType(APPLICATION_JSON)
  .body(pet)
  .retrieve()
  .toBodilessEntity();

错误处理

默认情况下，RestClient 在收到 4xx 或 5xx 状态码时会抛出一个 RestClientException 的子类。可以使用状态处理程序来覆盖此行为，如下所示

String result = restClient.get()
  .uri("https://example.com/this-url-does-not-exist")
  .retrieve()
  .onStatus(HttpStatusCode::is4xxClientError, (request, response) -> {
      throw new MyCustomRuntimeException(response.getStatusCode(), response.getHeaders())
  })
  .body(String.class);

交换

RestClient 提供了 exchange 方法用于更高级的场景，因为它提供了对底层 HTTP 请求和响应的访问。当您使用 exchange 时，前面提到的状态处理程序不会被应用，因为 exchange 函数已经提供了对完整响应的访问，允许您执行任何必要的错误处理。

Pet result = restClient.get()
  .uri("https://petclinic.example.com/pets/{id}", id)
  .accept(APPLICATION_JSON)
  .exchange((request, response) -> {
    if (response.getStatusCode().is4xxClientError()) {
      throw new MyCustomRuntimeException(response.getStatusCode(), response.getHeaders());
    }
    else {
      Pet pet = convertResponse(response);
      return pet;
    }
  });

对 RestClient 的支持

RestClient 只是 Spring Framework 6.1 提供的众多功能之一。众多功能。各种组件已经支持 RestClient：您可以通过 MockRestServiceServer 测试其用法，或将其用作 @HttpExchange 接口 的后端。

此外，Spring Boot 3.2 M1 将包含对 RestClient 的支持。