
# Spring との違い

`spring_boot_starter_websocket` は、サーバーでは Spring の WebSocket の API (`WebSocketHandler`、`WebSocketConfigurer`、`HandshakeInterceptor`、オリジンのチェック) に、アノテーション付きのエンドポイントでは Jakarta の名前に従っています。そのクライアントに対応するものは Spring にはありません。このページでは違いを列挙します。

## 使う理由

Spring の WebSocket クライアントは命令的で、再接続しません。モバイルのネットワーク上の Dart アプリには、再接続するクライアントが必要です。サーバーでは、Dart にはサーブレットコンテナがないため、エンドポイントは Web スターターのルーターに置かれ、いくつかの動作はデフォルトでより安全になっています。

## 例

```dart
@WebSocketClient('chat', url: r'${chat.url}')
abstract interface class ChatSocket {
  @OnMessage()
  Stream<ChatMessage> messages();
}
```

```java
WebSocketClient client = new StandardWebSocketClient();
client.execute(new TextWebSocketHandler() { ... }, "wss://chat.neon.books/ws");
```

## クライアント

| Spring | ここでは |
|---|---|
| 宣言的なクライアントはない。命令的な `WebSocketClient` か STOMP | `@FeignClient` のスタイルの、型付きのストリームを持つ `@WebSocketClient` インターフェース |
| `WebSocketConnectionManager` は再接続しない | 誰かが購読している間は再接続する (`reconnect.*`。Spring 7 の `RetryPolicy` にちなんだ名前) |
| `WebSocketContainer` にコードで設定する制限 | `spring.websocket.client.max-text-message-size` と `max-binary-message-size`。テキストの制限は UTF-8 のバイト数で数える (Tomcat は文字数で数える) |
| クライアントのプロパティはない | `spring.websocket.client.config.*` |
| ハンドシェイクのインターセプターの Bean はない | `WebSocketHandshakeInterceptor` は (再) 接続のたびに実行される |
| permessage-deflate のような拡張 | 何も提示しない |

## サーバー

| Spring | ここでは |
|---|---|
| 独自のアノテーション付きエンドポイントはない。`ServerEndpointExporter` を通した Jakarta の `@ServerEndpoint`、接続ごとに一つのインスタンス | コンストラクター注入を使うシングルトンの Bean の `@WebSocketEndpoint`。`@PathParam` の代わりに `@PathVariable` |
| `@EnableWebSocket` | 不要 |
| ハンドラーのメソッドのエラーは接続を 1011 で閉じる | `handleTransportError` / `@OnError` に渡され、接続は開いたまま (`@OnError` がなければ 1011 で閉じる) |
| `setAllowedOrigins`、`setAllowedOriginPatterns`、`setSupportedProtocols` は置き換える | それ以前に設定した値に追加する |
| どの登録にも `HandshakeInterceptor` | configurer のハンドラーにだけ。`@WebSocketEndpoint` には適用されない (Web のフィルターは両方をカバーする) |
| URL でない `Origin`: 500 | 403。1024 文字を超える `Origin` も 403 |
| サーバー自身のオリジンのホストは大文字小文字を区別して比較する | 区別しない |
| セッションのレジストリはない | `broadcast` を持つ `WebSocketSessionRegistry` |
| 本物のサーバーでのテスト | メモリ上の `MockMvc.webSocket` と、クライアントのための `MockWebSocketTransport` |

## まだ対応していないもの

- STOMP と SockJS。
- 拡張 (permessage-deflate)。
- `@WebSocketEndpoint` での `HandshakeInterceptor`。

## 関連項目

- [概要](index.md)
- [すべてのプロパティ](properties.md)
- [ハンドラー、オリジン、ブロードキャスト](handlers.md)
