アノテーションインターフェース SubscribeMapping
@TargetSE(METHODSE)
@RetentionSE(RUNTIMESE)
@DocumentedSE
@Reflective(MessageMappingReflectiveProcessor.class)
public @interface SubscribeMapping
サブスクリプションの宛先に基づいて、サブスクリプションメッセージを特定のハンドラーメソッドにマッピングするためのアノテーション。STOMP over WebSocket のみでサポートされます(STOMP SUBSCRIBE フレームなど)。
これは、型レベルの @MessageMapping
と組み合わせることができるメソッドレベルのアノテーションです。
@MessageMapping
と同じメソッド引数をサポートします。ただし、サブスクリプションメッセージには通常、本文はありません。
戻り値も @MessageMapping
の場合と同じルールに従いますが、メソッドに SendTo
または SendToUser
のアノテーションが付けられていない場合、メッセージは接続されたユーザーに直接送信され、メッセージブローカーを通過しません。これは、リクエスト / 応答パターンの実装に役立ちます。
注 : コントローラーインターフェース(AOP プロキシなど)を使用する場合、@MessageMapping
や @SubscribeMapping
などのすべてのマッピングアノテーションを、実装クラスではなくコントローラーインターフェースに一貫して配置するようにしてください。
- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev
- 関連事項:
オプション要素のサマリー
要素の詳細
value
StringSE[] valueこのアノテーションによって表される宛先ベースのマッピング。これは STOMP メッセージの宛先です(例:
"/positions"
)。Ant スタイルのパスパターン("/price.stock.*"
など)およびパステンプレート変数("/price.stock.{ticker}"
など)もサポートされています。- デフォルト:
- {}