Spring5中的WebClient使用方法詳解
前言
Spring5帶來了新的響應(yīng)式web開發(fā)框架WebFlux，同時，也引入了新的HttpClient框架WebClient。WebClient是Spring5中引入的執(zhí)行 HTTP 請求的非阻塞、反應(yīng)式客戶端。它對同步和異步以及流方案都有很好的支持，WebClient發(fā)布后，RestTemplate將在將來版本中棄用，并且不會向前添加主要新功能。
WebClient與RestTemplate比較
WebClient是一個功能完善的Http請求客戶端，與RestTemplate相比，WebClient支持以下內(nèi)容：
- 非阻塞 I/O。
- 反應(yīng)流背壓（消費者消費負(fù)載過高時主動反饋生產(chǎn)者放慢生產(chǎn)速度的一種機(jī)制）。
- 具有高并發(fā)性，硬件資源消耗更少。
- 流暢的API設(shè)計。
- 同步和異步交互。
- 流式傳輸支持
HTTP底層庫選擇
Spring5的WebClient客戶端和WebFlux服務(wù)器都依賴于相同的非阻塞編解碼器來編碼和解碼請求和響應(yīng)內(nèi)容。默認(rèn)底層使用Netty，內(nèi)置支持Jetty反應(yīng)性HttpClient實現(xiàn)。同時，也可以通過編碼的方式實現(xiàn)ClientHttpConnector接口自定義新的底層庫；如切換Jetty實現(xiàn)：
WebClient.builder()
.clientConnector(new JettyClientHttpConnector())
.build();
WebClient配置
基礎(chǔ)配置
WebClient實例構(gòu)造器可以設(shè)置一些基礎(chǔ)的全局的web請求配置信息，比如默認(rèn)的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 ->
//讀寫超時設(shè)置
connection.addHandlerLast(new ReadTimeoutHandler(10, TimeUnit.SECONDS))
.addHandlerLast(new WriteTimeoutHandler(10))
);
//連接超時設(shè)置
tcpClient.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 10000)
.option(ChannelOption.TCP_NODELAY,true);
return tcpClient;
});
WebClient.builder()
.clientConnector(new ReactorClientHttpConnector(httpClient))
.build();
編解碼配置
針對特定的數(shù)據(jù)交互格式，可以設(shè)置自定義編解碼的模式，如下：
ExchangeStrategies strategies = ExchangeStrategies.builder()
.codecs(configurer -> {
configurer.customCodecs().decoder(new Jackson2JsonDecoder());
configurer.customCodecs().encoder(new Jackson2JsonEncoder());
})
.build();
WebClient.builder()
.exchangeStrategies(strategies)
.build();
get請求示例
uri構(gòu)造時支持屬性占位符，真實參數(shù)在入?yún)r排序好就可以。同時可以通過accept設(shè)置媒體類型，以及編碼。最終的結(jié)果值是通過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請求示例演示了一個比較復(fù)雜的場景，同時包含表單參數(shù)和文件流數(shù)據(jù)。如果是普通post請求，直接通過bodyValue設(shè)置對象實例即可。不用FormInserter構(gòu)造。
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);
同步返回結(jié)果
上面演示的都是異步的通過mono的subscribe訂閱響應(yīng)值。當(dāng)然，如果你想同步阻塞獲取結(jié)果，也可以通過.block()阻塞當(dāng)前線程獲取返回值。
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);
但是，如果需要進(jìn)行多個調(diào)用，則更高效地方式是避免單獨阻塞每個響應(yīng)，而是等待組合結(jié)果，如：
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過濾器
可以通過設(shè)置filter攔截器，統(tǒng)一修改攔截請求，比如認(rèn)證的場景，如下示例，filter注冊單個攔截器，filters可以注冊多個攔截器，basicAuthentication是系統(tǒng)內(nèi)置的用于basicAuth的攔截器，limitResponseSize是系統(tǒng)內(nèi)置用于限制響值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());
結(jié)語
我們已經(jīng)在業(yè)務(wù)api網(wǎng)關(guān)、短信平臺等多個項目中使用WebClient，從網(wǎng)關(guān)的流量和穩(wěn)定足以可見WebClient的性能和穩(wěn)定性。響應(yīng)式編程模型是未來的web編程趨勢，RestTemplate會逐步被取締淘汰，并且官方已經(jīng)不在更新和維護(hù)。WebClient很好的支持了響應(yīng)式模型，而且api設(shè)計友好，是博主力薦新的HttpClient庫。趕緊試試吧。
好了，以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，謝謝大家對腳本之家的支持。
相關(guān)文章
這篇文章主要介紹了Java阻塞隊列BlockingQueue，文章通過隊列的類型展開詳細(xì)的內(nèi)容介紹，具有一定的參考價值，需要的朋友可以參考一下2022-07-07
這篇文章主要介紹了Spring Boot整合MyBatis-Flex全過程,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-08-08
這篇文章主要為大家介紹了vue組件通信的幾種方法，具有一定的參考價值，感興趣的小伙伴們可以參考一下，希望能夠給你帶來幫助2022-01-01
這篇文章主要介紹了云計算實驗：Java?MapReduce編程,?居于Java圍繞MapReduce編程展開詳細(xì)內(nèi)容，文章助大家掌握MapReduce編程，理解MapReduce原理,需要的朋友可以參考一下2021-12-12
LRU（Least recently used，最近最少使用）算法根據(jù)數(shù)據(jù)的歷史訪問記錄來進(jìn)行淘汰數(shù)據(jù)，其核心思想是“如果數(shù)據(jù)最近被訪問過，那么將來被訪問的幾率也更高”。下面看下java實現(xiàn)LRU緩存淘汰算法的方法，一起看看吧2021-11-11
springboot?vue測試平臺接口定義及發(fā)送請求功能實現(xiàn)
這篇文章主要為大家介紹了springboot+vue測試平臺接口定義及發(fā)送請求功能實現(xiàn)，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-05-05
dubbo集成zipkin獲取Traceid的實現(xiàn)
這篇文章主要介紹了dubbo集成zipkin獲取Traceid的實現(xiàn)方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-07-07
本文主要介紹了JAVA簡單工廠模式（從現(xiàn)實生活角度理解代碼原理）的相關(guān)知識。具有很好的參考價值。下面跟著小編一起來看下吧2021-11-11
這篇文章主要為大家詳細(xì)介紹了java實現(xiàn)馬踏棋盤的算法，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-02-02
Kotlin + Retrofit + RxJava簡單封裝使用詳解
這篇文章主要介紹了Kotlin + Retrofit + RxJava簡單封裝使用詳解，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-07-07