public class WebSocketHandlerAdapter extends ObjectSE implements HandlerAdapter, Ordered
DispatcherHandler
が WebSocketHandler
型のハンドラーをサポートできるようにする HandlerAdapter
。このようなハンドラーは SimpleUrlHandlerMapping
を介して URL パターンにマップされます。 リクエストは、WebSocketService
(デフォルトでは HandshakeWebSocketService
)に委譲することによって処理されます。HandshakeWebSocketService
は、WebSocket ハンドシェイクリクエストパラメーターをチェックし、WebSocket インタラクションにアップグレードし、WebSocketHandler
を使用して処理します。
5.3 の時点で、@EnableWebFlux
を介してインポートされた WebFlux Java 構成には、このアダプターの宣言が含まれているため、アプリケーション構成に存在する必要はありません。
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
コンストラクターと説明 |
---|
WebSocketHandlerAdapter() HandshakeWebSocketService を作成して使用するデフォルトのコンストラクター。 |
WebSocketHandlerAdapter(WebSocketService webSocketService) WebSocketService を使用する代替コンストラクター。 |
修飾子と型 | メソッドと説明 |
---|---|
int | getOrder() このインスタンスの configured オーダーを返します。 |
WebSocketService | getWebSocketService() リクエストを処理するために構成済みの WebSocketService を返します。 |
reactor.core.publisher.Mono<HandlerResult> | handle(ServerWebExchange exchange, ObjectSE handler) 指定されたハンドラーでリクエストを処理します。 |
void | setOrder(int order) このアダプターのオーダー値を設定します。 |
boolean | supports(ObjectSE handler) この HandlerAdapter が指定された handler をサポートするかどうか。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
public WebSocketHandlerAdapter()
HandshakeWebSocketService
を作成して使用するデフォルトのコンストラクター。public WebSocketHandlerAdapter(WebSocketService webSocketService)
WebSocketService
を使用する代替コンストラクター。public void setOrder(int order)
デフォルトでは、これは 2 に設定されています。
order
- 設定する値 public int getOrder()
configured
オーダーを返します。Ordered
の getOrder
Ordered.HIGHEST_PRECEDENCE
, Ordered.LOWEST_PRECEDENCE
public WebSocketService getWebSocketService()
WebSocketService
を返します。public boolean supports(ObjectSE handler)
HandlerAdapter
HandlerAdapter
が指定された handler
をサポートするかどうか。HandlerAdapter
の supports
handler
- チェックするハンドラーオブジェクト public reactor.core.publisher.Mono<HandlerResult> handle(ServerWebExchange exchange, ObjectSE handler)
HandlerAdapter
実装では、ハンドラーの呼び出しに起因する例外を順番に処理し、必要に応じてエラーレスポンスを表す代替結果を返すことが推奨されます。
さらに、非同期 HandlerResult
は結果処理中に後でエラーを生成する可能性があるため、実装も HandlerResult
で set an exception handler
に奨励され、結果処理後にも適用される場合があります。
HandlerAdapter
の handle
exchange
- 現在のサーバー交換 handler
- HandlerAdapter.supports(Object)
を介して事前にチェックされている必要がある選択されたハンドラー HandlerResult
を発行する Mono
またはリクエストが完全に処理され、さらに処理する必要がない場合はなし。