SpringBoot中WebClient的实践过程_Java

在现代微服务架构中，服务之间的通信至关重要。spring boot 提供了 webclient，作为 resttemplate 的替代方案，用于执行非阻塞式的 http 请求。

本文将详细讲解 webclient 的实践，包括配置、使用场景以及常见的优化策略，帮助你在项目中更高效地使用 webclient。

一、什么是 webclient？

webclient 是 spring webflux 提供的非阻塞式 http 客户端，它支持同步和异步的调用方式，适合高并发场景下的服务通信。与传统的 resttemplate 相比，webclient 的特点包括：

非阻塞式 i/o：更高的性能，适合处理大量请求。
强大的功能：支持流式处理、拦截器、请求超时等高级功能。
灵活性：支持多种编码方式和请求类型。

二、引入依赖

在使用 webclient 之前，需要确保你的 spring boot 项目已包含相关依赖。以下是常见的 maven 依赖：

<dependency>
    <groupid>org.springframework.boot</groupid>
    <artifactid>spring-boot-starter-webflux</artifactid>
</dependency>

三、配置 webclient

1、基本配置

webclient 可以通过静态方法 webclient.create() 创建，也可以通过 webclient.builder 定制。

以下是一个最基本的配置：

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

@configuration
public class webclientconfig {

    @bean
    public webclient webclient() {
        return webclient.create("https://api.example.com");
    }
}

2、高级配置

为了增强 webclient 的灵活性，可以使用 webclient.builder 来配置全局属性，比如超时设置、全局拦截器等：

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)) // 设置最大内存限制为16mb
                        .build())
                .build();
    }
}

四、webclient 的使用场景

1、发起 get 请求

以下示例展示了如何使用 webclient 发起一个简单的 get 请求：

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(); // 同步方式获取结果
    }
}

2、发起 post 请求

对于 post 请求，可以发送 json 数据：

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();
    }
}

五、优化和最佳实践

1、超时设置

为避免长时间等待，建议为 webclient 配置超时时间：

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)) // 设置响应超时时间
            .build();
}

2、使用拦截器

拦截器可以用于日志记录或添加全局参数：

@bean
public webclient.builder webclientbuilder() {
    return webclient.builder()
            .filter((request, next) -> {
                system.out.println("request: " + request.url());
                return next.exchange(request);
            });
}

3、异步调用

webclient 原生支持异步编程，适合处理高并发请求场景：

public mono<string> fetchdataasync() {
    return webclient.get()
            .uri("/data")
            .retrieve()
            .bodytomono(string.class);
}

六、错误处理

1、使用 onstatus 处理 http 错误

webclient 提供了灵活的错误处理机制：

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、捕获异常

可以通过 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());
                }
            });
}