Spring 6.x 的四种 REST 客户端

Spring 6.x 中四种 REST 客户端

用于调用 REST 端点，它们在同步 / 非阻塞特性、API 风格、适用场景等方面有显著区别。

首先，RestTemplate，这个是比较旧的同步客户端，使用模板方法模式，可能在 Spring 5 之后推荐用其他的，但还存在。需要说明它的同步特性，API 风格是模板方法，比如 getForObject、postForEntity 这些方法，可能存在的问题，比如不支持非阻塞，未来可能被弃用

然后是 RestClient，这是 Spring 6 引入的新的同步客户端， fluent API，也就是链式调用，比如 restClient.get ().uri (...)，更现代，替代 RestTemplate 的。需要强调它的同步性，fluent API 设计，可能的优势，比如更简洁，支持函数式处理响应等。

接下来是 WebClient，这是 reactive 非阻塞的客户端，基于 Spring WebFlux，适合异步、非阻塞场景，fluent API，支持反应式类型如 Mono、Flux。需要说明它的非阻塞特性，依赖的技术栈，适用场景比如高并发、I/O 密集型应用。

然后是 HTTP Interface，这是通过注解的接口，动态代理生成实现，比如定义一个接口，用 @GetExchange 等注解，然后 Spring 会生成代理来调用，更简洁，类似 Feign 的风格。需要说明它的使用方式，依赖其他客户端（可能基于 RestClient 或 WebClient），适合希望用接口定义 API 的场景。

接下来需要从几个维度对比：同步 vs 非阻塞，API 风格（模板方法 vs fluent vs 接口），适用场景，依赖的技术，优缺点等。

可能用户的需求是选择适合自己场景的客户端，所以需要明确每个的特点和适用情况。比如如果是同步阻塞的应用，用 RestClient 而不是 RestTemplate；如果是反应式应用，用 WebClient；如果喜欢接口式编程，用 HTTP Interface。

以下是详细解析及对比：

一、核心特性与区别

1. RestTemplate

• 类型：同步阻塞式客户端

• API 风格：模板方法模式（Template Method API）

• 核心特性：

  • 最早引入的 REST 客户端，基于传统的HttpURLConnection或第三方 HTTP 库（如 Apache HttpClient）实现，完全同步阻塞（每个请求会阻塞当前线程直到响应返回）。

• 提供一系列模板方法（如getForObject()、postForEntity()、exchange()等），封装了 HTTP 请求的细节（如 URL 构建、参数设置、响应解析）。

  • 不支持非阻塞 I/O，也不兼容反应式编程模型。

• 适用场景：传统同步阻塞架构（如基于 Spring MVC 的应用），但已不推荐使用（Spring 5 后官方建议用更现代的客户端替代）。

• 优缺点：

  • 优点：历史悠久，文档丰富，易于理解（适合初学者）。

• 缺点：API 设计较陈旧，扩展性差，不支持非阻塞，未来可能被逐步弃用。

2. RestClient

• 类型：同步阻塞式客户端（Spring 6 新引入）

• API 风格：流式 API（Fluent API）

• 核心特性：

  • 作为 RestTemplate 的替代者，专为同步场景设计，完全基于流式调用（链式编程），例如：

  String result = restClient.get()
  .uri("/users/{id}", 1)
  .retrieve()
  .body(String.class);

    
- 支持函数式响应处理（如通过`onStatus()`自定义状态码处理），内置 JSON/XML 序列化（依赖`HttpMessageConverter`），且兼容`RestTemplate`的大部分功能。
  
- 仍为同步阻塞模型（与`RestTemplate`一致），但 API 更简洁、灵活，扩展性更强。
  
- **适用场景**：同步阻塞架构（如 Spring MVC 应用），需要现代 API 风格的场景（替代`RestTemplate`）。

- 优缺点：

  - 优点：流式 API 更直观，支持灵活的响应处理，兼容 Spring 生态（如拦截器、消息转换器）。
- 缺点：仍为同步阻塞，不适合高并发、I/O 密集型场景。

#### 3. WebClient

- **类型**：非阻塞反应式客户端

- **API 风格**：流式 API（Fluent API）

- 核心特性：

  - 基于 Spring WebFlux（反应式编程模型），依赖 Reactor 库，支持非阻塞 I/O（通过事件驱动模型处理请求，避免线程阻塞）。

  - 响应结果封装为反应式类型（Mono/Flux），适合异步、背压（Backpressure）场景，例如：

    ```java
  Mono<String> result = webClient.get()  
        .uri("/users/{id}", 1)  
      .retrieve()  
        .bodyToMono(String.class);  

• 支持全功能的 HTTP 操作（GET/POST/PUT 等），且兼容反应式生态（如与WebFlux控制器配合）。

• 适用场景：非阻塞、高并发的反应式架构（如基于 Spring WebFlux 的应用），或 I/O 密集型场景（需要高效利用线程资源）。

• 优缺点：

  • 优点：非阻塞特性适合高并发，支持反应式编程模型，资源利用率高。

• 缺点：需理解反应式编程（如Mono/Flux、背压等概念），学习成本较高；不适合简单的同步场景。

4. HTTP Interface

• 类型：基于接口的抽象客户端（动态代理实现）

• API 风格：注解式接口（Annotated Interface）

• 核心特性：

  • 通过

    注解接口

    定义 REST 端点，由 Spring 动态生成代理实现（底层可基于RestClient 或 WebClient ）。例如：

  public interface UserClient {
  @GetExchange("/users/{id}")
  User getUser(@PathVariable Long id);
  }

    
- 无需手动编写 HTTP 调用代码，只需定义接口和注解（如`@GetExchange`、`@PostExchange`），Spring 会自动生成调用逻辑。
  
  - 可灵活绑定底层客户端（默认基于`RestClient`，也可配置为`WebClient`支持反应式）。
  
- **适用场景**：希望通过接口抽象 REST 调用的场景（类似 Feign），追求代码简洁性（减少模板代码）。

- 优缺点：

  - 优点：代码极简，接口定义清晰，易于维护，支持同步 / 反应式（基于底层客户端）。
- 缺点：需依赖接口注解，灵活性略低（复杂场景可能仍需手动处理）。

### 二、关键维度对比表

| 维度          | RestTemplate                 | RestClient                      | WebClient                | HTTP Interface              |
| ------------- | ---------------------------- | ------------------------------- | ------------------------ | --------------------------- |
| 同步 / 非阻塞 | 同步阻塞                     | 同步阻塞                        | 非阻塞反应式             | 依赖底层（可同步 / 非阻塞） |
| API 风格      | 模板方法（如`getForObject`） | 流式 API（链式调用）            | 流式 API（链式调用）     | 注解接口（动态代理）        |
| 编程模型      | 传统同步                     | 传统同步                        | 反应式（Mono/Flux）      | 接口抽象（底层可选）        |
| 适用架构      | Spring MVC（不推荐）         | Spring MVC（推荐）              | Spring WebFlux（推荐）   | 任意（依赖底层）            |
| 核心优势      | 历史兼容                     | 现代同步 API，替代 RestTemplate | 高并发非阻塞，反应式支持 | 代码极简，接口化定义        |
| 学习成本      | 低                           | 中（流式 API）                  | 高（需反应式基础）       | 低（接口 + 注解）           |

### 三、选择建议

- 若需**同步阻塞调用**（如 Spring MVC 应用）：优先使用`RestClient`（替代`RestTemplate`），其流式 API 更简洁、灵活。
- 若需**非阻塞高并发调用**（如 Spring WebFlux 应用）：使用`WebClient`，充分利用反应式编程的优势。
- 若偏好**接口化编程**（简化代码）：使用`HTTP Interface`，底层可绑定`RestClient`（同步）或`WebClient`（非阻塞）。
- 避免使用`RestTemplate`：其 API 设计陈旧，未来可能被逐步弃用。