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)流背壓（消費者消費負載過高時主動反饋生產(chǎn)者放慢生產(chǎn)速度的一種機制）。
- 具有高并發(fā)性，硬件資源消耗更少。
- 流暢的API設(shè)計。
- 同步和異步交互。
- 流式傳輸支持
HTTP底層庫選擇
Spring5的WebClient客戶端和WebFlux服務(wù)器都依賴于相同的非阻塞編解碼器來編碼和解碼請求和響應(yīng)內(nèi)容。默認底層使用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請求配置信息，比如默認的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)值。當然，如果你想同步阻塞獲取結(jié)果，也可以通過.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);
但是，如果需要進行多個調(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)一修改攔截請求，比如認證的場景，如下示例，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)不在更新和維護。WebClient很好的支持了響應(yīng)式模型，而且api設(shè)計友好，是博主力薦新的HttpClient庫。趕緊試試吧。
好了，以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，謝謝大家對腳本之家的支持。
相關(guān)文章
Spring Framework提供了一個簡易的開發(fā)方式，這種開發(fā)方式，將避免那些可能致使底層代碼變得繁雜混亂的大量的屬性文件和幫助類。這篇文章主要介紹了Spring Framework 5.0 入門教程,感興趣的小伙伴們可以參考一下2018-05-05
淺談spring中isolation和propagation的用法
這篇文章主要介紹了淺談spring中isolation 和propagation的用法，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-07-07
關(guān)于Java中finalize析構(gòu)方法的作用詳解
構(gòu)造方法用于創(chuàng)建和初始化類對象，也就是說，構(gòu)造方法負責(zé)”生出“一個類對象，并可以在對象出生時進行必要的操作，在這篇文章中會給大家簡單介紹一下析構(gòu)方法,需要的朋友可以參考下2023-05-05
已解決：No ''Access-Control-Allow-Origin''跨域問題
這篇文章主要介紹了已解決：No 'Access-Control-Allow-Origin' 跨域，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-06-06
jdbc+jsp實現(xiàn)簡單員工管理系統(tǒng)
這篇文章主要為大家詳細介紹了jdbc+jsp實現(xiàn)簡單員工管理系統(tǒng)，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-02-02
這篇文章主要介紹了java 多線程死鎖詳解及簡單實例的相關(guān)資料,需要的朋友可以參考下2017-04-04
大家好，本篇文章主要講的是Java中淺拷貝和深拷貝詳解，感興趣的同學(xué)趕快來看一看吧，對你有幫助的話記得收藏一下，方便下次瀏覽2021-12-12
springboot?maven?打包插件介紹及注意事項說明
這篇文章主要介紹了springboot?maven?打包插件介紹及注意事項說明，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-12-12
Java實現(xiàn)飛機大戰(zhàn)-連接數(shù)據(jù)庫并把得分寫入數(shù)據(jù)庫
這篇文章給大家分享了Java實現(xiàn)飛機大戰(zhàn)中連接數(shù)據(jù)庫并把得分寫入數(shù)據(jù)庫的相關(guān)知識點和代碼，有興趣的可以學(xué)習(xí)參考下。2018-07-07
Apache的Groovy是Java平臺上設(shè)計的面向?qū)ο缶幊陶Z言，這門動態(tài)語言擁有類似Python、Ruby和Smalltalk中的一些特性，可以作為Java平臺的腳本語言使用，這篇文章主要介紹了Java?熱更新?Groovy?實踐及踩坑指南,需要的朋友可以參考下2022-09-09