WebTestClient (Spring Framework API)

```
public interface WebTestClient
```
内部で WebClient を使用してリクエストを実行する一方で、レスポンスを検証する流れるような API を提供する Web サーバーをテストするためのクライアント。このクライアントは、HTTP 経由で任意のサーバーに接続するか、モックリクエストおよびレスポンスオブジェクトを介して WebFlux アプリケーションに接続できます。
bindToXxx メソッドのいずれかを使用して、インスタンスを作成します。例：
警告 :Kotlin 1.3 で修正される予定の型推論の課題により、Kotlin では WebTestClient はまだ使用できません。最新の情報については、gh-20606 を参照してください。一方、提案された代替案は、Reactor および Spring Kotlin 拡張機能を備えた WebClient を直接使用して、組み込み WebFlux サーバーで統合テストを実行することです。
導入:
5.0
作成者:
Rossen Stoyanchev, Brian Clozel, Sam Brannen, Micha ł Rowicki
関連事項:
StatusAssertions, HeaderAssertions, JsonPathAssertions

ネストされたクラスの要約

ネストされたクラス
修飾子と型	インターフェースと説明
`static interface`	`WebTestClient.BodyContentSpec` レスポンス本文の内容に対する期待の仕様。
`static interface`	`WebTestClient.BodySpec<B, S extends WebTestClient.BodySpec<B, S>>` 単一のオブジェクトにデコードされたレスポンス本文に対する期待の仕様。
`static interface`	`WebTestClient.Builder` テストに使用する `WebClient` をカスタマイズする手順。内部で `WebClient.Builder` に委譲します。
`static interface`	`WebTestClient.ControllerSpec` `WebFluxConfigurer` と同等で内部的に委譲するコントローラー構成をカスタマイズするための仕様。
`static interface`	`WebTestClient.ListBodySpec<E>` リストにデコードされたレスポンス本文に対する期待の仕様。
`static interface`	`WebTestClient.MockServerSpec<B extends WebTestClient.MockServerSpec<B>>` サーバーなしでテストをセットアップするための基本仕様。
`static interface`	`WebTestClient.RequestBodySpec` リクエストの本文を提供するための仕様。
`static interface`	`WebTestClient.RequestBodyUriSpec` リクエストの本文と URI を提供するための仕様。
`static interface`	`WebTestClient.RequestHeadersSpec<S extends WebTestClient.RequestHeadersSpec<S>>` リクエストヘッダーを追加し、交換を実行するための仕様。
`static interface`	`WebTestClient.RequestHeadersUriSpec<S extends WebTestClient.RequestHeadersSpec<S>>` リクエストヘッダーとリクエストの URI を提供するための仕様。
`static interface`	`WebTestClient.ResponseSpec` アサーションをレスポンスに適用するための連鎖 API。
`static interface`	`WebTestClient.RouterFunctionSpec` ルーター関数の構成をカスタマイズするための仕様。
`static interface`	`WebTestClient.UriSpec<S extends WebTestClient.RequestHeadersSpec<?>>` リクエストの URI を提供するための仕様。

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`WEBTESTCLIENT_REQUEST_ID` `WebTestClient` を介して実行されるすべてのリクエストに一意の ID を割り当てるために使用されるリクエストヘッダーの名前。

メソッドのサマリー

すべてのメソッド静的メソッドインスタンスメソッド抽象メソッドデフォルトメソッド
修飾子と型	メソッドと説明
`static WebTestClient.MockServerSpec<?>`	`bindToApplicationContext(ApplicationContext applicationContext)` このオプションを使用して、アプリケーションの Spring 構成またはそのサブセットからサーバーをセットアップします。
`static WebTestClient.ControllerSpec`	`bindToController(ObjectSE... controllers)` このサーバー設定を使用して、一度に 1 つの `@Controller` をテストします。
`static WebTestClient.RouterFunctionSpec`	`bindToRouterFunction(RouterFunction<?> routerFunction)` このオプションを使用して、`RouterFunction` からサーバーをセットアップします。
`static WebTestClient.Builder`	`bindToServer()` このサーバーセットアップオプションを使用すると、Reactor Netty クライアントコネクターを介してライブサーバーに接続できます。
`static WebTestClient.Builder`	`bindToServer(ClientHttpConnector connector)` 事前に構成されたコネクターを備えた `bindToServer()` のバリアント。
`static WebTestClient.MockServerSpec<?>`	`bindToWebHandler(WebHandler webHandler)` 特定の WebHandler をターゲットとする「モック」サーバーとの統合テスト。
`WebTestClient.RequestHeadersUriSpec<?>`	`delete()` HTTP DELETE リクエストを準備します。
`WebTestClient.RequestHeadersUriSpec<?>`	`get()` HTTP GET リクエストを準備します。
`WebTestClient.RequestHeadersUriSpec<?>`	`head()` HTTP HEAD リクエストを準備します。
`WebTestClient.RequestBodyUriSpec`	`method(HttpMethod method)` 指定された `HttpMethod` のリクエストを準備します。
`WebTestClient.Builder`	`mutate()` この Web テストクライアントのプロパティを変更するビルダーを返します。
`WebTestClient`	`mutateWith(WebTestClientConfigurer configurer)` `WebTestClient` を変更し、指定されたコンフィギュレーターを適用して、新しいインスタンスを構築します。
`WebTestClient.RequestHeadersUriSpec<?>`	`options()` HTTP OPTIONS リクエストを準備します。
`WebTestClient.RequestBodyUriSpec`	`patch()` HTTP PATCH リクエストを準備します。
`WebTestClient.RequestBodyUriSpec`	`post()` HTTP POST リクエストを準備します。
`WebTestClient.RequestBodyUriSpec`	`put()` HTTP PUT リクエストを準備します。

- フィールドの詳細
  - WEBTESTCLIENT_REQUEST_ID
```
static final StringSE WEBTESTCLIENT_REQUEST_ID
```
    WebTestClient を介して実行されるすべてのリクエストに一意の ID を割り当てるために使用されるリクエストヘッダーの名前。これは、その ID で（たとえばサーバー側コンポーネントからの）リクエスト処理のすべての段階でコンテキスト情報を保存し、ExchangeResult が利用可能になったときにその情報を検索できます。
    関連事項:
    定数フィールド値
- メソッドの詳細
  - get
```
WebTestClient.RequestHeadersUriSpec<?> get()
```
    HTTP GET リクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - head
```
WebTestClient.RequestHeadersUriSpec<?> head()
```
    HTTP HEAD リクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - post
```
WebTestClient.RequestBodyUriSpec post()
```
    HTTP POST リクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - put
```
WebTestClient.RequestBodyUriSpec put()
```
    HTTP PUT リクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - patch
```
WebTestClient.RequestBodyUriSpec patch()
```
    HTTP PATCH リクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - delete
```
WebTestClient.RequestHeadersUriSpec<?> delete()
```
    HTTP DELETE リクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - options
```
WebTestClient.RequestHeadersUriSpec<?> options()
```
    HTTP OPTIONS リクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - method
```
WebTestClient.RequestBodyUriSpec method(HttpMethod method)
```
    指定された HttpMethod のリクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - mutate
```
WebTestClient.Builder mutate()
```
    この Web テストクライアントのプロパティを変更するビルダーを返します。
  - mutateWith
```
WebTestClient mutateWith(WebTestClientConfigurer configurer)
```
    WebTestClient を変更し、指定された設定プログラムを適用して、新しいインスタンスを作成します。基本的には次のショートカットです。
```
 mutate().apply(configurer).build();
 
```
    パラメーター:
    configurer - 適用するコンフィギュレーター
    戻り値:
    変異したテストクライアント
  - bindToController
```
static WebTestClient.ControllerSpec bindToController(ObjectSE... controllers)
```
    このサーバー設定を使用して、一度に 1 つの @Controller をテストします。このオプションは、@EnableWebFlux のデフォルト構成をロードします。Java 構成をカスタマイズするためのビルダーメソッドがあります。結果の WebFlux アプリケーションは、モックリクエストとレスポンスを使用して HTTP サーバーなしでテストされます。
    パラメーター:
    controllers - テストする 1 つ以上のコントローラーインスタンス (指定された Class はインスタンスに変換されます)
    戻り値:
    サーバーとクライアントの設定をカスタマイズするためのチェーン API。WebTestClient.MockServerSpec.configureClient() を使用してクライアント構成に移行する
  - bindToRouterFunction
```
static WebTestClient.RouterFunctionSpec bindToRouterFunction(RouterFunction<?> routerFunction)
```
    このオプションを使用して、RouterFunction からサーバーをセットアップします。内部的には、提供された構成が RouterFunctions#toWebHandler に渡されます。結果の WebFlux アプリケーションは、モックリクエストとレスポンスを使用して、HTTP サーバーなしでテストされます。
    パラメーター:
    routerFunction - テストする RouterFunction
    戻り値:
    サーバーとクライアントの設定をカスタマイズするためのチェーン API。WebTestClient.MockServerSpec.configureClient() を使用してクライアント構成に移行する
  - bindToApplicationContext
```
static WebTestClient.MockServerSpec<?> bindToApplicationContext(ApplicationContext applicationContext)
```
    このオプションを使用して、アプリケーションの Spring 構成またはそのサブセットからサーバーをセットアップします。内部的に、提供された構成は WebHttpHandlerBuilder に渡され、リクエスト処理チェーンがセットアップされます。結果の WebFlux アプリケーションは、モックリクエストとレスポンスを使用して HTTP サーバーなしでテストされます。
    Spring 構成をテストクラスに効率的にロードして挿入するために、TestContext フレームワークと @ContextConfiguration の使用を検討してください。
    パラメーター:
    applicationContext - Spring コンテキスト
    戻り値:
    サーバーとクライアントの設定をカスタマイズするためのチェーン API。WebTestClient.MockServerSpec.configureClient() を使用してクライアント構成に移行する
  - bindToWebHandler
```
static WebTestClient.MockServerSpec<?> bindToWebHandler(WebHandler webHandler)
```
    特定の WebHandler をターゲットとする「モック」サーバーとの統合テスト。
    パラメーター:
    webHandler - テストするハンドラー
    戻り値:
    サーバーとクライアントの設定をカスタマイズするためのチェーン API。WebTestClient.MockServerSpec.configureClient() を使用してクライアント構成に移行する
  - bindToServer
```
static WebTestClient.Builder bindToServer()
```
    このサーバーセットアップオプションを使用すると、Reactor Netty クライアントコネクターを介してライブサーバーに接続できます。
```
 WebTestClient client = WebTestClient.bindToServer()
         .baseUrl("http://localhost:8080")
         .build();
 
```
    戻り値:
    クライアント構成をカスタマイズするためのチェーン API
  - bindToServer
```
static WebTestClient.Builder bindToServer(ClientHttpConnector connector)
```
    事前に構成されたコネクターを備えた bindToServer() のバリアント。
    戻り値:
    クライアント構成をカスタマイズするためのチェーン API
    導入:
    5.0.2

インターフェース WebTestClient

ネストされたクラスの要約

フィールドのサマリー

メソッドのサマリー

フィールドの詳細

WEBTESTCLIENT_REQUEST_ID

メソッドの詳細

get

head

post

put

patch

delete

options

method

mutate

mutateWith

bindToController

bindToRouterFunction

bindToApplicationContext

bindToWebHandler

bindToServer

bindToServer