Spring Framework 參考文檔（WebSocket API）
WebSocket API
Spring Framework提供了一個WebSocket API，你能夠使用它來編寫處理WebSocket消息的客戶端和服務器端應用程序。html
WebSocketHandler
建立WebSocket服務器就像實現WebSocketHandler同樣簡單，或者更多是擴展TextWebSocketHandler或BinaryWebSocketHandler，下面的示例使用TextWebSocketHandler：前端
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.TextMessage;
public class MyHandler extends TextWebSocketHandler {
@Override
public void handleTextMessage(WebSocketSession session, TextMessage message) {
// ...
}
}
有專門的WebSocket Java配置和XML命名空間支持將前面的WebSocket處理程序映射到特定的URL，以下面的示例所示：java
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
registry.addHandler(myHandler(), "/myHandler");
}
@Bean
public WebSocketHandler myHandler() {
return new MyHandler();
}
}
下面的示例顯示了與前面示例等價的XML配置：git
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:websocket="http://www.springframework.org/schema/websocket"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/websocket
http://www.springframework.org/schema/websocket/spring-websocket.xsd">
<websocket:handlers>
<websocket:mapping path="/myHandler" handler="myHandler"/>
</websocket:handlers>
<bean id="myHandler" class="org.springframework.samples.MyHandler"/>
</beans>
本示例用於Spring MVC應用程序，而且應該包含在DispatcherServlet的配置中，然而，Spring的WebSocket支持不依賴於Spring MVC，在WebSocketHttpRequestHandler的幫助下，將WebSocketHandler集成到其餘http服務環境中相對簡單。github
WebSocket握手
定製初始的HTTP WebSocket握手請求的最簡單方法是經過HandshakeInterceptor，它公開握手以前和以後的方法，你能夠使用這樣的攔截器來阻止握手或使WebSocketSession的任何屬性有效，下面的示例使用內置的攔截器將HTTP會話屬性傳遞給WebSocket會話：web
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
registry.addHandler(new MyHandler(), "/myHandler")
.addInterceptors(new HttpSessionHandshakeInterceptor());
}
}
下面的示例顯示了與前面示例等價的XML配置：spring
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:websocket="http://www.springframework.org/schema/websocket"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/websocket
http://www.springframework.org/schema/websocket/spring-websocket.xsd">
<websocket:handlers>
<websocket:mapping path="/myHandler" handler="myHandler"/>
<websocket:handshake-interceptors>
<bean class="org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor"/>
</websocket:handshake-interceptors>
</websocket:handlers>
<bean id="myHandler" class="org.springframework.samples.MyHandler"/>
</beans>
更高級的選項是擴展DefaultHandshakeHandler，該處理程序執行WebSocket握手的步驟，包括驗證客戶端源、協商子協議和其餘細節。若是應用程序須要配置定製的RequestUpgradeStrategy以適應WebSocket服務器引擎和還不支持的版本，那麼它可能還須要使用這個選項（有關此主題的更多信息，請參閱部署），Java配置和XML命名空間都使配置自定義HandshakeHandler成爲可能。segmentfault
Spring提供了一個WebSocketHandlerDecorator基類，你能夠使用它來修飾WebSocketHandler具備額外的行爲。默認狀況下，在使用WebSocket Java配置或XML命名空間時，會提供並添加日誌記錄和異常處理實現。ExceptionWebSocketHandlerDecorator捕獲來自任何WebSocketHandler的全部未捕獲的異常，並以狀態1011關閉WebSocket會話，這表示服務器錯誤。
部署
Spring WebSocket API很容易集成到Spring MVC應用程序中，其中DispatcherServlet同時服務於HTTP WebSocket握手和其餘HTTP請求，經過調用WebSocketHttpRequestHandler，很容易將其集成到其餘HTTP處理場景中。這很方便，也很容易理解，可是，對於JSR-356運行時，須要特別考慮。api
Java WebSocket API（JSR-356）提供了兩種部署機制，第一個涉及Servlet容器類路徑掃描（Servlet 3特性）在啓動時，另外一個是Servlet容器初始化時使用的註冊API。這兩種機制都沒法爲全部HTTP處理使用單個「前端控制器」 - 包括WebSocket握手和全部其餘HTTP請求 - 好比Spring MVC的DispatcherServlet。瀏覽器
這是JSR-356的一個重要限制，Spring的WebSocket支持地址具備特定於服務器的RequestUpgradeStrategy實現，即便在JSR-356運行時運行也是如此。對於Tomcat、Jetty、GlassFish、WebLogic、WebSphere和Undertow（和WildFly），目前存在這樣的策略。
已經建立了克服Java WebSocket API中上述限制的請求，能夠在 eclipse-ee4j/websocket-api#211中進行跟蹤。Tomcat、Undertow和WebSphere提供了它們本身的API選項，能夠實現這一點，Jetty也是如此，咱們但願更多的服務器也能這樣作。
第二個須要考慮的問題是，具備JSR-356支持的Servlet容器預計將執行ServletContainerInitializer（SCI）掃描，這可能會減慢應用程序的啓動速度 — 在某些狀況下，會顯著下降啓動速度。若是在升級到支持JSR-356的Servlet容器版本後觀察到重大影響，經過使用web.xml中的<absolute-ordering />元素，應該能夠選擇性地啓用或禁用web片斷（和SCI掃描），以下例所示：
<web-app xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
version="3.0">
<absolute-ordering/>
</web-app>
而後能夠根據名稱選擇性地啓用web片斷，好比Spring本身的SpringServletContainerInitializer，它爲Servlet 3 Java初始化API提供支持，下面的示例展現瞭如何作到這一點：
<web-app xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
version="3.0">
<absolute-ordering>
<name>spring_web</name>
</absolute-ordering>
</web-app>
服務器配置
每一個基礎WebSocket引擎都公開了控制運行時特性的配置屬性，好比消息緩衝區大小、空閒超時等等。
對於Tomcat、WildFly和GlassFish，你能夠將ServletServerContainerFactoryBean添加到WebSocket Java配置中，以下面的示例所示：
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
@Bean
public ServletServerContainerFactoryBean createWebSocketContainer() {
ServletServerContainerFactoryBean container = new ServletServerContainerFactoryBean();
container.setMaxTextMessageBufferSize(8192);
container.setMaxBinaryMessageBufferSize(8192);
return container;
}
}
下面的示例顯示了與前面示例等價的XML配置：
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:websocket="http://www.springframework.org/schema/websocket"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/websocket
http://www.springframework.org/schema/websocket/spring-websocket.xsd">
<bean class="org.springframework...ServletServerContainerFactoryBean">
<property name="maxTextMessageBufferSize" value="8192"/>
<property name="maxBinaryMessageBufferSize" value="8192"/>
</bean>
</beans>
對於客戶端WebSocket配置，你應該使用WebSocketContainerFactoryBean（XML）或
ContainerProvider.getWebSocketContainer()（Java配置）。
對於Jetty，須要提供預配置的Jetty WebSocketServerFactory，並經過WebSocket Java配置將其插入Spring的DefaultHandshakeHandler，下面的示例展現瞭如何作到這一點：
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
registry.addHandler(echoWebSocketHandler(),
"/echo").setHandshakeHandler(handshakeHandler());
}
@Bean
public DefaultHandshakeHandler handshakeHandler() {
WebSocketPolicy policy = new WebSocketPolicy(WebSocketBehavior.SERVER);
policy.setInputBufferSize(8192);
policy.setIdleTimeout(600000);
return new DefaultHandshakeHandler(
new JettyRequestUpgradeStrategy(new WebSocketServerFactory(policy)));
}
}
下面的示例顯示了與前面示例等價的XML配置：
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:websocket="http://www.springframework.org/schema/websocket"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/websocket
http://www.springframework.org/schema/websocket/spring-websocket.xsd">
<websocket:handlers>
<websocket:mapping path="/echo" handler="echoHandler"/>
<websocket:handshake-handler ref="handshakeHandler"/>
</websocket:handlers>
<bean id="handshakeHandler" class="org.springframework...DefaultHandshakeHandler">
<constructor-arg ref="upgradeStrategy"/>
</bean>
<bean id="upgradeStrategy" class="org.springframework...JettyRequestUpgradeStrategy">
<constructor-arg ref="serverFactory"/>
</bean>
<bean id="serverFactory" class="org.eclipse.jetty...WebSocketServerFactory">
<constructor-arg>
<bean class="org.eclipse.jetty...WebSocketPolicy">
<constructor-arg value="SERVER"/>
<property name="inputBufferSize" value="8092"/>
<property name="idleTimeout" value="600000"/>
</bean>
</constructor-arg>
</bean>
</beans>
容許的源
在Spring Framework 4.1.5中，WebSocket和SockJS的默認行爲是隻接受相同源的請求，也能夠容許全部或指定的源列表。這種檢查主要是爲瀏覽器客戶端設計的，沒有什麼能夠阻止其餘類型的客戶端修改Origin header值（請參閱RFC 6454: Web Origin概念以瞭解更多細節）。
三種可能的行爲是：
- 只容許相同源的請求（默認）：在這種模式下，當啓用SockJS時，Iframe HTTP響應header
X-Frame-Options被設置爲SAMEORIGIN，而且JSONP傳輸被禁用，由於它不容許檢查請求的源，所以，當啓用該模式時，不支持IE6和IE7。 - 容許指定的源列表：每一個容許的源必須以
http://或https://開始，在這種模式下，當啓用SockJS時，IFrame傳輸將被禁用，所以，當啓用該模式時，將不支持IE6到IE9。 - 容許全部的源：要啓用此模式，你應該提供
*做爲容許的源值，在這種模式下，全部的傳輸都是可用的。
你能夠配置WebSocket和SockJS容許的源，以下面的例子所示：
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
registry.addHandler(myHandler(), "/myHandler").setAllowedOrigins("http://mydomain.com");
}
@Bean
public WebSocketHandler myHandler() {
return new MyHandler();
}
}
下面的示例顯示了與前面示例等價的XML配置：
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:websocket="http://www.springframework.org/schema/websocket"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/websocket
http://www.springframework.org/schema/websocket/spring-websocket.xsd">
<websocket:handlers allowed-origins="http://mydomain.com">
<websocket:mapping path="/myHandler" handler="myHandler" />
</websocket:handlers>
<bean id="myHandler" class="org.springframework.samples.MyHandler"/>
</beans>
上一篇：WebSocket介紹
下一篇：SockJS Fallback
相關文章
- 1. Spring Framework 參考文檔（WebSocket介紹）
- 2. Spring Framework 參考文檔（WebSocket STOMP）
- 3. Spring Framework 參考文檔（概述）
- 4. Spring Framework 參考文檔（目錄）
- 5. Spring Framework 參考文檔（SockJS Fallback）
- 6. Spring Framework 參考文檔（容器概述）
- 7. Spring Framework 參考文檔（Bean概述）
- 8. Node.js API參考文檔（關於文檔）
- 9. Spring Framework 參考文檔（Spring IoC容器和bean介紹）
- 10. Spring Framework 參考文檔（JCache（JSR-107）註解）
- 更多相關文章...
- • WSDL 文檔 - WSDL 教程
- • XSL-FO 文檔 - XSL-FO 教程
- • Spring Cloud 微服務實戰(三) - 服務註冊與發現
- • Scala 中文亂碼解決
相關標籤/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
最新文章
- 1. 在windows下的虛擬機中,安裝華爲電腦的deepin操作系統
- 2. 強烈推薦款下載不限速解析神器
- 3. 【區塊鏈技術】孫宇晨：區塊鏈技術帶來金融服務的信任變革
- 4. 搜索引起的鏈接分析-計算網頁的重要性
- 5. TiDB x 微衆銀行 | 耗時降低 58%，分佈式架構助力實現普惠金融
- 6. 《數字孿生體技術白皮書》重磅發佈（附完整版下載）
- 7. 雙十一「避坑」指南：區塊鏈電子合同爲電商交易保駕護航！
- 8. 區塊鏈產業，怎樣「鏈」住未來？
- 9. OpenglRipper使用教程
- 10. springcloud請求一次好用一次不好用zuul Name or service not known
歡迎關注本站公眾號,獲取更多信息
相關文章
- 1. Spring Framework 參考文檔（WebSocket介紹）
- 2. Spring Framework 參考文檔（WebSocket STOMP）
- 3. Spring Framework 參考文檔（概述）
- 4. Spring Framework 參考文檔（目錄）
- 5. Spring Framework 參考文檔（SockJS Fallback）
- 6. Spring Framework 參考文檔（容器概述）
- 7. Spring Framework 參考文檔（Bean概述）
- 8. Node.js API參考文檔（關於文檔）
- 9. Spring Framework 參考文檔（Spring IoC容器和bean介紹）
- 10. Spring Framework 參考文檔（JCache（JSR-107）註解）