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

配置

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

WebClient.create()spring-doc.cadn.net.cn
WebClient.create(String baseUrl)spring-doc.cadn.net.cn

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

uriBuilderFactory：定制UriBuilderFactory以用作基本 URL。spring-doc.cadn.net.cn
defaultUriVariables：展开 URI 模板时使用的默认值。spring-doc.cadn.net.cn
defaultHeader：每个请求的标头。spring-doc.cadn.net.cn
defaultCookie：每个请求的 Cookie。spring-doc.cadn.net.cn
defaultRequest:Consumer自定义每个请求。spring-doc.cadn.net.cn
filter：每个请求的客户端筛选器。spring-doc.cadn.net.cn
exchangeStrategies：HTTP 消息读取器/写入器自定义。spring-doc.cadn.net.cn
clientConnector：HTTP 客户端库设置。spring-doc.cadn.net.cn
observationRegistry：用于启用可观测性支持的注册表。spring-doc.cadn.net.cn
observationConvention：一种可选的自定义约定，用于提取记录观测的元数据。spring-doc.cadn.net.cn

例如：spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

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

val webClient = WebClient.builder()
		.codecs { configurer -> ... }
		.build()

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

Javaspring-doc.cadn.net.cn
Kotlinspring-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

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

val 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

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

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

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

Reactor Netty

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

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

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

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

val httpClient = HttpClient.create().secure { ... }

val webClient = WebClient.builder()
	.clientConnector(ReactorClientHttpConnector(httpClient))
	.build()

资源

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

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

Javaspring-doc.cadn.net.cn
Kotlinspring-doc.cadn.net.cn

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

@Bean
fun reactorResourceFactory() = ReactorResourceFactory()

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

Javaspring-doc.cadn.net.cn
Kotlinspring-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`.

@Bean
fun resourceFactory() = ReactorResourceFactory().apply {
	isUseGlobalResources = false (1)
}

@Bean
fun webClient(): WebClient {

	val mapper: (HttpClient) -> HttpClient = {
		// Further customizations...
	}

	val connector = ReactorClientHttpConnector(resourceFactory(), mapper) (2)

	return WebClient.builder().clientConnector(connector).build() (3)
}

1	创建独立于全局资源的资源。
2	使用`ReactorClientHttpConnector`构造函数。
3	将连接器插入`WebClient.Builder`.

超时

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

Javaspring-doc.cadn.net.cn
Kotlinspring-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();





import io.netty.channel.ChannelOption

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

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



To configure a read or write timeout:spring-doc.cadn.net.cn






Javaspring-doc.cadn.net.cn


Kotlinspring-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...







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

val httpClient = HttpClient.create()
		.doOnConnected { conn -> conn
				.addHandlerLast(ReadTimeoutHandler(10))
				.addHandlerLast(WriteTimeoutHandler(10))
		}

// Create WebClient...







To configure a response timeout for all requests:spring-doc.cadn.net.cn






Javaspring-doc.cadn.net.cn


Kotlinspring-doc.cadn.net.cn






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

// Create WebClient...






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

// Create WebClient...






To configure a response timeout for a specific request:spring-doc.cadn.net.cn






Javaspring-doc.cadn.net.cn


Kotlinspring-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);






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



JDK HttpClient


The following example shows how to customize the JDK HttpClient:spring-doc.cadn.net.cn






Javaspring-doc.cadn.net.cn


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






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

val connector = JdkClientHttpConnector(httpClient, DefaultDataBufferFactory())

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








Jetty


The following example shows how to customize Jetty HttpClient settings:spring-doc.cadn.net.cn








Javaspring-doc.cadn.net.cn


Kotlinspring-doc.cadn.net.cn






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

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






val httpClient = HttpClient()
httpClient.cookieStore = ...

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








By default, HttpClient creates its own resources (Executor, ByteBufferPool, Scheduler),
which remain active until the process exits or stop() is called.spring-doc.cadn.net.cn


You can share resources between multiple instances of the Jetty client (and server) and
ensure that the resources are shut down when the Spring ApplicationContext is closed by
declaring a Spring-managed bean of type JettyResourceFactory, as the following example
shows:spring-doc.cadn.net.cn








Javaspring-doc.cadn.net.cn


Kotlinspring-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
Use the JettyClientHttpConnector constructor with resource factory.


2
Plug the connector into the WebClient.Builder.







@Bean
fun resourceFactory() = JettyResourceFactory()

@Bean
fun webClient(): WebClient {

	val httpClient = HttpClient()
	// Further customizations...

	val connector = JettyClientHttpConnector(httpClient, resourceFactory()) (1)

	return WebClient.builder().clientConnector(connector).build() (2)
}





1
Use the JettyClientHttpConnector constructor with resource factory.


2
Plug the connector into the WebClient.Builder.











HttpComponents


The following example shows how to customize Apache HttpComponents HttpClient settings:spring-doc.cadn.net.cn






Javaspring-doc.cadn.net.cn


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






val client = HttpAsyncClients.custom().apply {
	setDefaultRequestConfig(...)
}.build()
val connector = HttpComponentsClientHttpConnector(client)
val webClient = WebClient.builder().clientConnector(connector).build()

1	Use the `JettyClientHttpConnector` constructor with resource factory.
2	Plug the connector into the `WebClient.Builder`.