【WEB系列】WebClient之超时设置

为所有的第三方接口调用设置超时时间是一个比较推荐的做法,避免自己的任务被所依赖的服务给拖死;在WebClient发起的异步网络请求调用中,应该如何设置超时时间呢?

I. 项目环境

本项目借助 SpringBoot 2.2.1.RELEASE + maven 3.5.3 + IDEA 进行开发

1. 依赖

使用WebClient,最主要的引入依赖如下(省略掉了SpringBoot的相关依赖,如对于如何创建SpringBoot项目不太清楚的小伙伴,可以关注一下我之前的博文)

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-webflux</artifactId>
</dependency>

2. REST接口

基于WebFlux提供一个http接口,内部sleep 5s,来响应后续的超时case

@GetMapping(path = "timeout")
public Mono<String> timeout(String name, Integer age) throws InterruptedException {
    Thread.sleep(5_000);
    return Mono.just("timeout req: " + name + " age: " + age);
}

II. 超时

本篇实例主要来自于官方文档: webflux-client-builder-reactor-timeout

1. 实例演示

在WebClient的创建中,实际上并没有找到有设置超时的入口,基于之前RestTemplate的超时设置中的经验,我们可能需要将目标放在更底层实现网络请求的HttpClient上

// 设置连接超时时间为3s
HttpClient httpClient = HttpClient.create().tcpConfiguration(client -> client.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 3_000)
        .doOnConnected(
              conn -> conn.addHandlerLast(new ReadTimeoutHandler(3))
                      .addHandlerLast(new WriteTimeoutHandler(3))));

上面虽然获取了一个带超时设置的HttpCilent,但是我们需要用它来设置WebClient,这里就需要借助 WebClient.builder().clientConnector 来实现了

// 设置httpclient
WebClient webClient = WebClient.builder().baseUrl("http://127.0.0.1:8080")
        .clientConnector(new ReactorClientHttpConnector(httpClient)).build();

Mono<ResponseEntity<String>> ans =
        webClient.get().uri("/timeout").exchange().flatMap(s -> s.toEntity(String.class));
ans.subscribe(s -> System.out.println("timeout res code: " + s.getStatusCode()));

2. 测试与小结

本文所有源码可以在后面的项目地址中获取,测试输出结果如下

【WEB系列】WebClient之超时设置

虽然上面的输出提示了超时,但是奇怪的是居然不像RestTemplate的超时抛异常,上面这个流程可以正常走通,那么如何捕获这个超时异常呢,WebClient访问出现非200状态码返回的又可以如何处理呢,下篇博文将给与介绍

小结

HttpClient
WebClient.builder().clientConnector(new ReactorClientHttpConnector(httpClient))

II. 其他

0. 项目

系列博文

  • 【WEB系列】WebClient之Basic Auth授权
  • 【WEB系列】WebClient之请求头设置
  • 【WEB系列】WebClient之文件上传
  • 【WEB系列】WebClient之基础使用姿势
  • 【WEB系列】WebClient之文件上传

源码

  • 工程: https://github.com/liuyueyi/spring-boot-demo
  • 源码: https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-boot/222-web-client

1. 一灰灰Blog

尽信书则不如,以上内容,纯属一家之言,因个人能力有限,难免有疏漏和错误之处,如发现bug或者有更好的建议,欢迎批评指正,不吝感激

下面一灰灰的个人博客,记录所有学习和工作中的博文,欢迎大家前去逛逛

  • 一灰灰Blog个人博客 https://blog.hhui.top
  • 一灰灰Blog-Spring专题博客 http://spring.hhui.top

【WEB系列】WebClient之超时设置

打赏 如果觉得我的文章对您有帮助,请随意打赏。

原文 

http://spring.hhui.top/spring-blog/2020/07/17/200717-SpringBoot系列WebClient之超时设置/

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » 【WEB系列】WebClient之超时设置

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址