【WEB系列】WebClient之超时设置

2020-07-17

SpringBootWEB系列WebClient

WebClient

文章目录

I. 项目环境
1. 1. 依赖
2. 2. REST接口
II. 超时
1. 1. 实例演示
2. 2. 测试与小结
II. 其他
1. 0. 项目
2. 1. 一灰灰Blog

为所有的第三方接口调用设置超时时间是一个比较推荐的做法，避免自己的任务被所依赖的服务给拖死；在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. 测试与小结

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

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

小结

通过HttpClient来设置超时时间
借助WebClient.builder().clientConnector(new ReactorClientHttpConnector(httpClient))来绑定HttpClient

II. 其他

0. 项目

系列博文

源码

1. 一灰灰Blog

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

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

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

一灰灰blog

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