構成

WebClient を作成する最も簡単な方法は、静的ファクトリメソッドの 1 つを使用することです。

  • WebClient.create()

  • WebClient.create(String baseUrl)

WebClient.builder() を追加オプションとともに使用することもできます。

  • uriBuilderFactory: ベース URL として使用するために UriBuilderFactory をカスタマイズしました。

  • defaultUriVariables: URI テンプレートを展開するときに使用するデフォルト値。

  • defaultHeader: すべてのリクエストのヘッダー。

  • defaultCookie: リクエストごとの Cookie。

  • defaultRequest: Consumer ですべてのリクエストをカスタマイズします。

  • filter: すべてのリクエストのクライアントフィルター。

  • exchangeStrategies: HTTP メッセージリーダー / ライターのカスタマイズ。

  • clientConnector: HTTP クライアントライブラリの設定。

  • observationRegistry: 可観測性のサポートを有効にするために使用するレジストリ。

  • observationConvention: 記録された観測のメタデータを抽出するためのオプションのカスタム規則。

例:

  • Java

  • Kotlin

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

一度構築されると、WebClient は不変です。ただし、次のようにクローンを作成して、変更されたコピーを作成できます。

  • Java

  • Kotlin

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

MaxInMemorySize

コーデックには、アプリケーションのメモリの課題を回避するために、メモリにデータをバッファリングするための制限があります。デフォルトでは、これらは 256KB に設定されています。それでも不十分な場合は、次のエラーが発生します。

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

デフォルトコーデックの制限を変更するには、以下を使用します。

  • Java

  • Kotlin

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 を提供します。

  • Java

  • Kotlin

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.http.HttpResources に保持されているグローバル Reactor Netty リソースに参加します。これは、イベントループの同時実行には固定の共有リソースが優先されるため、推奨されるモードです。このモードでは、プロセスが終了するまでグローバルリソースがアクティブのままになります。

サーバーがプロセスとタイミングを合わせている場合、通常、明示的なシャットダウンは必要ありません。ただし、サーバーがインプロセス (たとえば、WAR としてデプロイされた Spring MVC アプリケーション) を開始または停止できる場合は、ReactorResourceFactory 型の Spring 管理 Bean を globalResources=true (デフォルト) で宣言して、Reactor Netty グローバルリソース次の例に示すように、Spring ApplicationContext が閉じられるとシャットダウンされます。

  • Java

  • Kotlin

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

グローバル Reactor Netty リソースに参加しないことも選択できます。ただし、このモードでは、次の例に示すように、すべての Reactor Netty クライアントおよびサーバーインスタンスが共有リソースを使用することを保証する負担があります。

  • Java

  • Kotlin

@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 に差し込みます。

タイムアウト

接続タイムアウトを構成するには:

  • Java

  • Kotlin

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

読み取りまたは書き込みタイムアウトを構成するには:

  • Java

  • Kotlin

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

すべてのリクエストのレスポンスタイムアウトを設定するには:

  • Java

  • Kotlin

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

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

// Create WebClient...

特定のリクエストのレスポンスタイムアウトを設定するには:

  • Java

  • Kotlin

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

次の例は、JDK HttpClient をカスタマイズする方法を示しています。

  • Java

  • Kotlin

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

次の例は、Jetty HttpClient 設定をカスタマイズする方法を示しています。

  • Java

  • Kotlin

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

デフォルトでは、HttpClient は独自のリソース（Executor、ByteBufferPool、Scheduler）を作成し、プロセスが終了するか stop() が呼び出されるまでアクティブのままになります。

次の例に示すように、型 JettyResourceFactory の Spring 管理 Bean を宣言することにより、Jetty クライアント（およびサーバー）の複数のインスタンス間でリソースを共有し、Spring ApplicationContext が閉じられたときにリソースを確実にシャットダウンできます。

  • Java

  • Kotlin

@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 に差し込みます。
@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 リソースファクトリで JettyClientHttpConnector コンストラクターを使用します。
2 コネクターを WebClient.Builder に差し込みます。

HttpComponents

次の例は、Apache HttpComponents HttpClient 設定をカスタマイズする方法を示しています。

  • Java

  • Kotlin

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