インターフェース WebTestClient.Builder

メソッドの詳細

• baseUrl

  WebTestClient.Builder baseUrl(StringSE baseUrl)

  WebClient.create(String) の説明に従ってベース URI を構成します。

• uriBuilderFactory

  WebTestClient.Builder uriBuilderFactory(UriBuilderFactory uriBuilderFactory)

  baseUrl(String) の代替として、また事実上オーバーライドするために、事前に構成された UriBuilderFactory インスタンスを提供します。

• defaultHeader

  WebTestClient.Builder defaultHeader(StringSE headerName, StringSE... headerValues)

  指定されたヘッダーを追加していないすべてのリクエストに追加します。

  パラメーター:

  headerName - ヘッダー名

  headerValues - ヘッダー値

• defaultHeaders

  WebTestClient.Builder defaultHeaders(ConsumerSE<HttpHeaders> headersConsumer)

  指定されたコンシューマーでデフォルトのヘッダーを操作します。コンシューマーに提供されるヘッダーは「ライブ」であるため、コンシューマーを使用して既存のヘッダー値を上書きしたり、値を削除したり、他の HttpHeaders メソッドを使用したりできます。

  パラメーター:

  headersConsumer - HttpHeaders を消費する関数

  戻り値:

  このビルダー

• defaultCookie

  WebTestClient.Builder defaultCookie(StringSE cookieName, StringSE... cookieValues)

  指定された Cookie を、まだ追加されていないすべてのリクエストに追加します。

  パラメーター:

  cookieName - クッキー名

  cookieValues - クッキーの値

• defaultCookies

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

  指定されたコンシューマーでデフォルトの Cookie を操作します。コンシューマーに提供されるマップは「ライブ」であるため、コンシューマーを使用して、既存のヘッダー値を上書きしたり、値を削除しSEたり、その他の MultiValueMap メソッドを使用したりできます。

  パラメーター:

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

  戻り値:

  このビルダー

• defaultApiVersion

  WebTestClient.Builder defaultApiVersion(ObjectSE version)

  まだ設定されていない場合に、すべてのリクエストに追加する API バージョンを指定するグローバルオプション。

  パラメーター:

  version - 使用するバージョン

  戻り値:

  このビルダー

  導入:

  7.0

• apiVersionInserter

  WebTestClient.Builder apiVersionInserter(ApiVersionInserter apiVersionInserter)

  WebTestClient.RequestHeadersSpec.apiVersion(Object) で指定された API バージョンがリクエストに挿入される方法を抽象化するために ApiVersionInserter を構成します。

  パラメーター:

  apiVersionInserter - 使用するインサーター

  導入:

  7.0

• filter

  WebTestClient.Builder filter(ExchangeFilterFunction filter)

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

  パラメーター:

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

• filters

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

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

  パラメーター:

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

  戻り値:

  このビルダー

• codecs

  WebTestClient.Builder codecs(ConsumerSE<ClientCodecConfigurer> configurer)

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

  パラメーター:

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

  導入:

  5.1.13

• exchangeStrategies

  WebTestClient.Builder exchangeStrategies(ExchangeStrategies strategies)

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

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

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

  パラメーター:

  strategies - 使用する戦略

• responseTimeout

  WebTestClient.Builder responseTimeout(DurationSE timeout)

  レスポンスを待機する最大時間。

  デフォルトでは 5 秒。

  パラメーター:

  timeout - レスポンスタイムアウト値

• clientConnector

  WebTestClient.Builder clientConnector(ClientHttpConnector connector)

  使用する ClientHttpConnector を設定します。

  デフォルトでは、これは内部で初期化および設定されます。ただし、MockMvcWebTestClient テストなどでコネクターを外部で用意して WebTestClient.bindToServer(ClientHttpConnector) 経由で渡す場合もあり、その場合は WebTestClient.mutateWith(WebTestClientConfigurer) からこれを使用して置き換えることができます。

  パラメーター:

  connector - 使用するコネクター

  導入:

  6.1

• entityExchangeResultConsumer

  WebTestClient.Builder entityExchangeResultConsumer(ConsumerSE<EntityExchangeResult<?>> consumer)

  レスポンスが単一のエンティティ、エンティティのリスト、byte[] に完全にデコードされた後に毎回呼び出される EntityExchangeResult コールバックを構成します。事実上、以下のすべてと同等ですが、グローバルに 1 回登録されます。

   client.get().uri("/accounts/1")
           .exchange()
           .expectBody(Person.class).consumeWith(exchangeResult -> ... ));
  
   client.get().uri("/accounts")
           .exchange()
           .expectBodyList(Person.class).consumeWith(exchangeResult -> ... ));
  
   client.get().uri("/accounts/1")
           .exchange()
           .expectBody().consumeWith(exchangeResult -> ... ));
   

  構成されたコンシューマーは、Flux<T> にデコードされたレスポンスには適用されないことに注意してください。レスポンスは、reactor.test.StepVerifier などを介してテストクライアントのワークフローの外部で使用できます。

  パラメーター:

  consumer - エンティティのレスポンスに適用するコンシューマー

  戻り値:

  ビルダー

  導入:

  5.3.5

• apply

  WebTestClient.Builder apply(WebTestClientConfigurer configurer)

  指定されたコンフィギュレーターをこのビルダーインスタンスに適用します。

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

  パラメーター:

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

• build

  WebTestClient build()

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