インターフェース WebClient.Builder

メソッドの詳細

• baseUrl

  WebClient.Builder baseUrl(StringSE baseUrl)

  リクエストのベース URL を設定します。効果的には次のショートカットです。

   String baseUrl = "https://abc.go.com/v1";
   DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory(baseUrl);
   WebClient client = WebClient.builder().uriBuilderFactory(factory).build();
   

  DefaultUriBuilderFactory は、指定された URL の URL リクエストが絶対である場合を除き、指定されたベース URL を持つすべてのリクエストの URL を準備するために使用されます。その場合、ベース URL は無視されます。

  注意 : このメソッドは uriBuilderFactory(UriBuilderFactory) と相互に排他的です。両方が使用される場合、ここで指定された baseUrl 値は無視されます。

  関連事項:

  • DefaultUriBuilderFactory(String)
  • uriBuilderFactory(UriBuilderFactory)

• defaultUriVariables

  WebClient.Builder defaultUriVariables(MapSE<StringSE,?> defaultUriVariables)

  MapSE で URI テンプレートを展開するときに使用するデフォルトの URL 変数値を設定します。効果的には次のショートカットです。

   Map<String, ?> defaultVars = ...;
   DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory();
   factory.setDefaultVariables(defaultVars);
   WebClient client = WebClient.builder().uriBuilderFactory(factory).build();
   

  注意 : このメソッドは uriBuilderFactory(UriBuilderFactory) と相互に排他的です。両方が使用される場合、ここで指定された defaultUriVariables 値は無視されます。

  関連事項:

  • DefaultUriBuilderFactory.setDefaultUriVariables(Map)
  • uriBuilderFactory(UriBuilderFactory)

• uriBuilderFactory

  WebClient.Builder uriBuilderFactory(UriBuilderFactory uriBuilderFactory)

  事前構成済みの UriBuilderFactory インスタンスを提供します。これは、次のショートカットプロパティの代替であり、効果的にオーバーライドされます。

  • baseUrl(String)
  • defaultUriVariables(Map)。

  パラメーター:

  uriBuilderFactory - 使用する URI ビルダーファクトリ

  関連事項:

  • baseUrl(String)
  • defaultUriVariables(Map)

• defaultHeader

  WebClient.Builder defaultHeader(StringSE header, StringSE... values)

  リクエストにまだヘッダーが含まれていない場合、すべてのリクエストに追加するヘッダーを指定するグローバルオプション。

  パラメーター:

  header - ヘッダー名

  values - ヘッダー値

• defaultHeaders

  WebClient.Builder defaultHeaders(ConsumerSE<HttpHeaders> headersConsumer)

  これまでに宣言されたすべての defaultHeader(String, String...) へのアクセスを提供し、追加、置換、削除する機能があります。

  パラメーター:

  headersConsumer - コンシューマー

• defaultCookie

  WebClient.Builder defaultCookie(StringSE cookie, StringSE... values)

  リクエストにまだそのような Cookie が含まれていない場合、すべてのリクエストに追加する Cookie を指定するグローバルオプション。

  パラメーター:

  cookie - クッキー名

  values - クッキーの値

• defaultCookies

  WebClient.Builder defaultCookies(ConsumerSE<MultiValueMap<StringSE,StringSE>> cookiesConsumer)

  これまでに宣言されたすべての defaultCookie(String, String...) へのアクセスを提供し、追加、置換、削除する機能があります。

  パラメーター:

  cookiesConsumer - Cookie マップを使用する関数

• defaultRequest

  WebClient.Builder defaultRequest(ConsumerSE<WebClient.RequestHeadersSpec<?>> defaultRequest)

  構築されるすべてのリクエストをカスタマイズするためのコンシューマーを提供します。

  パラメーター:

  defaultRequest - リクエストを変更するために使用するコンシューマー

  導入:

  5.1

• defaultStatusHandler

  WebClient.Builder defaultStatusHandler(PredicateSE<HttpStatusCode> statusPredicate, FunctionSE<ClientResponse,reactor.core.publisher.Mono<? extends ThrowableSE>> exceptionFunction)

  すべてのレスポンスに適用するデフォルトの status handler を登録します。このようなデフォルトハンドラーは、登録された順序で適用され、特定のレスポンスに対して登録された他のハンドラーの後に適用されます。

  デフォルトのステータスハンドラーは、exchangeTo*() メソッドには適用されません。これらのバリアントはクライアントレスポンスに直接アクセスできるからです。

  パラメーター:

  statusPredicate - レスポンスを一致させる

  exceptionFunction - レスポンスをエラーシグナルにマッピングする

  戻り値:

  このビルダー

  導入:

  6.0

• filter

  WebClient.Builder filter(ExchangeFilterFunction filter)

  指定されたフィルターをフィルターチェーンの最後に追加します。

  パラメーター:

  filter - チェーンに追加されるフィルター

• filters

  WebClient.Builder filters(ConsumerSE<ListSE<ExchangeFilterFunction>> filtersConsumer)

  指定されたコンシューマーでフィルターを操作します。コンシューマーに提供されるリストは「ライブ」であるため、コンシューマーを使用してフィルターを削除したり、順序を変更したりできます。

  パラメーター:

  filtersConsumer - フィルターリストを使用する関数

  戻り値:

  このビルダー

• clientConnector

  WebClient.Builder clientConnector(ClientHttpConnector connector)

  使用する ClientHttpConnector を構成します。これは、基盤となる HTTP クライアントライブラリ (SSL など) のオプションをプラグインしたりカスタマイズしたりする場合に役立ちます。

  デフォルトでは、これは ReactorClientHttpConnector に設定されています。

  パラメーター:

  connector - 使用するコネクター

• codecs

  WebClient.Builder codecs(ConsumerSE<ClientCodecConfigurer> configurer)

  underlying ExchangeStrategies で WebClient のコーデックを構成します。

  パラメーター:

  configurer - 適用するコンフィギュレーター

  導入:

  5.1.13

• exchangeStrategies

  WebClient.Builder exchangeStrategies(ExchangeStrategies strategies)

  使用する ExchangeStrategies を構成します。

  ほとんどの場合、ExchangeStrategies のコーデックを置き換えるのではなくカスタマイズできる codecs(Consumer) を使用することをお勧めします。これにより、複数の関係者がコーデック設定に貢献できるようになります。

  デフォルトでは、これは ExchangeStrategies.withDefaults() に設定されています。

  パラメーター:

  strategies - 使用する戦略

• exchangeStrategies

  @DeprecatedSE WebClient.Builder exchangeStrategies(ConsumerSE<ExchangeStrategies.Builder> configurer)

  使用すべきではありません。

  5.1.13 現在、codecs(Consumer) を推奨

  exchangeStrategies(ExchangeStrategies) で構成された戦略をカスタマイズします。このメソッドは、複数の関係者が ExchangeStrategies を更新するシナリオで使用するために設計されています。

• exchangeFunction

  WebClient.Builder exchangeFunction(ExchangeFunction exchangeFunction)

  ClientHttpConnector および ExchangeStrategies で事前構成された ExchangeFunction を提供します。

  これは、clientConnector(org.springframework.http.client.reactive.ClientHttpConnector) および exchangeStrategies(ExchangeStrategies) の代替であり、事実上オーバーライドします。

  パラメーター:

  exchangeFunction - 使用する交換関数

• observationRegistry

  WebClient.Builder observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)

  HTTP クライアント呼び出しの監視を記録するために使用する ObservationRegistry を提供します。

  パラメーター:

  observationRegistry - 使用する観測レジストリ

  導入:

  6.0

• observationConvention

  WebClient.Builder observationConvention(ClientRequestObservationConvention observationConvention)

  リクエスト監視のメタデータを収集するために使用する ObservationConvention を提供します。何も指定されていない場合は DefaultClientRequestObservationConvention を使用します。

  パラメーター:

  observationConvention - 使用する観測規則

  導入:

  6.0

• apply

  WebClient.Builder apply(ConsumerSE<WebClient.Builder> builderConsumer)

  指定された Consumer をこのビルダーインスタンスに適用します。

  これは、事前にパッケージ化されたカスタマイズを適用できます。

  パラメーター:

  builderConsumer - 適用するコンシューマー

• clone

  WebClient.Builder clone()

  この WebClient.Builder を複製します。

• build

  WebClient build()

  WebClient インスタンスをビルドします。