快捷導(dǎo)航

SpringBoot中WebClient的實(shí)踐過(guò)程

更新時(shí)間：2025年12月08日 09:35:23 作者：小馬不敲代碼

本文介紹了SpringBoot中WebClient的使用,包括配置、使用場(chǎng)景以及優(yōu)化策略,幫助開發(fā)者更高效地進(jìn)行服務(wù)間通信,WebClient具有非阻塞式I/O、強(qiáng)大的功能、靈活性等優(yōu)點(diǎn),適用于高并發(fā)場(chǎng)景,通過(guò)合理配置和優(yōu)化,可以顯著提升服務(wù)間通信的效率和可靠性

一、什么是 WebClient？

WebClient 是 Spring WebFlux 提供的非阻塞式 HTTP 客戶端，它支持同步和異步的調(diào)用方式，適合高并發(fā)場(chǎng)景下的服務(wù)通信。與傳統(tǒng)的 RestTemplate 相比，WebClient 的特點(diǎn)包括：

非阻塞式 I/O：更高的性能，適合處理大量請(qǐng)求。
強(qiáng)大的功能：支持流式處理、攔截器、請(qǐng)求超時(shí)等高級(jí)功能。
靈活性：支持多種編碼方式和請(qǐng)求類型。

二、引入依賴

在使用 WebClient 之前，需要確保你的 Spring Boot 項(xiàng)目已包含相關(guān)依賴。以下是常見的 Maven 依賴：

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

三、配置 WebClient

1、基本配置

WebClient 可以通過(guò)靜態(tài)方法 WebClient.create() 創(chuàng)建，也可以通過(guò) WebClient.Builder 定制。

以下是一個(gè)最基本的配置：

import org.springframework.web.reactive.function.client.WebClient;

@Configuration
public class WebClientConfig {

    @Bean
    public WebClient webClient() {
        return WebClient.create("https://api.example.com");
    }
}

2、高級(jí)配置

為了增強(qiáng) WebClient 的靈活性，可以使用 WebClient.Builder 來(lái)配置全局屬性，比如超時(shí)設(shè)置、全局?jǐn)r截器等：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.reactive.function.client.ExchangeStrategies;
import org.springframework.web.reactive.function.client.WebClient;

@Configuration
public class WebClientConfig {

    @Bean
    public WebClient webClient(WebClient.Builder builder) {
        return builder
                .baseUrl("https://api.example.com")
                .defaultHeader("Authorization", "Bearer your-token")
                .exchangeStrategies(
                    ExchangeStrategies.builder()
                        .codecs(configurer -> configurer
                            .defaultCodecs()
                            .maxInMemorySize(16 * 1024 * 1024)) // 設(shè)置最大內(nèi)存限制為16MB
                        .build())
                .build();
    }
}

四、WebClient 的使用場(chǎng)景

1、發(fā)起 GET 請(qǐng)求

以下示例展示了如何使用 WebClient 發(fā)起一個(gè)簡(jiǎn)單的 GET 請(qǐng)求：

import org.springframework.web.reactive.function.client.WebClient;

@Service
public class ApiService {

    private final WebClient webClient;

    public ApiService(WebClient webClient) {
        this.webClient = webClient;
    }

    public String fetchData() {
        return webClient.get()
                .uri("/data")
                .retrieve()
                .bodyToMono(String.class)
                .block(); // 同步方式獲取結(jié)果
    }
}

2、發(fā)起 POST 請(qǐng)求

對(duì)于 POST 請(qǐng)求，可以發(fā)送 JSON 數(shù)據(jù)：

import org.springframework.web.reactive.function.client.WebClient;
import reactor.core.publisher.Mono;

@Service
public class ApiService {

    private final WebClient webClient;

    public ApiService(WebClient webClient) {
        this.webClient = webClient;
    }

    public String postData(Object requestData) {
        return webClient.post()
                .uri("/submit")
                .body(Mono.just(requestData), Object.class)
                .retrieve()
                .bodyToMono(String.class)
                .block();
    }
}

五、優(yōu)化和最佳實(shí)踐

1、超時(shí)設(shè)置

為避免長(zhǎng)時(shí)間等待，建議為 WebClient 配置超時(shí)時(shí)間：

import java.time.Duration;

@Bean
public WebClient webClientWithTimeout(WebClient.Builder builder) {
    return builder
            .baseUrl("https://api.example.com")
            .defaultHeaders(headers -> headers.set("Authorization", "Bearer token"))
            .build()
            .mutate()
            .responseTimeout(Duration.ofSeconds(5)) // 設(shè)置響應(yīng)超時(shí)時(shí)間
            .build();
}

2、使用攔截器

攔截器可以用于日志記錄或添加全局參數(shù)：

@Bean
public WebClient.Builder webClientBuilder() {
    return WebClient.builder()
            .filter((request, next) -> {
                System.out.println("Request: " + request.url());
                return next.exchange(request);
            });
}

3、異步調(diào)用

WebClient 原生支持異步編程，適合處理高并發(fā)請(qǐng)求場(chǎng)景：

public Mono<String> fetchDataAsync() {
    return webClient.get()
            .uri("/data")
            .retrieve()
            .bodyToMono(String.class);
}

六、錯(cuò)誤處理

1、使用 onStatus 處理 HTTP 錯(cuò)誤

WebClient 提供了靈活的錯(cuò)誤處理機(jī)制：

import org.springframework.web.reactive.function.client.WebClientResponseException;

public String fetchWithErrorHandling() {
    return webClient.get()
            .uri("/data")
            .retrieve()
            .onStatus(status -> status.is4xxClientError(),
                response -> Mono.error(new RuntimeException("Client error!")))
            .onStatus(status -> status.is5xxServerError(),
                response -> Mono.error(new RuntimeException("Server error!")))
            .bodyToMono(String.class)
            .block();
}

2、捕獲異常

可以通過(guò) doOnError 捕獲并處理異常：

public Mono<String> fetchWithExceptionHandling() {
    return webClient.get()
            .uri("/data")
            .retrieve()
            .bodyToMono(String.class)
            .doOnError(e -> {
                if (e instanceof WebClientResponseException) {
                    WebClientResponseException ex = (WebClientResponseException) e;
                    System.err.println("Error response: " + ex.getResponseBodyAsString());
                }
            });
}