Spring6.1 新特性，四种方式调用 REST 接口（RestClient、WebClient、RestTemplate、HTTP Interface）

发表于 更新于 阅读次数： 16 本文字数： 749 阅读时长 ≈ 3 分钟

个人博客：无奈何杨（wnhyang）

个人语雀：wnhyang

共享语雀：在线知识共享

Github：wnhyang - Overview

官网

REST Clients :: Spring Framework

The Spring Framework provides the following choices for making calls to REST endpoints:

  • RestClient - synchronous client with a fluent API.
  • WebClient - non-blocking, reactive client with fluent API.
  • RestTemplate - synchronous client with template method API.
  • HTTP Interface - annotated interface with generated, dynamic proxy implementation.

RestClient

官方描述：RestClient 是一个同步 HTTP 客户端，它提供了一个现代、流畅的 API。它提供了对 HTTP 库的抽象，允许从 Java 对象到 HTTP 请求的方便转换，以及从 HTTP 响应创建对象。

Spring6.1 版本新特性。

创建

创建 RestClient 非常简单，可以使用静态 create 方法，也可以使用 builder 创建，其提供了非常丰富的定制化选项，请求工厂、消息转换器、拦截器、默认头、请求初始化器等等，简单易懂。

1
2
3
4
5
6
7
8
9
10
RestClient defaultClient = RestClient.create();
RestClient customClient = RestClient.builder()
  .requestFactory(new HttpComponentsClientHttpRequestFactory())
  .messageConverters(converters -> converters.add(new MyCustomMessageConverter()))
  .baseUrl("https://example.com")
  .defaultUriVariables(Map.of("variable", "foo"))
  .defaultHeader("My-Header", "Foo")
  .requestInterceptor(myCustomInterceptor)
  .requestInitializer(myCustomInitializer)
  .build();

使用

使用 RestClient 更为简单，请求 URL、Header、Body、相应 Response 接受、异常处理等等相当丰富简单。

1
2
3
4
5
6
7
String result = customClient.get()
        .uri("https://example.com/this-url-does-not-exist")
        .retrieve()
        .onStatus((code) -> code.value() / 100 == 4, (request, response) -> {
            throw new RuntimeException(response.getStatusCode() + " " + response.getHeaders());
        })
        .body(String.class);

WebClient

WebClient 是一个无阻塞、响应式的客户端，用于执行 HTTP 请求。它在 5.0 中引入，提供了 RestTemplate 的替代方案，支持同步、异步和流式传输场景。

早在 Spring5 版本中就已经出现，创建方法和 RestClient 差不多，简单示例如下，其他详细内容可参考官网可 Java Doc。

1
WebClient webClient = WebClient.builder().baseUrl("http://localhost:8081").build();

RestTemplate

相比于上面两位这个更是古老，也正因此更为常见，使用的更多。但是官网明确表示，推荐使用 RestClient 替换 RestTemplate，甚至还细心的整理了替换方案，可知官方可能计划着在未来彻底废弃 RestTemplate，也许哦。

HTTP Interface

官方描述：Spring Framework 允许您使用 @HttpExchange 方法将 HTTP 服务定义为 Java 接口。您可以将这样的接口传递给 HttpServiceProxyFactory，以创建一个代理，该代理通过 HTTP 客户端（如 RestClient 或 WebClient）执行请求。您还可以从 @Controller 实现用于服务器请求处理的接口。

简单的来讲，可以类比为 OpenFeign，使用方法是几乎一样的。

这个也是 Spring6 的特性，最开始官方支持了 WebFlux 的实现，后来才加入的 RestClient 和 RestTemplate，使用方式如上图。

方法级别的注解有下，是不是和使用 OpenFeign 时几乎一样了，其实不然，@RequestHeader、@RequestBody、@PathVariable、@RequestParam、@CookieValue 等等也是支持的。

1
2
3
4
5
@GetExchange
@PostExchange
@PutExchange
@DeleteExchange
@PatchExchange

小结

可以说在 Spring6.1 之后再进行 REST 调用就有更加丰富的选择了，而且更加简单方便。

写在最后

拙作艰辛，字句心血，望诸君垂青，多予支持，不胜感激。

个人博客：无奈何杨（wnhyang）

个人语雀：wnhyang

共享语雀：在线知识共享

Github：wnhyang - Overview