对于最新的稳定版本,请使用 Spring Framework 6.2.0spring-doc.cadn.net.cn

配置

创建WebClient是通过 static 工厂方法之一:spring-doc.cadn.net.cn

您还可以使用WebClient.builder()有更多选项:spring-doc.cadn.net.cn

WebClient client = WebClient.builder()
		.codecs(configurer -> ... )
		.build();

构建完成后,一个WebClient是不可变的。但是,您可以克隆它并构建一个 修改副本如下:spring-doc.cadn.net.cn

WebClient client1 = WebClient.builder()
		.filter(filterA).filter(filterB).build();

WebClient client2 = client1.mutate()
		.filter(filterC).filter(filterD).build();

// client1 has filterA, filterB

// client2 has filterA, filterB, filterC, filterD

最大内存大小

编解码器 memory 以避免应用程序内存问题。默认情况下,这些设置为 256KB。 如果这还不够,您将收到以下错误:spring-doc.cadn.net.cn

org.springframework.core.io.buffer.DataBufferLimitException: Exceeded limit on max bytes to buffer

要更改默认编解码器的限制,请使用以下内容:spring-doc.cadn.net.cn

WebClient webClient = WebClient.builder()
		.codecs(configurer -> configurer.defaultCodecs().maxInMemorySize(2 * 1024 * 1024))
		.build();

Reactor Netty

要自定义 Reactor Netty 设置,请提供预配置的HttpClient:spring-doc.cadn.net.cn

HttpClient httpClient = HttpClient.create().secure(sslSpec -> ...);

WebClient webClient = WebClient.builder()
		.clientConnector(new ReactorClientHttpConnector(httpClient))
		.build();

资源

默认情况下,HttpClient参与全球 Reactor Netty 资源持有reactor.netty.http.HttpResources,包括事件循环线程和连接池。 这是推荐的模式,因为固定的共享资源是事件循环的首选 并发。在此模式下,全局资源将保持活动状态,直到进程退出。spring-doc.cadn.net.cn

如果服务器与进程定时,则通常不需要显式 关闭。但是,如果服务器可以在进程内启动或停止(例如,Spring MVC application 部署为 WAR),则可以声明ReactorResourceFactoryglobalResources=true(默认)来确保 Reactor Netty 全局资源在 SpringApplicationContext已关闭, 如下例所示:spring-doc.cadn.net.cn

@Bean
public ReactorResourceFactory reactorResourceFactory() {
	return new ReactorResourceFactory();
}

您也可以选择不参与全局 Reactor Netty 资源。然而 在这种模式下,您有责任确保所有 Reactor Netty 客户端和服务器 实例使用共享资源,如下例所示:spring-doc.cadn.net.cn

@Bean
public ReactorResourceFactory resourceFactory() {
	ReactorResourceFactory factory = new ReactorResourceFactory();
	factory.setUseGlobalResources(false); (1)
	return factory;
}

@Bean
public WebClient webClient() {

	Function<HttpClient, HttpClient> mapper = client -> {
		// Further customizations...
	};

	ClientHttpConnector connector =
			new ReactorClientHttpConnector(resourceFactory(), mapper); (2)

	return WebClient.builder().clientConnector(connector).build(); (3)
}
1 创建独立于全局资源的资源。
2 使用ReactorClientHttpConnector构造函数。
3 将连接器插入WebClient.Builder.

超时

要配置连接超时:spring-doc.cadn.net.cn

import io.netty.channel.ChannelOption;

HttpClient httpClient = HttpClient.create()
		.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 10000);

WebClient webClient = WebClient.builder()
		.clientConnector(new ReactorClientHttpConnector(httpClient))
		.build();

要配置读取或写入超时:spring-doc.cadn.net.cn

import io.netty.handler.timeout.ReadTimeoutHandler;
import io.netty.handler.timeout.WriteTimeoutHandler;

HttpClient httpClient = HttpClient.create()
		.doOnConnected(conn -> conn
				.addHandlerLast(new ReadTimeoutHandler(10))
				.addHandlerLast(new WriteTimeoutHandler(10)));

// Create WebClient...

要为所有请求配置响应超时,请执行以下作:spring-doc.cadn.net.cn

HttpClient httpClient = HttpClient.create()
		.responseTimeout(Duration.ofSeconds(2));

// Create WebClient...

要为特定请求配置响应超时,请执行以下作:spring-doc.cadn.net.cn

WebClient.create().get()
		.uri("https://example.org/path")
		.httpRequest(httpRequest -> {
			HttpClientRequest reactorRequest = httpRequest.getNativeRequest();
			reactorRequest.responseTimeout(Duration.ofSeconds(2));
		})
		.retrieve()
		.bodyToMono(String.class);

JDK HttpClient

以下示例说明如何自定义 JDKHttpClient:spring-doc.cadn.net.cn

HttpClient httpClient = HttpClient.newBuilder()
    .followRedirects(Redirect.NORMAL)
    .connectTimeout(Duration.ofSeconds(20))
    .build();

ClientHttpConnector connector =
        new JdkClientHttpConnector(httpClient, new DefaultDataBufferFactory());

WebClient webClient = WebClient.builder().clientConnector(connector).build();

Jetty

以下示例显示如何自定义 JettyHttpClient设置:spring-doc.cadn.net.cn

HttpClient httpClient = new HttpClient();
httpClient.setCookieStore(...);

WebClient webClient = WebClient.builder()
		.clientConnector(new JettyClientHttpConnector(httpClient))
		.build();

默认情况下,HttpClient创建自己的资源 (Executor,ByteBufferPool,Scheduler), 在进程退出之前保持活动状态,或者stop()被调用。spring-doc.cadn.net.cn

您可以在 Jetty 客户端(和服务器)的多个实例之间共享资源,并且 确保在 SpringApplicationContext由 声明 Spring 管理的 Bean 类型JettyResourceFactory,如下例所示 显示:spring-doc.cadn.net.cn

@Bean
public JettyResourceFactory resourceFactory() {
	return new JettyResourceFactory();
}

@Bean
public WebClient webClient() {

	HttpClient httpClient = new HttpClient();
	// Further customizations...

	ClientHttpConnector connector =
			new JettyClientHttpConnector(httpClient, resourceFactory()); (1)

	return WebClient.builder().clientConnector(connector).build(); (2)
}
1 使用JettyClientHttpConnector构造函数。
2 将连接器插入WebClient.Builder.

HttpComponents 组件

以下示例演示如何自定义 Apache HttpComponentsHttpClient设置:spring-doc.cadn.net.cn

HttpAsyncClientBuilder clientBuilder = HttpAsyncClients.custom();
clientBuilder.setDefaultRequestConfig(...);
CloseableHttpAsyncClient client = clientBuilder.build();

ClientHttpConnector connector = new HttpComponentsClientHttpConnector(client);

WebClient webClient = WebClient.builder().clientConnector(connector).build();

APP信息