Tomcat WebSocket 支持

WebSocket 支持簡介

Tomcat 支持由 RFC 6455 所定義的 WebSocket。

應用開發

Tomcat 實現由 JSR-356 定義的 Java WebSocket 1.1 API。

關于 WebSocket API 的使用方法，可查看相關范例，既需要查看客戶端 HTML 代碼，也需要查看服務器代碼。

生產用途

雖然 WebSocket 實現可以和任何 HTTP 連接器一起使用，但并不建議和 BIO HTTP 連接器一起使用，因為 WebSocket 典型用途（大量連接很多時候都是空閑的）并不是很適合 HTTP BIO 連接器，因為該連接器需要不管連接是否空閑，每個連接都應該分配一個線程。

目前，已有報告（56304）發現，Linux 會用大量時間來報告刪除的連接。當利用 BIO HTTP 連接器使用 WebSocket 時，當在這段時間內寫入時，就容易產生線程阻塞。這似乎不是一種理想的解決方案。使用內核網絡參數 /proc/sys/net/ipv4/tcp_retries2，可以減少報道刪除的連接所花費的時間。或者可以選擇另一種 HTTP 連接器，因為它們使用的是非阻塞 IO，從而能讓 Tomcat 實現自己的超時機制來解決這些問題。

Tomcat WebSocket 特定配置

Tomcat 為 WebSocket 提供了一些 Tomcat 專有配置選項。這些配置將來有望能進入 WebSocket 正式規范中。

以阻塞模式發送 WebSocket 消息所用的寫入超時默認值為 20000 毫秒（20 秒）。通過設定連接到 WebSocket 會話的用戶屬性集合中的 org.apache.tomcat.websocket.BLOCKING_SEND_TIMEOUT 屬性，我們可以修改這個寫入超時屬性值。該屬性值類型應該為 Long，以毫秒表示所用的超時時間，-1 表示超時無限。

如果應用沒有為傳入的二進制消息定義 MessageHandler.Partial，那么必須先對任何傳入的二進制消息進行緩存，繼而可以通過調用一個已注冊專用于處理二進制消息的 MessageHandler.Whole 來傳遞整個消息。默認用于二進制消息的緩存容量是 8192 字節。在應用中，將servlet 上下文初始參數 org.apache.tomcat.websocket.binaryBufferSize 設置為期望的字節值，就能修改這個緩存容量。

如果應用沒有為傳入的文本消息定義 MessageHandler.Partial，那么必須先對任何傳入的文本消息進行緩存，繼而可以通過調用一個已注冊專用于處理文本消息的 MessageHandler.Whole 來傳遞整個消息。默認用于文本消息的緩存容量是 8192 字節。在應用中，將servlet 上下文初始參數 org.apache.tomcat.websocket.textBufferSize 設置為期望的字節值，就能修改這個緩存容量。

Java WebSocket 規范 1.0 并不允許第一個服務端點開始 WebSocket 握手之后進行程序性部署。默認情況下，Tomcat 繼續允許額外的程序性部署。這一行為是通過 servlet 上下文初始化參數 org.apache.tomcat.websocket.noAddAfterHandshake 來控制的。將系統屬性 org.apache.tomcat.websocket.STRICT_SPEC_COMPLIANCE 變為 true，可以改變默認值，但是 servlet 上下文中的顯式設置卻總是優先的。

Java WebSocket 規范 1.0 要求，異步寫操作的回調所在的線程應不同于初始化寫操作的線程。因為容器線程池并未通過 Servlet API 暴露出來，所以 WebSocket 實現必須提供自己的線程池。這種線程池通過下列 Servlet 上下文初始化參數來控制：

• org.apache.tomcat.websocket.executorCoreSize：executor 線程池的核心容量大小。如果不設置，則采用默認值 0。注意，executor 線程池最大允許容量被硬編至 Integer.MAX_VALUE，實際上可以認為該值是無限的。
• org.apache.tomcat.websocket.executorKeepAliveTimeSeconds：在終止前，空閑線程在 executor 線程池中留存的最長時間。如未指定，則采用默認的 60 秒。
• 在使用 WebSocket 客戶端來連接服務端點時，建立該連接的 IO 超時是通過提供的 javax.websocket.ClientEndpointConfig 的 userProperties 來控制的。該屬性是 org.apache.tomcat.websocket.IO_TIMEOUT_MS，是以字符串形式表示的超時時間（以毫秒計），默認為 5000（5 秒）。

在使用 WebSocket 客戶端來連接安全的服務端點時，客戶端 SSL 配置是通過提供的 javax.websocket.ClientEndpointConfig 的 userProperties 來控制的。提供以下用戶屬性：

• org.apache.tomcat.websocket.SSL_CONTEXT
• org.apache.tomcat.websocket.SSL_PROTOCOLS

• org.apache.tomcat.websocket.SSL_TRUSTSTORE

• org.apache.tomcat.websocket.SSL_TRUSTSTORE_PWD

默認的信任存儲密碼（truststore password）為：changeit。

如果設置了 org.apache.tomcat.websocket.SSL_CONTEXT 屬性，則將忽略這兩個屬性：org.apache.tomcat.websocket.SSL_TRUSTSTORE 和 org.apache.tomcat.websocket.SSL_TRUSTSTORE_PWD。