Spring5中的WebClient使用方法详解
前言
Spring5带来了新的响应式web开发框架WebFlux，同时，也引入了新的HttpClient框架WebClient。WebClient是Spring5中引入的执行 HTTP 请求的非阻塞、反应式客户端。它对同步和异步以及流方案都有很好的支持，WebClient发布后，RestTemplate将在将来版本中弃用，并且不会向前添加主要新功能。
WebClient与RestTemplate比较
WebClient是一个功能完善的Http请求客户端，与RestTemplate相比，WebClient支持以下内容：
- 非阻塞 I/O。
- 反应流背压（消费者消费负载过高时主动反馈生产者放慢生产速度的一种机制）。
- 具有高并发性，硬件资源消耗更少。
- 流畅的API设计。
- 同步和异步交互。
- 流式传输支持
HTTP底层库选择
Spring5的WebClient客户端和WebFlux服务器都依赖于相同的非阻塞编解码器来编码和解码请求和响应内容。默认底层使用Netty，内置支持Jetty反应性HttpClient实现。同时，也可以通过编码的方式实现ClientHttpConnector接口自定义新的底层库；如切换Jetty实现：
WebClient.builder()
.clientConnector(new JettyClientHttpConnector())
.build();
WebClient配置
基础配置
WebClient实例构造器可以设置一些基础的全局的web请求配置信息，比如默认的cookie、header、baseUrl等
WebClient.builder()
.defaultCookie("kl","kl")
.defaultUriVariables(ImmutableMap.of("name","kl"))
.defaultHeader("header","kl")
.defaultHeaders(httpHeaders -> {
httpHeaders.add("header1","kl");
httpHeaders.add("header2","kl");
})
.defaultCookies(cookie ->{
cookie.add("cookie1","kl");
cookie.add("cookie2","kl");
})
.baseUrl("http://www.kailing.pub")
.build();
Netty库配置
通过定制Netty底层库，可以配置SSl安全连接，以及请求超时，读写超时等
HttpClient httpClient = HttpClient.create()
.secure(sslContextSpec -> {
SslContextBuilder sslContextBuilder = SslContextBuilder.forClient()
.trustManager(new File("E://server.truststore"));
sslContextSpec.sslContext(sslContextBuilder);
}).tcpConfiguration(tcpClient -> {
tcpClient.doOnConnected(connection ->
//读写超时设置
connection.addHandlerLast(new ReadTimeoutHandler(10, TimeUnit.SECONDS))
.addHandlerLast(new WriteTimeoutHandler(10))
);
//连接超时设置
tcpClient.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 10000)
.option(ChannelOption.TCP_NODELAY,true);
return tcpClient;
});
WebClient.builder()
.clientConnector(new ReactorClientHttpConnector(httpClient))
.build();
编解码配置
针对特定的数据交互格式，可以设置自定义编解码的模式，如下：
ExchangeStrategies strategies = ExchangeStrategies.builder()
.codecs(configurer -> {
configurer.customCodecs().decoder(new Jackson2JsonDecoder());
configurer.customCodecs().encoder(new Jackson2JsonEncoder());
})
.build();
WebClient.builder()
.exchangeStrategies(strategies)
.build();
get请求示例
uri构造时支持属性占位符，真实参数在入参时排序好就可以。同时可以通过accept设置媒体类型，以及编码。最终的结果值是通过Mono和Flux来接收的，在subscribe方法中订阅返回值。
WebClient client = WebClient.create("http://www.kailing.pub");
Mono<String> result = client.get()
.uri("/article/index/arcid/{id}.html", 256)
.attributes(attr -> {
attr.put("name", "kl");
attr.put("age", "28");
})
.acceptCharset(StandardCharsets.UTF_8)
.accept(MediaType.TEXT_HTML)
.retrieve()
.bodyToMono(String.class);
result.subscribe(System.err::println);
post请求示例
post请求示例演示了一个比较复杂的场景，同时包含表单参数和文件流数据。如果是普通post请求，直接通过bodyValue设置对象实例即可。不用FormInserter构造。
WebClient client = WebClient.create("http://www.kailing.pub");
FormInserter formInserter = fromMultipartData("name","kl")
.with("age",19)
.with("map",ImmutableMap.of("xx","xx"))
.with("file",new File("E://xxx.doc"));
Mono<String> result = client.post()
.uri("/article/index/arcid/{id}.html", 256)
.contentType(MediaType.APPLICATION_JSON)
.body(formInserter)
//.bodyValue(ImmutableMap.of("name","kl"))
.retrieve()
.bodyToMono(String.class);
result.subscribe(System.err::println);
同步返回结果
上面演示的都是异步的通过mono的subscribe订阅响应值。当然，如果你想同步阻塞获取结果，也可以通过.block()阻塞当前线程获取返回值。
WebClient client = WebClient.create("http://www.kailing.pub");
String result = client .get()
.uri("/article/index/arcid/{id}.html", 256)
.retrieve()
.bodyToMono(String.class)
.block();
System.err.println(result);
但是，如果需要进行多个调用，则更高效地方式是避免单独阻塞每个响应，而是等待组合结果，如：
WebClient client = WebClient.create("http://www.kailing.pub");
Mono<String> result1Mono = client .get()
.uri("/article/index/arcid/{id}.html", 255)
.retrieve()
.bodyToMono(String.class);
Mono<String> result2Mono = client .get()
.uri("/article/index/arcid/{id}.html", 254)
.retrieve()
.bodyToMono(String.class);
Map<String,String> map = Mono.zip(result1Mono, result2Mono, (result1, result2) -> {
Map<String, String> arrayList = new HashMap<>();
arrayList.put("result1", result1);
arrayList.put("result2", result2);
return arrayList;
}).block();
System.err.println(map.toString());
Filter过滤器
可以通过设置filter拦截器，统一修改拦截请求，比如认证的场景，如下示例，filter注册单个拦截器，filters可以注册多个拦截器，basicAuthentication是系统内置的用于basicAuth的拦截器，limitResponseSize是系统内置用于限制响值byte大小的拦截器
WebClient.builder()
.baseUrl("http://www.kailing.pub")
.filter((request, next) -> {
ClientRequest filtered = ClientRequest.from(request)
.header("foo", "bar")
.build();
return next.exchange(filtered);
})
.filters(filters ->{
filters.add(ExchangeFilterFunctions.basicAuthentication("username","password"));
filters.add(ExchangeFilterFunctions.limitResponseSize(800));
})
.build().get()
.uri("/article/index/arcid/{id}.html", 254)
.retrieve()
.bodyToMono(String.class)
.subscribe(System.err::println);
websocket支持
WebClient不支持websocket请求，请求websocket接口时需要使用WebSocketClient，如：
WebSocketClient client = new ReactorNettyWebSocketClient();
URI url = new URI("ws://localhost:8080/path");
client.execute(url, session ->
session.receive()
.doOnNext(System.out::println)
.then());
结语
我们已经在业务api网关、短信平台等多个项目中使用WebClient，从网关的流量和稳定足以可见WebClient的性能和稳定性。响应式编程模型是未来的web编程趋势，RestTemplate会逐步被取缔淘汰，并且官方已经不在更新和维护。WebClient很好的支持了响应式模型，而且api设计友好，是博主力荐新的HttpClient库。赶紧试试吧。
好了，以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，谢谢大家对脚本之家的支持。
相关文章
这篇文章主要介绍了Java阻塞队列BlockingQueue，文章通过队列的类型展开详细的内容介绍，具有一定的参考价值，需要的朋友可以参考一下2022-07-07
这篇文章主要介绍了Spring Boot整合MyBatis-Flex全过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2024-08-08
这篇文章主要为大家介绍了vue组件通信的几种方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助2022-01-01
这篇文章主要介绍了云计算实验：Java MapReduce编程, 居于Java围绕MapReduce编程展开详细内容，文章助大家掌握MapReduce编程，理解MapReduce原理,需要的朋友可以参考一下2021-12-12
LRU（Least recently used，最近最少使用）算法根据数据的历史访问记录来进行淘汰数据，其核心思想是“如果数据最近被访问过，那么将来被访问的几率也更高”。下面看下java实现LRU缓存淘汰算法的方法，一起看看吧2021-11-11
springboot vue测试平台接口定义及发送请求功能实现
这篇文章主要为大家介绍了springboot+vue测试平台接口定义及发送请求功能实现，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-05-05
这篇文章主要介绍了dubbo集成zipkin获取Traceid的实现方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-07-07
本文主要介绍了JAVA简单工厂模式（从现实生活角度理解代码原理）的相关知识。具有很好的参考价值。下面跟着小编一起来看下吧2021-11-11
这篇文章主要为大家详细介绍了java实现马踏棋盘的算法，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-02-02
Kotlin + Retrofit + RxJava简单封装使用详解
这篇文章主要介绍了Kotlin + Retrofit + RxJava简单封装使用详解，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2018-07-07
最新评论