インターフェース WebSocketMessageBrokerConfigurer
public interface WebSocketMessageBrokerConfigurer
WebSocket クライアントからのシンプルなメッセージングプロトコル(STOMP など)でメッセージ処理を構成するためのメソッドを定義します。
通常、@EnableWebSocketMessageBroker
を介して提供される構成をカスタマイズするために使用されます。
- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev
メソッドのサマリー
修飾子と型メソッド説明default void
addArgumentResolvers
(ListSE<HandlerMethodArgumentResolver> argumentResolvers) リゾルバーを追加して、カスタムコントローラーメソッドの引数型をサポートします。default void
addReturnValueHandlers
(ListSE<HandlerMethodReturnValueHandler> returnValueHandlers) カスタムコントローラーメソッドの戻り値の型をサポートするハンドラーを追加します。default void
configureClientInboundChannel
(ChannelRegistration registration) WebSocket クライアントからの受信メッセージに使用されるMessageChannel
を構成します。default void
configureClientOutboundChannel
(ChannelRegistration registration) WebSocket クライアントへの送信メッセージに使用されるMessageChannel
を構成します。default void
configureMessageBroker
(MessageBrokerRegistry registry) メッセージブローカーオプションを設定します。default boolean
configureMessageConverters
(ListSE<MessageConverter> messageConverters) アノテーション付きメソッドでメッセージのペイロードを抽出するとき、およびメッセージを送信するときに使用するメッセージコンバーターを構成します(例:default void
WebSocket クライアントから送受信されるメッセージの処理に関連するオプションを構成します。default void
registerStompEndpoints
(StompEndpointRegistry registry) それぞれを特定の URL にマッピングし、(オプションで)SockJS フォールバックオプションを有効にして構成する STOMP エンドポイントを登録します。
メソッドの詳細
registerStompEndpoints
それぞれを特定の URL にマッピングし、(オプションで)SockJS フォールバックオプションを有効にして構成する STOMP エンドポイントを登録します。configureWebSocketTransport
WebSocket クライアントから送受信されるメッセージの処理に関連するオプションを構成します。configureClientInboundChannel
WebSocket クライアントからの受信メッセージに使用されるMessageChannel
を構成します。デフォルトでは、チャネルはサイズ 1 のスレッドプールによってサポートされています。本番で使用するためにスレッドプール設定をカスタマイズすることをお勧めします。configureClientOutboundChannel
WebSocket クライアントへの送信メッセージに使用されるMessageChannel
を構成します。デフォルトでは、チャネルはサイズ 1 のスレッドプールによってサポートされています。本番で使用するためにスレッドプール設定をカスタマイズすることをお勧めします。addArgumentResolvers
リゾルバーを追加して、カスタムコントローラーメソッドの引数型をサポートします。これは、ハンドラーメソッドの引数を解決するための組み込みサポートをオーバーライドしません。引数解決の組み込みサポートをカスタマイズするには、
SimpAnnotationMethodMessageHandler
を直接構成します。- パラメーター:
argumentResolvers
- 登録するリゾルバー (最初は空のリスト)- 導入:
- 4.1.1
addReturnValueHandlers
カスタムコントローラーメソッドの戻り値の型をサポートするハンドラーを追加します。このオプションを使用しても、戻り値を処理するための組み込みのサポートは無効になりません。戻り値を処理するための組み込みサポートをカスタマイズするには、
SimpAnnotationMethodMessageHandler
を直接構成します。- パラメーター:
returnValueHandlers
- 登録するハンドラー (最初は空のリスト)- 導入:
- 4.1.1
configureMessageConverters
アノテーション付きメソッドでメッセージのペイロードを抽出するとき、およびメッセージを送信するとき(「ブローカー」SimpMessagingTemplate 経由など)に使用するメッセージコンバーターを構成します。最初は空の提供されたリストを使用してメッセージコンバーターを追加し、ブール値の戻り値を使用してデフォルトのメッセージも追加するかどうかを決定できます。
- パラメーター:
messageConverters
- 構成するコンバーター (最初は空のリスト)- 戻り値:
- デフォルトのコンバーターも追加するかどうか
configureMessageBroker
メッセージブローカーオプションを設定します。