クラス ConvertingEncoderDecoderSupport<T,M>
java.lang.ObjectSE
org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport<T,M>
- 型パラメーター:
T
- 変換される型(エンコーダーの場合)または (デコーダ用)M
- WebSocket メッセージ型 (String
SE またはByteBuffer
SE )
- 既知の直属サブクラス
ConvertingEncoderDecoderSupport.BinaryDecoder
、ConvertingEncoderDecoderSupport.BinaryEncoder
、ConvertingEncoderDecoderSupport.TextDecoder
、ConvertingEncoderDecoderSupport.TextEncoder
標準の
Encoder
EE や Decoder
EE を実装するために使用できる基本クラス。Spring ConversionService
に委譲するエンコードおよびデコードメソッドの実装を提供します。 デフォルトでは、このクラスは active ApplicationContext
に 'webSocketConversionService'
という名前で登録されている ConversionService
を検索します。これは、サーブレットコンテナー環境のクライアントエンドポイントとサーバーエンドポイントの両方で正常に機能します。サーブレットコンテナーで実行されていない場合、サブクラスは getConversionService()
メソッドをオーバーライドして、代替ルックアップ戦略を提供する必要があります。
サブクラスはこのクラスを継承でき、Encoder
EE および Decoder
EE の一方または両方を実装する必要もあります。便宜上、ConvertingEncoderDecoderSupport.BinaryEncoder
、ConvertingEncoderDecoderSupport.BinaryDecoder
、ConvertingEncoderDecoderSupport.TextEncoder
および ConvertingEncoderDecoderSupport.TextDecoder
サブクラスが提供されています。
JSR-356 ではエンコーダー / デコーダーの型による登録のみが許可されているため、このクラスのインスタンスは WebSocket ランタイムによって管理され、Spring Bean として登録する必要はありません。ただし、@Autowire
を介して Spring で管理された依存関係を注入できます。
type
と String
または ByteBuffer
の間で変換するコンバーターを登録する必要があります。
ネストされたクラスのサマリー
修飾子と型クラス説明static class
Spring の変換サービスに委譲するバイナリjakarta.websocket.Encoder
。static class
Spring の変換サービスに委譲するバイナリjakarta.websocket.Encoder
。static class
Spring の変換サービスに委譲するテキストjakarta.websocket.Encoder
。static class
Spring の変換サービスに委譲するテキストjakarta.websocket.Encoder
。コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明メッセージをオブジェクトにデコードします。void
destroy()
エンコーダー / デコーダーを破棄するために呼び出されます。オブジェクトをメッセージにエンコードします。protected ApplicationContext
アクティブなApplicationContext
を返します。protected ConversionService
ConversionService
を取得するために使用される戦略方法。protected TypeDescriptor
WebSocket メッセージ型を返します。protected TypeDescriptor
getType()
変換される型を返します。void
init
(EndpointConfigEE config) エンコーダー / デコーダーを初期化するために呼び出されます。boolean
willDecode
(M bytes) 特定のメッセージをデコードできるかどうかを判断します。
コンストラクターの詳細
ConvertingEncoderDecoderSupport
public ConvertingEncoderDecoderSupport()
メソッドの詳細
init
エンコーダー / デコーダーを初期化するために呼び出されます。destroy
public void destroy()エンコーダー / デコーダーを破棄するために呼び出されます。getConversionService
ConversionService
を取得するために使用される戦略メソッド。デフォルトでは、このメソッドはactive ApplicationContext
で'webSocketConversionService'
という名前の Bean を想定しています。- 戻り値:
ConversionService
(非 null)
getApplicationContext
アクティブなApplicationContext
を返します。デフォルトでは、このメソッドはContextLoader.getCurrentWebApplicationContext()
を介してコンテキストを取得します。これは、通常、サーブレットコンテナー環境でContextLoader
を介してロードされた ApplicationContext を検出します。サーブレットコンテナーで実行されておらず、ContextLoader
を使用していない場合は、このメソッドをオーバーライドする必要があります。- 戻り値:
ApplicationContext
またはnull
getType
変換中の型を返します。デフォルトでは、型はクラスのジェネリクス引数を使用して解決されます。getMessageType
Websocket メッセージ型を返します。デフォルトでは、型はクラスのジェネリクス引数を使用して解決されます。encode
オブジェクトをメッセージにエンコードします。willDecode
特定のメッセージをデコードできるかどうかを判断します。decode
メッセージをオブジェクトにデコードします。