インターフェース WebSocketMessageBrokerConfigurer

メソッドの詳細

• registerStompEndpoints

  default void registerStompEndpoints(StompEndpointRegistry registry)

  それぞれを特定の URL にマッピングし、（オプションで）SockJS フォールバックオプションを有効にして構成する STOMP エンドポイントを登録します。

• configureWebSocketTransport

  default void configureWebSocketTransport(WebSocketTransportRegistration registry)

  WebSocket クライアントから送受信されるメッセージの処理に関連するオプションを構成します。

• configureClientInboundChannel

  default void configureClientInboundChannel(ChannelRegistration registration)

  WebSocket クライアントからの受信メッセージに使用される MessageChannel を構成します。デフォルトでは、チャネルはサイズ 1 のスレッドプールによってサポートされています。本番で使用するためにスレッドプール設定をカスタマイズすることをお勧めします。

• configureClientOutboundChannel

  default void configureClientOutboundChannel(ChannelRegistration registration)

  WebSocket クライアントへの送信メッセージに使用される MessageChannel を構成します。デフォルトでは、チャネルはサイズ 1 のスレッドプールによってサポートされています。本番で使用するためにスレッドプール設定をカスタマイズすることをお勧めします。

• addArgumentResolvers

  default void addArgumentResolvers(ListSE<HandlerMethodArgumentResolver> argumentResolvers)

  リゾルバーを追加して、カスタムコントローラーメソッドの引数型をサポートします。

  これは、ハンドラーメソッドの引数を解決するための組み込みサポートをオーバーライドしません。引数解決の組み込みサポートをカスタマイズするには、SimpAnnotationMethodMessageHandler を直接構成します。

  パラメーター:

  argumentResolvers - 登録するリゾルバー (最初は空のリスト)

  導入:

  4.1.1

• addReturnValueHandlers

  default void addReturnValueHandlers(ListSE<HandlerMethodReturnValueHandler> returnValueHandlers)

  カスタムコントローラーメソッドの戻り値の型をサポートするハンドラーを追加します。

  このオプションを使用しても、戻り値を処理するための組み込みのサポートは無効になりません。戻り値を処理するための組み込みサポートをカスタマイズするには、SimpAnnotationMethodMessageHandler を直接構成します。

  パラメーター:

  returnValueHandlers - 登録するハンドラー (最初は空のリスト)

  導入:

  4.1.1

• configureMessageConverters

  default boolean configureMessageConverters(ListSE<MessageConverter> messageConverters)

  アノテーション付きメソッドでメッセージのペイロードを抽出するとき、およびメッセージを送信するとき（「ブローカー」SimpMessagingTemplate 経由など）に使用するメッセージコンバーターを構成します。

  最初は空の提供されたリストを使用してメッセージコンバーターを追加し、ブール値の戻り値を使用してデフォルトのメッセージも追加するかどうかを決定できます。

  パラメーター:

  messageConverters - 構成するコンバーター (最初は空のリスト)

  戻り値:

  デフォルトのコンバーターも追加するかどうか

• configureMessageBroker

  default void configureMessageBroker(MessageBrokerRegistry registry)

  メッセージブローカーオプションを設定します。

• getPhase

  @Nullable default IntegerSE getPhase()

  SmartLifecycle 型の WebSocket メッセージ処理 Bean が実行される phase を返します。

  デフォルトの実装は null を返し、他の設定者が決定できるようにします。コンフィギュラーが値を返すとすぐに、その値が使用されます。コンフィギュラーが値を返さない場合は、デフォルトで SmartLifecycle.DEFAULT_PHASE が使用されます。

  Spring Boot アプリケーションで Web サーバーより前にコンポーネントが確実に開始されるようにするために、0 などのフェーズ値を使用することをお勧めします。6.2.0 では、使用されるデフォルトは 0 に変更されます。

  導入:

  6.1.4

  関連事項:

  • SmartLifecycle