RestClient是Spring Boot 3.2 M1新的Rest客户端


RestClient是一个新HTTP客户端,它提供了与WebClient类似的API,并使用了消息转换器、请求工厂、拦截器以及RestTemplate的其他底层组件。

创建RestClient对象:

  • 可以使用静态的create方法创建一个RestClient:使用RestClient::create(RestTemplate),可以使用现有RestTemplate的配置来初始化RestClient。
  • 也可以使用RestClient::builder来获得一个具有更多选项的生成器,比如指定要使用的HTTP客户端,设置默认的URL、路径变量和头,或者注册拦截器和初始化器。

Get
通过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还可以使用Jackson在引擎盖下将JSON转换为对象。事实上,它可以转换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();

Error handling
默认情况下,当接收到4xx或5xx状态代码时,RestClient会抛出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);

Exchange
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;
    }
  });

Spring Boot 3.2 M1将包括对RestClient的支持。