百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分类 > 正文

Spring WebClient

ztj100 2025-08-03 09:28 4 浏览 0 评论

WebClient 是 Spring WebFlux 提供的一个非阻塞、响应式的 HTTP 客户端,用于替代传统的同步阻塞式客户端 RestTemplate。它是构建现代响应式微服务调用链的重要工具,适用于需要高性能、异步请求处理的场景。

一、什么是 WebClient?

  • 非阻塞 I/O:基于 Reactor 的 Mono 和 Flux,支持异步请求。
  • 函数式编程风格:使用链式调用方式编写清晰易读的代码。
  • 支持多种数据格式:JSON、XML、表单、流等。
  • 可扩展性强:支持拦截器、编码解码器、自定义过滤器等。
  • 与 Spring 生态集成良好:Spring Boot、Spring Security、R2DBC 等。

二、基本使用示例

1. 创建 WebClient 实例

WebClient webClient = WebClient.create("https://api.example.com");

也可以使用 builder 模式创建更复杂的配置:

WebClient webClient = WebClient.builder()
.baseUrl("https://api.example.com")
.defaultHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
.build();

2. GET 请求获取资源

Mono<User> userMono = webClient.get()
.uri("/users/{id}", 1)
.retrieve()
.bodyToMono(User.class);
userMono.subscribe(user -> System.out.println("User: " + user.getName()));

3. POST 请求提交数据

User newUser = new User("John", 30);
Mono<User> response = webClient.post()
.uri("/users")
.bodyValue(newUser)
.retrieve()
.bodyToMono(User.class);
response.subscribe(user -> System.out.println("Created user ID: " + user.getId()));

4. 处理错误(异常处理)

可以通过 .onStatus() 来捕获特定状态码的错误,并进行处理:

webClient.get()
.uri("/users/999")
.retrieve()
.onStatus(HttpStatus::is4xxClientError, clientResponse -> {
return Mono.error(new RuntimeException("Client error"));
})
.onStatus(HttpStatus::is5xxServerError, clientResponse -> {
return Mono.error(new RuntimeException("Server error"));
})
.bodyToMono(User.class)
.subscribe(
user -> System.out.println("User: " + user.getName()),
err -> System.err.println("Error occurred: " + err.getMessage())
);

5. 获取 Flux 流式数据

如果接口返回的是多个对象(如数组或集合),可以使用 Flux<T> 接收:

Flux<User> usersFlux = webClient.get()
.uri("/users")
.retrieve()
.bodyToFlux(User.class);
usersFlux.subscribe(user -> System.out.println("User: " + user.getName()));

三、高级功能

1. 设置超时时间

可以通过配置底层的 ReactorResourceFactory 或直接使用 Netty 配置:

HttpClient httpClient = HttpClient.create()
.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 5000)
.doOnConnected(conn -> conn
.addHandlerLast(new ReadTimeoutHandler(5))
.addHandlerLast(new WriteTimeoutHandler(5)));
WebClient webClient = WebClient.builder()
.clientConnector(new ReactorClientHttpConnector(httpClient))
.build();

2. 添加过滤器(拦截器)

WebClient webClient = WebClient.builder()
.baseUrl("https://api.example.com")
.filter((request, next) -> {
ClientRequest newRequest = ClientRequest.from(request)
.header("X-API-Key", "your-secret-key")
.build();
return next.exchange(newRequest);
})
.build();

3. 使用 ExchangeFunction 自定义逻辑

ExchangeFunction 可以完全控制请求和响应过程:

ExchangeFunction exchangeFunction = (request, clientResponse) -> {
// 自定义逻辑
return ExchangeFunctions.createDefault().exchange(request, clientResponse);
};
WebClient webClient = WebClient.builder()
.exchangeFunction(exchangeFunction)
.build();

四、WebClient vs RestTemplate

特性

RestTemplate

WebClient

是否非阻塞

否(同步)

是(异步)

响应式编程支持

不支持

支持(Mono/Flux)

函数式风格

性能

一般

更高(适合高并发)

是否推荐新项目使用

已废弃

推荐

五、最佳实践建议

  1. 避免阻塞操作:不要在 WebClient 调用后立即调用 .block(),除非你确实需要等待结果。
  2. 合理设置超时:网络调用要设置合理的连接和读写超时时间。
  3. 统一异常处理:使用 .onStatus() 统一处理错误响应。
  4. 复用 WebClient 实例:一个应用中通常只需要一个或少数几个 WebClient 实例。
  5. 结合重试机制:可以配合 Resilience4j、Retryable、Spring Retry 等实现自动重试。

六、常见问题

Q:什么时候应该使用 WebClient?

  • 在 Spring WebFlux 项目中
  • 需要异步非阻塞调用
  • 需要处理大量并发请求
  • 需要流式数据处理(如 SSE)
  • 微服务间通信(尤其是网关层)

Q:WebClient 如何调试?

可以在请求中添加日志打印:

.filter((req, next) -> {
System.out.println("Request: " + req.method() + " " + req.url());
return next.exchange(req);
})

总结:

WebClient 是 Spring WebFlux 中用于发起非阻塞、响应式 HTTP 请求的核心组件,是现代 Spring 应用中进行服务调用的最佳选择。

相关推荐

这个 JavaScript Api 已被废弃!请慎用!

在开发过程中,我们可能会不自觉地使用一些已经被标记为废弃的JavaScriptAPI。这些...

JavaScript中10个“过时”的API,你的代码里还在用吗?

JavaScript作为一门不断发展的语言,其API也在持续进化。新的、更安全、更高效的API不断涌现,而一些旧的API则因为各种原因(如安全问题、性能瓶颈、设计缺陷或有了更好的替代品)被标记为“废...

几大开源免费的 JavaScript 富文本编辑器测评

MarkDown编辑器用的时间长了,发现发现富文本编辑器用起来是真的舒服。...

比较好的网页里面的 html 编辑器 推荐

如果您正在寻找嵌入到网页中的HTML编辑器,以便用户可以直接在网页上编辑HTML内容,以下是几个备受推荐的:CKEditor:CKEditor是一个功能强大的、开源的富文本编辑器,可以嵌入到...

Luckysheet 实现excel多人在线协同编辑

前言前些天看到Luckysheet支持协同编辑Excel,正符合我们协同项目的一部分,故而想进一步完善协同文章,但是遇到了一下困难,特此做声明哈,若侵权,请联系我删除文章!若侵犯版权、个人隐私,请联系...

从 Element UI 源码的构建流程来看前端 UI 库设计

作者:前端森林转发链接:https://mp.weixin.qq.com/s/ziDMLDJcvx07aM6xoEyWHQ引言...

手把手教你如何用 Decorator 装饰你的 Typescript?「实践」

作者:Nealyang转发连接:https://mp.weixin.qq.com/s/PFgc8xD7gT40-9qXNTpk7A...

推荐五个优秀的富文本编辑器

富文本编辑器是一种可嵌入浏览器网页中,所见即所得的文本编辑器。对于许多从事前端开发的小伙伴来说并不算陌生,它的应用场景非常广泛,平时发个评论、写篇博客文章等都能见到它的身影。...

基于vue + element的后台管理系统解决方案

作者:林鑫转发链接:https://github.com/lin-xin前言该方案作为一套多功能的后台框架模板,适用于绝大部分的后台管理系统(WebManagementSystem)开发。基于v...

开源富文本编辑器Quill 2.0重磅发布

开源富文本编辑器Quill正式发布2.0版本。官方TypeScript声明...

Python之Web开发框架学习 Django-表单处理

在Django中创建表单实际上类似于创建模型。同样,我们只需要从Django类继承,则类属性将是表单字段。让我们在myapp文件夹中添加一个forms.py文件以包含我们的应用程序表单。我们将创建一个...

Django测试入门:打造坚实代码基础的钥匙

这一篇说一下django框架的自动化测试,...

Django ORM vs SQLAlchemy:到底谁更香?从入门到上头的选择指南

阅读文章前辛苦您点下“关注”,方便讨论和分享,为了回馈您的支持,我将每日更新优质内容。...

超详细的Django 框架介绍,它来了!

时光荏苒,一晃小编的Tornado框架系列也结束了。这个框架虽然没有之前的FastAPI高流量,但是,它也是小编的心血呀。总共16篇博文,从入门到进阶,包含了框架的方方面面。虽然小编有些方面介绍得不是...

20《Nginx 入门教程》使用 Nginx 部署 Python 项目

今天的目标是完成一个PythonWeb项目的线上部署,我们使用最新的Django项目搭建一个简易的Web工程,然后基于Nginx服务部署该PythonWeb项目。1.前期准备...

取消回复欢迎 发表评论: