WebClient (Spring Framework 5.0.0.RELEASE API)

public interface WebClient

クライアント側で Web リクエストを開始するためのメインエントリポイント。

 // Initialize the client
 WebClient client = WebClient.create("http://abc.com");

 // Perform requests...
 Mono<String> result = client.get()
     .uri("/foo")
     .exchange()
     .then(response -> response.bodyToMono(String.class));

導入:: 5.0
作成者:: Rossen Stoyanchev, Arjen Poutsma

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

ネストされたクラス
修飾子と型	インターフェースと説明
`static interface`	`WebClient.Builder` `WebClient` の変更可能なビルダー。
`static interface`	`WebClient.RequestBodySpec`
`static interface`	`WebClient.RequestBodyUriSpec`
`static interface`	`WebClient.RequestHeadersSpec<S extends WebClient.RequestHeadersSpec<S>>` 交換に至るまでのリクエストヘッダーを指定するための契約。
`static interface`	`WebClient.RequestHeadersUriSpec<S extends WebClient.RequestHeadersSpec<S>>`
`static interface`	`WebClient.ResponseSpec`
`static interface`	`WebClient.UriSpec<S extends WebClient.RequestHeadersSpec<?>>` リクエストの URI を指定するための契約。

メソッドのサマリー

すべてのメソッド静的メソッドインスタンスメソッド抽象メソッドデフォルトメソッド
修飾子と型	メソッドと説明
`static WebClient.Builder`	`builder()` `WebClient` ビルダーを入手します。
`static WebClient`	`create()` デフォルトのない新しい `WebClient` を作成し、ベース URI、デフォルトヘッダーなどのリクエスト間で設定を共有します。
`static WebClient`	`create(StringSE baseUrl)` たとえば、すべてのリクエストで同じホスト、ポート、ベースパス、クエリパラメーターさえ繰り返さないように、クライアントを介して実行されるリクエストのベース URI を設定します。
`WebClient.RequestHeadersUriSpec<?>`	`delete()` HTTP DELETE リクエストを準備します。
`WebClient.RequestHeadersUriSpec<?>`	`get()` HTTP GET リクエストを準備します。
`WebClient.RequestHeadersUriSpec<?>`	`head()` HTTP HEAD リクエストを準備します。
`WebClient.RequestBodyUriSpec`	`method(HttpMethod method)` 指定された `HttpMethod` のリクエストを準備します。
`WebClient.Builder`	`mutate()` この Web クライアントのプロパティを変更するビルダーを返します。
`WebClient.RequestHeadersUriSpec<?>`	`options()` HTTP OPTIONS リクエストを準備します。
`WebClient.RequestBodyUriSpec`	`patch()` HTTP PATCH リクエストを準備します。
`WebClient.RequestBodyUriSpec`	`post()` HTTP POST リクエストを準備します。
`WebClient.RequestBodyUriSpec`	`put()` HTTP PUT リクエストを準備します。

- メソッドの詳細
  - get
```
WebClient.RequestHeadersUriSpec<?> get()
```
    HTTP GET リクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - head
```
WebClient.RequestHeadersUriSpec<?> head()
```
    HTTP HEAD リクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - post
```
WebClient.RequestBodyUriSpec post()
```
    HTTP POST リクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - put
```
WebClient.RequestBodyUriSpec put()
```
    HTTP PUT リクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - patch
```
WebClient.RequestBodyUriSpec patch()
```
    HTTP PATCH リクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - delete
```
WebClient.RequestHeadersUriSpec<?> delete()
```
    HTTP DELETE リクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - options
```
WebClient.RequestHeadersUriSpec<?> options()
```
    HTTP OPTIONS リクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - method
```
WebClient.RequestBodyUriSpec method(HttpMethod method)
```
    指定された HttpMethod のリクエストを準備します。
    戻り値:
    ターゲット URL を指定するための仕様
  - mutate
```
WebClient.Builder mutate()
```
    この Web クライアントのプロパティを変更するビルダーを返します。
  - create
```
static WebClient create()
```
    デフォルトのない新しい WebClient を作成し、ベース URI、デフォルトヘッダーなどのリクエスト間で設定を共有します。
    関連事項:
    create(String)
  - create
```
static WebClient create(StringSE baseUrl)
```
    たとえば、すべてのリクエストで同じホスト、ポート、ベースパス、クエリパラメーターさえ繰り返さないように、クライアントを介して実行されるリクエストのベース URI を設定します。
    たとえば、この初期化を考えると:
```
 WebClient client = WebClient.create("http://abc.com/v1");
 
```
    ベース URI は、URI テンプレートとの交換に適用されます。
```
 // GET http://abc.com/v1/accounts/43
 Mono<Account> result = client.get()
         .uri("/accounts/{id}", 43)
         .exchange()
         .then(response -> response.bodyToMono(Account.class));
 
```
    ベース URI は、UriBuilder との交換にも適用されます。
```
 // GET http://abc.com/v1/accounts?q=12
 Flux<Account> result = client.get()
         .uri(builder -> builder.path("/accounts").queryParam("q", "12").build())
         .exchange()
         .then(response -> response.bodyToFlux(Account.class));
 
```
    ベース URI は絶対 URI でオーバーライドできます。
```
 // GET http://xyz.com/path
 Mono<Account> result = client.get()
         .uri("http://xyz.com/path")
         .exchange()
         .then(response -> response.bodyToMono(Account.class));
 
```
    ベース URI は、UriBuilder で部分的にオーバーライドできます。
```
 // GET http://abc.com/v2/accounts?q=12
 Flux<Account> result = client.get()
         .uri(builder -> builder.replacePath("/v2/accounts").queryParam("q", "12").build())
         .exchange()
         .then(response -> response.bodyToFlux(Account.class));
 
```
    パラメーター:
    baseUrl - すべてのリクエストのベース URI
  - builder
```
static WebClient.Builder builder()
```
    WebClient ビルダーを入手します。

インターフェース WebClient

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

メソッドのサマリー

メソッドの詳細

get

head

post

put

patch

delete

options

method

mutate

create

create

builder