クラス ResponseBodyEmitterReturnValueHandler
java.lang.ObjectSE
org.springframework.web.servlet.mvc.method.annotation.ResponseBodyEmitterReturnValueHandler
- 実装されたすべてのインターフェース:
HandlerMethodReturnValueHandler
public class ResponseBodyEmitterReturnValueHandler
extends ObjectSE
implements HandlerMethodReturnValueHandler
型
ResponseBodyEmitter の戻り値、および ResponseEntity でラップされた同じ型を含む SseEmitter などのサブクラスのハンドラー。5.0 以降、ReactiveAdapterRegistry にアダプターが登録されているリアクティブライブラリのリアクティブ戻り値型もサポートしています。
- 導入:
- 4.2
- 作成者:
- Rossen Stoyanchev
コンストラクターのサマリー
コンストラクターコンストラクター説明ResponseBodyEmitterReturnValueHandler(ListSE<HttpMessageConverter<?>> messageConverters) Accept ヘッダー戦略を使用したReactiveAdapterRegistry、SyncTaskExecutor、ContentNegotiationManagerのデフォルトインスタンスに基づいたリアクティブ型サポートを備えたシンプルなコンストラクター。ResponseBodyEmitterReturnValueHandler(ListSE<HttpMessageConverter<?>> messageConverters, ReactiveAdapterRegistry registry, TaskExecutor executor, ContentNegotiationManager manager) プラグイン可能な「リアクティブ」型のサポートを備えた完全なコンストラクター。メソッドのサマリー
修飾子と型メソッド説明voidhandleReturnValue(ObjectSE returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) 属性をモデルに追加し、ビューを設定するか、ModelAndViewContainer.setRequestHandled(boolean)フラグをtrueに設定して、レスポンスが直接処理されたことを示すことにより、指定された戻り値を処理します。booleansupportsReturnType(MethodParameter returnType) 指定されたメソッドの戻り型がこのハンドラーでサポートされているかどうか。
コンストラクターの詳細
ResponseBodyEmitterReturnValueHandler
Accept ヘッダー戦略を使用したReactiveAdapterRegistry、SyncTaskExecutor、ContentNegotiationManagerのデフォルトインスタンスに基づいたリアクティブ型サポートを備えたシンプルなコンストラクター。ResponseBodyEmitterReturnValueHandler
public ResponseBodyEmitterReturnValueHandler(ListSE<HttpMessageConverter<?>> messageConverters, ReactiveAdapterRegistry registry, TaskExecutor executor, ContentNegotiationManager manager) プラグイン可能な「リアクティブ」型のサポートを備えた完全なコンストラクター。- パラメーター:
messageConverters- 放出されたオブジェクトを書き込むためのコンバーターregistry- リアクティブ戻り値型のサポート用executor- リアクティブ型から放出されたアイテムの I/O 書き込みをブロックするためmanager- ストリーミングメディア型を検出するため- 導入:
- 5.0
メソッドの詳細
supportsReturnType
インターフェースからコピーされた説明:HandlerMethodReturnValueHandler指定されたメソッドの戻り型がこのハンドラーでサポートされているかどうか。- 次で指定:
- インターフェース
HandlerMethodReturnValueHandlerのsupportsReturnType - パラメーター:
returnType- チェックするメソッドの戻り値の型- 戻り値:
- このハンドラーが提供された戻り値の型をサポートする場合、
true。それ以外の場合はfalse
handleReturnValue
public void handleReturnValue(@Nullable ObjectSE returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws ExceptionSE インターフェースからコピーされた説明:HandlerMethodReturnValueHandler属性をモデルに追加し、ビューを設定するか、ModelAndViewContainer.setRequestHandled(boolean)フラグをtrueに設定して、レスポンスが直接処理されたことを示すことにより、指定された戻り値を処理します。- 次で指定:
- インターフェース
HandlerMethodReturnValueHandlerのhandleReturnValue - パラメーター:
returnValue- ハンドラーメソッドから返された値returnType- 戻り値の型。この型は、trueを返さなければならないHandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter)に事前に渡されている必要があります。mavContainer- 現在のリクエストの ModelAndViewContainerwebRequest- 現在のリクエスト- 例外:
ExceptionSE- 戻り値の処理がエラーになる場合