一、簡(jiǎn)介

WebClient是一個(gè)非阻塞的、可擴(kuò)展的、基于Reactive Streams規(guī)范的HTTP客戶端。它提供了一種簡(jiǎn)潔的方式來進(jìn)行HTTP請(qǐng)求，并且可以很好地與其他Spring組件集成。WebClient支持同步和異步操作，使得它非常適合用于構(gòu)建響應(yīng)式應(yīng)用程序。

WebClient允許開發(fā)者通過構(gòu)建鏈?zhǔn)降腍TTP請(qǐng)求和響應(yīng)處理函數(shù)來構(gòu)建異步和非阻塞式的HTTP客戶端。它支持多種HTTP方法、請(qǐng)求和響應(yīng)處理、錯(cuò)誤處理、HTTP認(rèn)證和與RESTful服務(wù)交互。

二、特性

非阻塞：WebClient使用非阻塞I/O模型，這意味著它可以在等待服務(wù)器響應(yīng)時(shí)執(zhí)行其他任務(wù)，從而提高應(yīng)用程序的性能。

可擴(kuò)展性：WebClient可以輕松地與其他Spring組件集成，如Spring MVC、Spring Data REST等。此外，它還支持自定義攔截器和轉(zhuǎn)換器，以滿足特定的需求。

支持反應(yīng)式編程：WebClient完全符合Reactive Streams規(guī)范，因此可以很好地與響應(yīng)式編程框架（如RxJava、Reactor等）一起使用。

簡(jiǎn)化HTTP請(qǐng)求：WebClient提供了簡(jiǎn)潔的API，使得發(fā)送HTTP請(qǐng)求變得更加容易。例如，你可以使用webClient.get()方法來發(fā)送一個(gè)GET請(qǐng)求，或者使用webClient.postForEntity()方法來發(fā)送一個(gè)POST請(qǐng)求并接收一個(gè)實(shí)體對(duì)象。

三、WebClient與RestTemplate區(qū)別

RestTemplate是Spring提供的一個(gè)基于模板化的HTTP客戶端，它已經(jīng)過時(shí)，不再建議使用。以下是WebClient與RestTemplate的一些主要區(qū)別：

1. 非阻塞：RestTemplate是非阻塞的，而WebClient默認(rèn)情況下是阻塞的。但是，你可以通過設(shè)置client.configurator().setConnectTimeout(Duration.ofSeconds(10))來讓W(xué)ebClient在連接超時(shí)時(shí)拋出異常。

2. 可擴(kuò)展性：WebClient更容易與其他Spring組件集成，因?yàn)樗且粋€(gè)更高級(jí)別的抽象。而RestTemplate需要手動(dòng)創(chuàng)建HttpComponentsClientHttpRequestFactory實(shí)例，這可能會(huì)比較復(fù)雜。

3. 支持反應(yīng)式編程：WebClient完全符合Reactive Streams規(guī)范，因此可以很好地與響應(yīng)式編程框架一起使用。而RestTemplate不支持反應(yīng)式編程。

4. 錯(cuò)誤處理：RestTemplate的錯(cuò)誤處理是通過回調(diào)函數(shù)進(jìn)行的，這使得錯(cuò)誤處理變得復(fù)雜。而WebClient的錯(cuò)誤處理更加直觀，因?yàn)樗С种苯邮褂胻ry-catch語句捕獲異常。

5. 配置選項(xiàng)：RestTemplate的配置選項(xiàng)較少，而WebClient提供了更多的配置選項(xiàng)，如連接超時(shí)、重試策略等。

四、Spring Boot集成WebClient

在Spring Boot中集成WebClient非常簡(jiǎn)單，只需添加以下依賴即可：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-webflux</artifactId>
</dependency>

接下來，我們創(chuàng)建一個(gè)WebClient實(shí)例，并演示如何發(fā)送同步和異步請(qǐng)求：

import org.springframework.web.reactive.function.client.WebClient;
import reactor.core.publisher.Mono;
import reactor.core.scheduler.Schedulers;public class WebClientExample {public static void main(String[] args) {// 創(chuàng)建一個(gè)WebClient實(shí)例WebClient webClient = WebClient.create("https://api.example.com");// 發(fā)送一個(gè)GET請(qǐng)求并接收一個(gè)Mono<String>對(duì)象（同步請(qǐng)求）Mono<String> response = webClient.get().uri("/resource").retrieve().bodyToMono(String.class);response.subscribe(System.out::println, Throwable::printStackTrace); // 打印響應(yīng)結(jié)果或錯(cuò)誤信息// 發(fā)送一個(gè)POST請(qǐng)求并接收一個(gè)Mono<String>對(duì)象（異步請(qǐng)求）Mono<String> asyncResponse = webClient.post().uri("/resource").bodyValue("Hello, World!") // 設(shè)置請(qǐng)求體內(nèi)容.retrieve() // 返回響應(yīng)體而不是完整的響應(yīng)對(duì)象.bodyToMono(String.class); // 將響應(yīng)體轉(zhuǎn)換為Mono<String>對(duì)象asyncResponse.subscribeOn(Schedulers.boundedElastic()) // 指定異步執(zhí)行的任務(wù)線程池.subscribe(System.out::println, Throwable::printStackTrace); // 打印響應(yīng)結(jié)果或錯(cuò)誤信息}
}

在這個(gè)示例中，我們首先創(chuàng)建了一個(gè)WebClient實(shí)例，然后使用get()方法發(fā)送一個(gè)GET請(qǐng)求并接收一個(gè)Mono<String>對(duì)象。我們使用uri()方法指定請(qǐng)求的URI，然后調(diào)用retrieve()方法來獲取響應(yīng)體。最后，我們使用bodyToMono()方法將響應(yīng)體轉(zhuǎn)換為一個(gè)Mono<String>對(duì)象，并訂閱它以打印結(jié)果。

五、網(wǎng)絡(luò)客戶端

Spring WebClient是一個(gè)基于Reactive Streams規(guī)范的非阻塞式HTTP客戶端，它提供了創(chuàng)建網(wǎng)絡(luò)客戶端的功能。下面是使用Spring WebClient創(chuàng)建網(wǎng)絡(luò)客戶端的示例代碼：

import org.springframework.web.reactive.function.client.WebClient;public class WebClientExample {public static void main(String[] args) {// 創(chuàng)建一個(gè)WebClient實(shí)例WebClient webClient = WebClient.create("https://api.example.com");// 發(fā)送一個(gè)GET請(qǐng)求并接收一個(gè)Mono<String>對(duì)象Mono<String> response = webClient.get().uri("/resource").retrieve().bodyToMono(String.class);// 訂閱響應(yīng)并打印結(jié)果response.subscribe(System.out::println);}
}

在這個(gè)示例中，我們首先創(chuàng)建了一個(gè)WebClient實(shí)例，然后使用get()方法發(fā)送一個(gè)GET請(qǐng)求并接收一個(gè)Mono<String>對(duì)象。我們使用uri()方法指定請(qǐng)求的URI，然后調(diào)用retrieve()方法來獲取響應(yīng)體。最后，我們使用bodyToMono()方法將響應(yīng)體轉(zhuǎn)換為一個(gè)Mono<String>對(duì)象，并訂閱它以打印結(jié)果。

除了發(fā)送GET請(qǐng)求外，我們還可以使用其他方法來發(fā)送不同類型的請(qǐng)求，例如POST、PUT和DELETE等。例如，我們可以使用post()方法發(fā)送一個(gè)POST請(qǐng)求：

import org.springframework.web.reactive.function.client.WebClient;public class WebClientExample {public static void main(String[] args) {// 創(chuàng)建一個(gè)WebClient實(shí)例WebClient webClient = WebClient.create("https://api.example.com");// 發(fā)送一個(gè)POST請(qǐng)求并接收一個(gè)Mono<String>對(duì)象Mono<String> response = webClient.post().uri("/resource").bodyValue("Hello, World!") // 設(shè)置請(qǐng)求體內(nèi)容.retrieve() // 返回響應(yīng)體而不是完整的響應(yīng)對(duì)象.bodyToMono(String.class); // 將響應(yīng)體轉(zhuǎn)換為Mono<String>對(duì)象// 訂閱響應(yīng)并打印結(jié)果response.subscribe(System.out::println);}
}

在這個(gè)示例中，我們使用post()方法發(fā)送一個(gè)POST請(qǐng)求，并使用bodyValue()方法設(shè)置請(qǐng)求體內(nèi)容。我們同樣使用retrieve()方法來獲取響應(yīng)體，并使用bodyToMono()方法將響應(yīng)體轉(zhuǎn)換為一個(gè)Mono<String>對(duì)象。最后，我們訂閱這個(gè)Mono對(duì)象以打印響應(yīng)結(jié)果。

六、錯(cuò)誤處理機(jī)制

Spring WebClient提供了多種錯(cuò)誤處理機(jī)制，包括異常處理、重試策略和自定義錯(cuò)誤處理。下面將分別介紹這些錯(cuò)誤處理方式，并給出相應(yīng)的代碼示例。

6.1 異常處理

WebClient支持使用onErrorResume方法來處理請(qǐng)求過程中發(fā)生的異常。例如：

import org.springframework.web.reactive.function.client.WebClient;
import reactor.core.publisher.Mono;public class WebClientExample {public static void main(String[] args) {// 創(chuàng)建一個(gè)WebClient實(shí)例WebClient webClient = WebClient.create("https://api.example.com");// 發(fā)送一個(gè)GET請(qǐng)求并處理異常Mono<String> response = webClient.get().uri("/resource").retrieve().onErrorResume(e -> {// 打印異常信息System.err.println("Request failed: " + e.getMessage());// 返回一個(gè)空的Mono對(duì)象，表示請(qǐng)求失敗return Mono.empty();});response.subscribe(System.out::println, Throwable::printStackTrace); // 打印響應(yīng)結(jié)果或錯(cuò)誤信息}
}

在這個(gè)示例中，我們使用onErrorResume方法來處理請(qǐng)求過程中發(fā)生的異常。當(dāng)發(fā)生異常時(shí)，我們打印異常信息，并返回一個(gè)空的Mono對(duì)象，表示請(qǐng)求失敗。

6.2 重試策略

WebClient支持多種重試策略，如固定延遲重試、指數(shù)退避重試等。以下是使用固定延遲重試的示例：

import org.springframework.http.client.reactive.ReactorClientHttpConnector;
import org.springframework.web.reactive.function.client.WebClient;
import reactor.core.publisher.Mono;public class WebClientRetryExample {public static void main(String[] args) {// 創(chuàng)建一個(gè)WebClient實(shí)例WebClient webClient = WebClient.builder().baseUrl("https://api.example.com").clientConnector(new ReactorClientHttpConnector()).build();// 發(fā)送一個(gè)GET請(qǐng)求并設(shè)置重試策略Mono<String> response = webClient.get().uri("/resource").retrieve().bodyToMono(String.class).retryWhen(e -> e instanceof java.net.SocketTimeoutException || e instanceof java.net.UnknownHostException) // 當(dāng)發(fā)生SocketTimeoutException或UnknownHostException時(shí)進(jìn)行重試.delayElements(Duration.ofSeconds(1)); // 設(shè)置重試間隔為1秒response.subscribe(System.out::println, Throwable::printStackTrace); // 打印響應(yīng)結(jié)果或錯(cuò)誤信息}
}

在這個(gè)示例中，我們使用retryWhen方法來設(shè)置重試策略。當(dāng)發(fā)生SocketTimeoutException或UnknownHostException時(shí)，我們進(jìn)行重試。同時(shí)，我們使用delayElements方法來設(shè)置重試間隔。

6.3 自定義錯(cuò)誤處理

除了使用異常處理和重試策略外，你還可以通過實(shí)現(xiàn)ClientResponse接口來自定義錯(cuò)誤處理邏輯。例如：

import org.springframework.http.client.ClientHttpResponse;
import org.springframework.web.reactive.function.client.WebClient;
import reactor.core.publisher.Mono;public class CustomErrorHandlingExample {public static void main(String[] args) {// 創(chuàng)建一個(gè)WebClient實(shí)例WebClient webClient = WebClient.create("https://api.example.com");// 發(fā)送一個(gè)GET請(qǐng)求并自定義錯(cuò)誤處理邏輯Mono<String> response = webClient.get().uri("/resource").retrieve().onStatus(status -> status.is4xxClientError(), clientResponse -> {// 當(dāng)發(fā)生4xx客戶端錯(cuò)誤時(shí)，返回一個(gè)空的Mono對(duì)象，表示請(qǐng)求失敗return Mono.empty();}).onStatus(status -> status.is5xxServerError(), clientResponse -> {// 當(dāng)發(fā)生5xx服務(wù)器錯(cuò)誤時(shí)，返回一個(gè)空的Mono對(duì)象，表示請(qǐng)求失敗return Mono.empty();});response.subscribe(System.out::println, Throwable::printStackTrace); // 打印響應(yīng)結(jié)果或錯(cuò)誤信息}
}

在這個(gè)示例中，我們使用onStatus方法來自定義錯(cuò)誤處理邏輯。當(dāng)發(fā)生4xx客戶端錯(cuò)誤或5xx服務(wù)器錯(cuò)誤時(shí)，我們返回一個(gè)空的Mono對(duì)象，表示請(qǐng)求失敗。

七、結(jié)語

在 Spring Framework 5.0 及更高版本中，RestTemplate 已被棄用，取而代之的是較新的 WebClient。由于 RestTemplace 已棄用，開發(fā)人員應(yīng)開始使用 WebClient 進(jìn)行 REST 調(diào)用，非阻塞 I/O 調(diào)用會(huì)提高應(yīng)用程序性能。