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庫。趕緊試試吧。
好了，以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，謝謝大家對我們的支援。