Spring5中WebClient怎么用

這篇文章將為大家詳細講解有關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());

關于“Spring5中WebClient怎么用”這篇文章就分享到這里了，希望以上內容可以對大家有一定的幫助，使各位可以學到更多知識，如果覺得文章不錯，請把它分享出去讓更多的人看到。