すべてのプロパティ

spring_boot_starter_websocket が読むすべてのプロパティです。クライアントごとの設定は spring.websocket.client.config.<name>.* (または default) の下に、すべてのクライアントに共通する 2 つのメッセージサイズの制限があります。サーバーのエンドポイントの制限は Web スターターの server.websocket.* のキーで、最後に列挙しています。スターターのメタデータ (lib/spring_gen/spring_metadata.json) にも同じ 11 個のクライアントのキーが列挙されています。

使う理由

クライアントがどれだけ早く再接続するか、ハンドシェイクをどれだけ待つか、メッセージがどれだけ大きくてよいかは、ネットワークとサーバーによって決まり、それらは環境ごとに異なります。プロパティを使えば、ビルドなしでそれらを変えられます。

例

# lib/resources/application.yml
chat:
  url: wss://chat.neon.books/ws

spring:
  websocket:
    client:
      max-text-message-size: 1MB
      max-binary-message-size: -1
      config:
        default:
          connect-timeout: 5s
          reconnect:
            delay: 1s
            multiplier: 2
            max-delay: 30s
        chat:
          url: ${chat.url}
          reconnect:
            delay: 500ms
            jitter: 100ms
            max-retries: 10
        feed:
          default-request-headers:
            X-Api-Key: ${FEED_KEY}
          reconnect:
            enabled: false

同じ内容を .properties で:

# lib/resources/application.properties
chat.url=wss://chat.neon.books/ws
spring.websocket.client.max-text-message-size=1MB
spring.websocket.client.max-binary-message-size=-1
spring.websocket.client.config.default.connect-timeout=5s
spring.websocket.client.config.default.reconnect.delay=1s
spring.websocket.client.config.default.reconnect.multiplier=2
spring.websocket.client.config.default.reconnect.max-delay=30s
spring.websocket.client.config.chat.url=${chat.url}
spring.websocket.client.config.chat.reconnect.delay=500ms
spring.websocket.client.config.chat.reconnect.jitter=100ms
spring.websocket.client.config.chat.reconnect.max-retries=10
spring.websocket.client.config.feed.default-request-headers.X-Api-Key=${FEED_KEY}
spring.websocket.client.config.feed.reconnect.enabled=false

クライアントごと: spring.websocket.client.config

各キーは spring.websocket.client.config.<name>.<key> です。クライアントが設定しないものは default にフォールバックします。

キー 型 デフォルト 意味
url String なし @WebSocketClient(url:) が設定されていないときのアドレス。ws:// または wss://。${...} のプレースホルダーも可。
connect-timeout Duration 10s ハンドシェイクにかけてよい最長時間。
default-request-headers.<Name> List<String> なし API キーのような、ハンドシェイクで送るヘッダー (カンマ区切りのリストかインデックス付きのリストで複数の値)。ブラウザーではできない。クライアントのヘッダーは同じ名前の default のものを置き換える。
reconnect.enabled bool true 誰かがメッセージを購読している間、再接続する。false では、失われた接続がメッセージのストリームを終わらせる。true / false、on / off、yes / no、1 / 0 を受け取る。
reconnect.delay Duration 1s 最初の待機。負でない。
reconnect.multiplier double 2 その後の各待機に掛ける値。固定の遅延には 1。それより小さくはできない。
reconnect.max-delay Duration 30s 最長の待機。正の値。接続が安定しているとみなされるために開いていなければならない時間でもある。
reconnect.jitter Duration なし 加減するランダムな部分。遅延と同じく伸びる。負でない。
reconnect.max-retries int 上限なし あきらめるまでに連続して試みる回数。負でない。
max-text-message-size DataSize spring.websocket.client.max-text-message-size このクライアントが読む最大のテキストメッセージ (UTF-8 のバイト数)。これより大きいと接続を 1009 で閉じる。上限なしは -1。
max-binary-message-size DataSize spring.websocket.client.max-binary-message-size バイナリメッセージについて同じ。
phoenix.heartbeat-interval Duration 30s Phoenix Channels クライアントの、二つのハートビートの間の時間。0 では送らない。
phoenix.push-timeout Duration 10s Phoenix のチャンネルの参加、プッシュ、離脱が応答を待つ最長時間。
phoenix.vsn String 2.0.0 Phoenix のワイヤーフォーマットのバージョン。2.0.0 または 1.0.0。@PhoenixChannel(vsn:) が優先される。

誤った値は、プロパティを示して起動を失敗させます。

すべてのクライアント: spring.websocket.client

キー 型 デフォルト 意味
spring.websocket.client.max-text-message-size DataSize 8KB クライアントが読む最大のテキストメッセージ (UTF-8 のバイト数。Tomcat は文字数で数える)。これより大きいと接続を 1009 (メッセージが大きすぎる) で閉じる。上限なしは -1。
spring.websocket.client.max-binary-message-size DataSize 8KB バイナリメッセージについて同じ。上限なしは -1。

これらは、config.<name> にも config.default にも独自の制限を設定していないすべてのクライアントに効きます。ブラウザーのトランスポートには制限がありません。

値の書き方

サーバーのエンドポイント: server.websocket (Web スターター)

サーバーのセッションの制限は spring_boot_starter_web のものです。

キー 型 デフォルト 意味
server.websocket.max-text-message-size DataSize、または -1 8KB セッションが読む最大のテキストメッセージ (UTF-8 のバイト数)。これより大きいとセッションを 1009 で閉じる。
server.websocket.max-binary-message-size DataSize、または -1 8KB バイナリメッセージについて同じ。
server.websocket.send-buffer-size-limit DataSize、または -1 512KB 遅いクライアントへの送信待ちとして溜められる量。超えると接続を 4500 で切る。
server.websocket.send-time-limit Duration、または -1 10s 送ったものが出ていくまでにかかってよい時間。超えると接続を 4500 で切る。

Spring (Java) との対応

Spring には WebSocket クライアントのプロパティがありません。spring.websocket.client.* はこのプロジェクト独自のものです。reconnect.* の名前は Spring 7 の RetryPolicy に従います。Spring はメッセージの制限をコードで設定します (WebSocketContainer、ServletServerContainerFactoryBean)。

関連項目