インターフェース ServerResponse.BodyBuilder
- すべてのスーパーインターフェース:
ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>
- 含まれているインターフェース:
- ServerResponse
public static interface ServerResponse.BodyBuilder
extends ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>
レスポンスに本文を追加するビルダーを定義します。
メソッドのサマリー
修飾子と型メソッド説明reactor.core.publisher.Mono<ServerResponse>reactor.core.publisher.Mono<ServerResponse>body(ObjectSE producer, ParameterizedTypeReference<?> elementTypeRef) ReactiveAdapterRegistryを介してPublisherに解決できる任意のプロデューサーを使用できるようにするbody(Publisher, ParameterizedTypeReference)のバリアント。reactor.core.publisher.Mono<ServerResponse>body(BodyInserter<?, ? super ServerHttpResponse> inserter) レスポンスの本文を指定のBodyInserterに設定して返します。<T,P extends Publisher<T>>
reactor.core.publisher.Mono<ServerResponse>与えられたPublisherから本体を設定します。<T,P extends Publisher<T>>
reactor.core.publisher.Mono<ServerResponse>body(P publisher, ParameterizedTypeReference<T> elementTypeRef) reactor.core.publisher.Mono<ServerResponse>レスポンスの本文を指定のObjectに設定して返します。contentLength(long contentLength) Content-Lengthヘッダーで指定されているように、本文の長さをバイト単位で設定します。contentType(MediaType contentType) Content-Typeヘッダーで指定されているように、本文のメディア型を設定します。本体の直列化方法をカスタマイズするには、Jackson2CodecSupport.JSON_VIEW_HINTのような直列化のヒントを追加します。hints(ConsumerSE<MapSE<StringSE, ObjectSE>> hintsConsumer) 指定されたコンシューマーで直列化のヒントをカスタマイズします。reactor.core.publisher.Mono<ServerResponse>指定されたmodelAttributesを使用して、指定されたnameでテンプレートをレンダリングします。reactor.core.publisher.Mono<ServerResponse>指定されたmodelを使用して、指定されたnameでテンプレートをレンダリングします。reactor.core.publisher.Mono<ServerResponse>使用すべきではありません。インターフェース org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder から継承されたメソッド
allow, allow, build, build, build, cacheControl, cookie, cookies, eTag, header, headers, lastModified, lastModified, location, varyBy
メソッドの詳細
contentLength
Content-Lengthヘッダーで指定されているように、本文の長さをバイト単位で設定します。- パラメーター:
contentLength- コンテンツの長さ- 戻り値:
- このビルダー
- 関連事項:
contentType
Content-Typeヘッダーで指定されているように、本文のメディア型を設定します。- パラメーター:
contentType- コンテンツ型- 戻り値:
- このビルダー
- 関連事項:
hint
本体の直列化方法をカスタマイズするには、Jackson2CodecSupport.JSON_VIEW_HINTのような直列化のヒントを追加します。- パラメーター:
key- ヒントキーvalue- ヒント値
hints
指定されたコンシューマーで直列化のヒントをカスタマイズします。- パラメーター:
hintsConsumer- ヒントを消費する関数- 戻り値:
- このビルダー
- 導入:
- 5.1.6
bodyValue
- パラメーター:
body- レスポンスの本文- 戻り値:
- 構築されたレスポンス
- 例外:
IllegalArgumentExceptionSE-bodyがPublisherまたはReactiveAdapterRegistryに知られているプロデューサーである場合- 導入:
- 5.2
body
<T,P extends Publisher<T>> reactor.core.publisher.Mono<ServerResponse> body(P publisher, ClassSE<T> elementClass) - 型パラメーター:
T- パブリッシャーに含まれる要素の型P-Publisherの型- パラメーター:
publisher- レスポンスに書き込むPublisherelementClass- 公開された要素の型- 戻り値:
- 構築されたレスポンス
body
<T,P extends Publisher<T>> reactor.core.publisher.Mono<ServerResponse> body(P publisher, ParameterizedTypeReference<T> elementTypeRef) - 型パラメーター:
T- パブリッシャーに含まれる要素の型P-Publisherの型- パラメーター:
publisher- レスポンスを書き込むために使用するPublisherelementTypeRef- 生成される要素の型- 戻り値:
- 構築されたレスポンス
body
- パラメーター:
producer- リクエストに書き込むプロデューサーelementClass- 生成される要素の型- 戻り値:
- 構築されたレスポンス
- 導入:
- 5.2
body
reactor.core.publisher.Mono<ServerResponse> body(ObjectSE producer, ParameterizedTypeReference<?> elementTypeRef) ReactiveAdapterRegistryを介してPublisherに解決できる任意のプロデューサーを使用できるようにするbody(Publisher, ParameterizedTypeReference)のバリアント。- パラメーター:
producer- レスポンスに書き込むプロデューサーelementTypeRef- 生成される要素の型- 戻り値:
- 構築されたレスポンス
- 導入:
- 5.2
body
reactor.core.publisher.Mono<ServerResponse> body(BodyInserter<?, ? super ServerHttpResponse> inserter) レスポンスの本文を指定のBodyInserterに設定して返します。- パラメーター:
inserter- レスポンスに書き込むBodyInserter- 戻り値:
- 構築されたレスポンス
syncBody
使用すべきではありません。Spring Framework 5.2 現在、bodyValue(Object)を推奨レスポンスの本文を指定されたObjectに設定して返します。5.2 以降、このメソッドはbodyValue(Object)に委譲されます。render
指定されたmodelAttributesを使用して、指定されたnameでテンプレートをレンダリングします。モデル属性は、生成された名前でマップされます。注: この方法を使用しても、実際の規則名を正しく判別できないため、空の
CollectionsSE はモデルに追加されません。- パラメーター:
name- レンダリングされるテンプレートの名前modelAttributes- テンプレートをレンダリングするために使用された modelAttributes- 戻り値:
- 構築されたレスポンス
render
指定されたmodelを使用して、指定されたnameでテンプレートをレンダリングします。- パラメーター:
name- レンダリングされるテンプレートの名前model- テンプレートのレンダリングに使用されるモデル- 戻り値:
- 構築されたレスポンス
bodyValue(Object)を推奨