クラス BodyInserters
BodyInserter
実装の静的ファクトリメソッド。- 導入:
- 5.0
- 作成者:
- Arjen Poutsma, Rossen Stoyanchev, Sebastien Deleuze
ネストされたクラスのサマリー
ネストされたクラス修飾子と型クラス説明static interface
フォームデータまたはマルチパートフォームデータの追加を可能にするBodyInserter
の拡張。static interface
非同期パーツの追加を可能にするBodyInserters.FormInserter
の拡張。コンストラクターのサマリー
コンストラクター方法の概要
修飾子と型メソッド説明static <T> BodyInserter<T,
ReactiveHttpOutputMessage> empty()
書かないインサーター。static <T extends Publisher<DataBuffer>>
BodyInserter<T,ReactiveHttpOutputMessage> fromDataBuffers
(T publisher) 指定されたPublisher<DataBuffer>
を本文に書き込むための挿入子。static BodyInserters.FormInserter<StringSE>
fromFormData
(StringSE name, StringSE value) BodyInserters.FormInserter
を返し、指定されたキーと値のペアを URL エンコードされたフォームデータとして書き込みます。static BodyInserters.FormInserter<StringSE>
fromFormData
(MultiValueMap<StringSE, StringSE> formData) BodyInserters.FormInserter
を返し、指定されたMultiValueMap
を URL エンコードされたフォームデータとして書き込みます。static <T,
P extends Publisher<T>>
BodyInserters.MultipartInserterfromMultipartAsyncData
(StringSE name, P publisher, ClassSE<T> elementClass) BodyInserters.MultipartInserter
を返し、指定された非同期パートをマルチパートデータとして書き込みます。static <T,
P extends Publisher<T>>
BodyInserters.MultipartInserterfromMultipartAsyncData
(StringSE name, P publisher, ParameterizedTypeReference<T> typeReference) 要素型のParameterizedTypeReference
を受け入れるfromMultipartAsyncData(String, Publisher, Class)
のバリアント。これにより、一般的な型情報を指定できます。fromMultipartData
(StringSE name, ObjectSE value) BodyInserters.MultipartInserter
を返し、指定されたパートをマルチパートデータとして書き込みます。fromMultipartData
(MultiValueMap<StringSE, ?> multipartData) BodyInserters.MultipartInserter
を返し、指定されたMultiValueMap
をマルチパートデータとして書き込みます。static <T> BodyInserter<T,
ReactiveHttpOutputMessage> fromObject
(T body) 使用すべきではありません。static <T extends Publisher<DataBuffer>>
BodyInserter<T,ReactiveHttpOutputMessage> fromOutputStream
(ConsumerSE<OutputStreamSE> outputStreamConsumer, ExecutorSE executor) OutputStream
に書き込まれたバイトに基づくインサーター。static <T extends Publisher<DataBuffer>>
BodyInserter<T,ReactiveHttpOutputMessage> fromOutputStream
(ConsumerSE<OutputStreamSE> outputStreamConsumer, ExecutorSE executor, int chunkSize) OutputStream
に書き込まれたバイトに基づくインサーター。static <T> BodyInserter<T,
ReactiveHttpOutputMessage> fromProducer
(T producer, ClassSE<?> elementClass) Publisher
またはReactiveAdapterRegistry
を介してPublisher
に適応可能な別のプロデューサーでなければならない値の指定されたプロデューサーを書き込むためのインサーター。static <T> BodyInserter<T,
ReactiveHttpOutputMessage> fromProducer
(T producer, ParameterizedTypeReference<?> elementTypeRef) Publisher
またはReactiveAdapterRegistry
を介してPublisher
に適応可能な別のプロデューサーでなければならない値の指定されたプロデューサーを書き込むためのインサーター。static <T,
P extends Publisher<T>>
BodyInserter<P,ReactiveHttpOutputMessage> fromPublisher
(P publisher, ClassSE<T> elementClass) 指定されたPublisher
を書き込むためのインサーター。static <T,
P extends Publisher<T>>
BodyInserter<P,ReactiveHttpOutputMessage> fromPublisher
(P publisher, ParameterizedTypeReference<T> elementTypeRef) 指定されたPublisher
を書き込むためのインサーター。static <T extends Resource>
BodyInserter<T,ReactiveHttpOutputMessage> fromResource
(T resource) 指定されたResource
を書き込むための挿入子。static <T,
S extends Publisher<ServerSentEvent<T>>>
BodyInserter<S,ServerHttpResponse> fromServerSentEvents
(S eventsPublisher) 指定されたServerSentEvent
パブリッシャーを書き込むインサーター。static <T> BodyInserter<T,
ReactiveHttpOutputMessage> fromValue
(T body) 指定された値を書き込むための挿入子。static <T> BodyInserter<T,
ReactiveHttpOutputMessage> fromValue
(T body, ParameterizedTypeReference<T> bodyType) 指定された値を書き込むための挿入子。
コンストラクターの詳細
BodyInserters
public BodyInserters()
メソッドの詳細
empty
書かないインサーター。- 戻り値:
- インサーター
fromValue
指定された値を書き込むための挿入子。または、
WebClient
およびServerResponse
でbodyValue(Object)
ショートカットを使用することを検討してください。- 型パラメーター:
T
- 体の種類- パラメーター:
body
- 書き込む値- 戻り値:
- 単一の値を書き込むための挿入子
- 例外:
IllegalArgumentExceptionSE
-body
がPublisher
またはReactiveAdapterRegistry.getSharedInstance()
でサポートされている型のインスタンスである場合、fromPublisher(Publisher, Class)
またはfromProducer(Object, Class)
を使用する必要があります。- 関連事項:
fromValue
public static <T> BodyInserter<T,ReactiveHttpOutputMessage> fromValue(T body, ParameterizedTypeReference<T> bodyType) 指定された値を書き込むための挿入子。または、
WebClient
およびServerResponse
でbodyValue(Object, ParameterizedTypeReference)
ショートカットを使用することを検討してください。- 型パラメーター:
T
- 体の種類- パラメーター:
body
- 書き込む値bodyType
- ジェネリクス型をキャプチャーするために使用されるボディの型- 戻り値:
- 単一の値を書き込むための挿入子
- 例外:
IllegalArgumentExceptionSE
-body
がPublisher
またはReactiveAdapterRegistry.getSharedInstance()
でサポートされている型のインスタンスである場合、fromPublisher(Publisher, ParameterizedTypeReference)
またはfromProducer(Object, ParameterizedTypeReference)
を使用する必要があります。- 導入:
- 6.2
- 関連事項:
fromObject
使用すべきではありません。Spring Framework 5.2 以降、fromValue(Object)
を推奨指定されたオブジェクトを書き込むための挿入子。または、
WebClient
およびServerResponse
でbodyValue(Object)
ショートカットを使用することを検討してください。- 型パラメーター:
T
- 体の種類- パラメーター:
body
- レスポンスに書き込む本文- 戻り値:
- 単一のオブジェクトを書き込むための挿入子
- 例外:
IllegalArgumentExceptionSE
-body
がPublisher
またはReactiveAdapterRegistry.getSharedInstance()
でサポートされている型のインスタンスである場合、fromPublisher(Publisher, Class)
またはfromProducer(Object, Class)
を使用する必要があります。- 関連事項:
fromProducer
public static <T> BodyInserter<T,ReactiveHttpOutputMessage> fromProducer(T producer, ClassSE<?> elementClass) Publisher
またはReactiveAdapterRegistry
を介してPublisher
に適応可能な別のプロデューサーでなければならない値の指定されたプロデューサーを書き込むためのインサーター。または、
WebClient
およびServerResponse
でbody
ショートカットを使用することを検討してください。- 型パラメーター:
T
- 体の種類- パラメーター:
producer
- ボディ値のソース。elementClass
- 生成される値のクラス- 戻り値:
- プロデューサーを記述するインサーター
- 導入:
- 5.2
fromProducer
public static <T> BodyInserter<T,ReactiveHttpOutputMessage> fromProducer(T producer, ParameterizedTypeReference<?> elementTypeRef) Publisher
またはReactiveAdapterRegistry
を介してPublisher
に適応可能な別のプロデューサーでなければならない値の指定されたプロデューサーを書き込むためのインサーター。または、
WebClient
およびServerResponse
でbody
ショートカットを使用することを検討してください。- 型パラメーター:
T
- 体の種類- パラメーター:
producer
- ボディ値のソース。elementTypeRef
- 生成される値の型- 戻り値:
- プロデューサーを記述するインサーター
- 導入:
- 5.2
fromPublisher
public static <T,P extends Publisher<T>> BodyInserter<P,ReactiveHttpOutputMessage> fromPublisher(P publisher, ClassSE<T> elementClass) 指定されたPublisher
を書き込むためのインサーター。または、
WebClient
およびServerResponse
でbody
ショートカットを使用することを検討してください。- 型パラメーター:
T
- パブリッシャーに含まれる要素の型P
-Publisher
型- パラメーター:
publisher
- 一緒に書くパブリッシャーelementClass
- パブリッシャーの要素のクラス- 戻り値:
Publisher
を書き込むための挿入子
fromPublisher
public static <T,P extends Publisher<T>> BodyInserter<P,ReactiveHttpOutputMessage> fromPublisher(P publisher, ParameterizedTypeReference<T> elementTypeRef) 指定されたPublisher
を書き込むためのインサーター。または、
WebClient
およびServerResponse
でbody
ショートカットを使用することを検討してください。- 型パラメーター:
T
- パブリッシャーに含まれる要素の型P
-Publisher
型- パラメーター:
publisher
- 一緒に書くパブリッシャーelementTypeRef
- パブリッシャーに含まれる要素の型- 戻り値:
Publisher
を書き込むための挿入子
fromResource
public static <T extends Resource> BodyInserter<T,ReactiveHttpOutputMessage> fromResource(T resource) - 型パラメーター:
T
-Resource
の型- パラメーター:
resource
- 出力メッセージに書き込むリソース- 戻り値:
Publisher
を書き込むための挿入子
fromServerSentEvents
public static <T,S extends Publisher<ServerSentEvent<T>>> BodyInserter<S,ServerHttpResponse> fromServerSentEvents(S eventsPublisher) 指定されたServerSentEvent
パブリッシャーを書き込むインサーター。または、
fromPublisher(Publisher, Class)
またはfromProducer(Object, Class)
を介してイベントデータオブジェクトを提供し、"Content-Type" をtext/event-stream
に設定できます。- 型パラメーター:
T
-ServerSentEvent
のデータ要素の型- パラメーター:
eventsPublisher
- レスポンス本文に書き込むServerSentEvent
パブリッシャー- 戻り値:
ServerSentEvent
パブリッシャーを作成するためのインサーター- 関連事項:
fromFormData
public static BodyInserters.FormInserter<StringSE> fromFormData(MultiValueMap<StringSE, StringSE> formData) BodyInserters.FormInserter
を返し、指定されたMultiValueMap
を URL エンコードされたフォームデータとして書き込みます。返された挿入子により、BodyInserters.FormInserter.with(String, Object)
を介して追加のエントリを追加できます。WebClient
とWebTestClient
の両方のリクエストビルダーでbodyValue(Object)
メソッドを使用することもできます。その場合、リクエストのコンテンツ型の設定も不要です。マップに文字列値のみが含まれていることを確認してください。そうでない場合、マルチパートリクエストとして解釈されます。- パラメーター:
formData
- 出力メッセージに書き込むフォームデータ- 戻り値:
- さらにフォームデータを追加できる挿入子
fromFormData
BodyInserters.FormInserter
を返し、指定されたキーと値のペアを URL エンコードされたフォームデータとして書き込みます。返された挿入子により、BodyInserters.FormInserter.with(String, Object)
を介して追加のエントリを追加できます。- パラメーター:
name
- フォームに追加するキーvalue
- フォームに追加する値- 戻り値:
- さらにフォームデータを追加できる挿入子
fromMultipartData
public static BodyInserters.MultipartInserter fromMultipartData(MultiValueMap<StringSE, ?> multipartData) BodyInserters.MultipartInserter
を返し、指定されたMultiValueMap
をマルチパートデータとして書き込みます。マップの値は、オブジェクトまたはHttpEntity
です。MultipartBodyBuilder
を使用して外部でマルチパートデータを作成し、結果のマップをWebClient
のbodyValue(Object)
ショートカットメソッドに直接渡すこともできます。- パラメーター:
multipartData
- 出力メッセージに書き込むフォームデータ- 戻り値:
- さらにパーツを追加できるインサーター
- 関連事項:
fromMultipartData
BodyInserters.MultipartInserter
を返し、指定されたパートをマルチパートデータとして書き込みます。マップの値は、オブジェクトまたはHttpEntity
です。MultipartBodyBuilder
を使用して外部でマルチパートデータを作成し、結果のマップをWebClient
のbodyValue(Object)
ショートカットメソッドに直接渡すこともできます。- パラメーター:
name
- パーツ名value
- パーツ値、オブジェクトまたはHttpEntity
- 戻り値:
- さらにパーツを追加できるインサーター
fromMultipartAsyncData
public static <T,P extends Publisher<T>> BodyInserters.MultipartInserter fromMultipartAsyncData(StringSE name, P publisher, ClassSE<T> elementClass) BodyInserters.MultipartInserter
を返し、指定された非同期パートをマルチパートデータとして書き込みます。MultipartBodyBuilder
を使用して外部でマルチパートデータを作成し、結果のマップをWebClient
のbodyValue(Object)
ショートカットメソッドに直接渡すこともできます。- パラメーター:
name
- パーツ名publisher
- パーツ値を形成する発行者elementClass
-publisher
に含まれるクラス- 戻り値:
- さらにパーツを追加できるインサーター
fromMultipartAsyncData
public static <T,P extends Publisher<T>> BodyInserters.MultipartInserter fromMultipartAsyncData(StringSE name, P publisher, ParameterizedTypeReference<T> typeReference) 要素型のParameterizedTypeReference
を受け入れるfromMultipartAsyncData(String, Publisher, Class)
のバリアント。これにより、一般的な型情報を指定できます。MultipartBodyBuilder
を使用して外部でマルチパートデータを作成し、結果のマップをWebClient
のbodyValue(Object)
ショートカットメソッドに直接渡すこともできます。- パラメーター:
name
- パーツ名publisher
- パーツ値を形成する発行者typeReference
-publisher
に含まれる型- 戻り値:
- さらにパーツを追加できるインサーター
fromDataBuffers
public static <T extends Publisher<DataBuffer>> BodyInserter<T,ReactiveHttpOutputMessage> fromDataBuffers(T publisher) 指定されたPublisher<DataBuffer>
を本文に書き込むための挿入子。- 型パラメーター:
T
- パブリッシャーの型- パラメーター:
publisher
- 書き込むデータバッファパブリッシャー- 戻り値:
- 本文に直接書き込むインサーター
- 関連事項:
fromOutputStream
public static <T extends Publisher<DataBuffer>> BodyInserter<T,ReactiveHttpOutputMessage> fromOutputStream(ConsumerSE<OutputStreamSE> outputStreamConsumer, ExecutorSE executor) OutputStream
に書き込まれたバイトに基づくインサーター。- パラメーター:
outputStreamConsumer
- 出力メッセージに書き込むOutputStream
SE で呼び出されますexecutor
- 別のスレッドでoutputStreamHandler
を呼び出すために使用されます- 戻り値:
- 出力ストリームに書き込まれる内容を書き込むインサータ
- 導入:
- 6.1
- 関連事項:
fromOutputStream
public static <T extends Publisher<DataBuffer>> BodyInserter<T,ReactiveHttpOutputMessage> fromOutputStream(ConsumerSE<OutputStreamSE> outputStreamConsumer, ExecutorSE executor, int chunkSize) OutputStream
に書き込まれたバイトに基づくインサーター。- パラメーター:
outputStreamConsumer
- 出力メッセージに書き込むOutputStream
SE で呼び出されますexecutor
- 別のスレッドでoutputStreamHandler
を呼び出すために使用されますchunkSize
- パブリッシャーによって生成されるバッファの最小サイズ- 戻り値:
- 出力ストリームに書き込まれる内容を書き込むインサータ
- 導入:
- 6.1
- 関連事項:
fromValue(Object)
を推奨