クラス SubscriptionMethodReturnValueHandler
java.lang.ObjectSE
org.springframework.messaging.simp.annotation.support.SubscriptionMethodReturnValueHandler
- 実装されたすべてのインターフェース:
HandlerMethodReturnValueHandler
public class SubscriptionMethodReturnValueHandler
extends ObjectSE
implements HandlerMethodReturnValueHandler
サブスクリプションに直接返信するための
HandlerMethodReturnValueHandler。SubscribeMapping アノテーションが付けられたメソッドでサポートされているため、戻り値はセッションで直接返送されるレスポンスとして扱われます。これにより、クライアントはリクエスト / レスポンスパターンを実装し、それを使用して、たとえば初期化時にデータを取得できます。 メソッドから返された値は変換されて Message に変換され、その後、sessionId、subscriptionId、入力メッセージの宛先で強化されます。
注意 : @SubscribeMapping メソッドからの戻り値を解釈するためのこのデフォルトの動作は、SendTo または SendToUser アノテーションを使用してオーバーライドできます。この場合、メッセージが準備され、代わりにブローカーに送信されます。
- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev, Sebastien Deleuze
コンストラクターのサマリー
コンストラクターコンストラクター説明新しい SubscriptionMethodReturnValueHandler を作成します。メソッドのサマリー
修飾子と型メソッド説明設定済みのヘッダー初期化子を返します。voidhandleReturnValue(ObjectSE returnValue, MethodParameter returnType, Message<?> message) 指定された戻り値を処理します。voidsetHeaderInitializer(MessageHeaderInitializer headerInitializer) MessageHeaderInitializerを構成して、クライアント送信チャネルに送信されるすべてのメッセージのヘッダーに適用します。booleansupportsReturnType(MethodParameter returnType) 指定されたメソッドの戻り型がこのハンドラーでサポートされているかどうか。
コンストラクターの詳細
SubscriptionMethodReturnValueHandler
新しい SubscriptionMethodReturnValueHandler を作成します。- パラメーター:
template- メッセージを送信するためのメッセージングテンプレート、おそらく "clientOutboundChannel" (nullであってはなりません)
メソッドの詳細
setHeaderInitializer
MessageHeaderInitializerを構成して、クライアント送信チャネルに送信されるすべてのメッセージのヘッダーに適用します。デフォルトでは、このプロパティは設定されていません。
getHeaderInitializer
設定済みのヘッダー初期化子を返します。supportsReturnType
インターフェースからコピーされた説明:HandlerMethodReturnValueHandler指定されたメソッドの戻り型がこのハンドラーでサポートされているかどうか。- 次で指定:
- インターフェース
HandlerMethodReturnValueHandlerのsupportsReturnType - パラメーター:
returnType- チェックするメソッドの戻り値の型- 戻り値:
- このハンドラーが提供された戻り値の型をサポートする場合、
true。それ以外の場合はfalse
handleReturnValue
public void handleReturnValue(@Nullable ObjectSE returnValue, MethodParameter returnType, Message<?> message) throws ExceptionSE インターフェースからコピーされた説明:HandlerMethodReturnValueHandler指定された戻り値を処理します。- 次で指定:
- インターフェース
HandlerMethodReturnValueHandlerのhandleReturnValue - パラメーター:
returnValue- ハンドラーメソッドから返された値returnType- 戻り値の型。この型は以前にHandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter)に渡されていて、trueを返している必要があります。message- このメソッドが呼び出される原因となったメッセージ- 例外:
ExceptionSE- 戻り値の処理がエラーになる場合