一、定义

SockJS是一个浏览器JavaScript库,它提供了一个类似于网络的对象。SockJS提供了一个连贯的、跨浏览器的Javascript API,它在浏览器和web服务器之间创建了一个低延迟、全双工、跨域通信通道。

二、产生的原因

一些浏览器中缺少对WebSocket的支持,因此,回退选项是必要的,而Spring框架提供了基于SockJS协议的透明的回退选项。

SockJS的一大好处在于提供了浏览器兼容性。优先使用原生WebSocket,如果在不支持websocket的浏览器中,会自动降为轮询的方式。
除此之外,spring也对socketJS提供了支持。

如果代码中添加了withSockJS()如下,服务器也会自动降级为轮询。

registry.addEndpoint("/coordination").withSockJS();

SockJS的目标是让应用程序使用WebSocket API,但在运行时需要在必要时返回到非WebSocket替代,即无需更改应用程序代码。

SockJS是为在浏览器中使用而设计的。它使用各种各样的技术支持广泛的浏览器版本。对于SockJS传输类型和浏览器的完整列表,可以看到SockJS客户端页面。
传输分为3类:WebSocket、HTTP流和HTTP长轮询(按优秀选择的顺序分为3类)

三、使用

SockJS 很容易通过 Java 配置启用

  1. @Configuration
  2. @EnableWebSocket
  3. public class WebSocketConfig implements WebSocketConfigurer {
  4. @Override
  5. public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
  6. registry.addHandler(myHandler(), "/myHandler").withSockJS();
  7. }
  8. @Bean
  9. public WebSocketHandler myHandler() {
  10. return new MyHandler();
  11. }
  12. }

与之等价的XML配置:

  1. <beans xmlns="http://www.springframework.org/schema/beans"
  2. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xmlns:websocket="http://www.springframework.org/schema/websocket"
  4. xsi:schemaLocation="
  5. http://www.springframework.org/schema/beans
  6. http://www.springframework.org/schema/beans/spring-beans.xsd
  7. http://www.springframework.org/schema/websocket
  8. http://www.springframework.org/schema/websocket/spring-websocket.xsd">
  9. <websocket:handlers>
  10. <websocket:mapping path="/myHandler" handler="myHandler"/>
  11. <websocket:sockjs/>
  12. </websocket:handlers>
  13. <bean id="myHandler" class="org.springframework.samples.MyHandler"/>
  14. </beans>

打开一个连接,为连接创建事件监听器,断开连接,消息时间,发送消息返回到服务器,关闭连接。

  1. <script src="//cdn.jsdelivr.net/sockjs/1.0.0/sockjs.min.js"></script>
  2. var sock = new SockJS('/coordination');
  3. sock.onopen = function() {
  4. console.log('open');
  5. };
  6. sock.onmessage = function(e) {
  7. console.log('message', e.data);
  8. };
  9. sock.onclose = function() {
  10. console.log('close');
  11. };
  12. sock.send('test');
  13. sock.close();

四、心跳消息

SockJS协议要求服务器发送心跳消息,以阻止代理结束连接。Spring SockJS配置有一个名为“心脏节拍时间”的属性,可用于定制频率。默认情况下,如果没有在该连接上发送其他消息,则会在25秒后发送心跳。

当在websocket/SockJS中使用STOMP时,如果客户端和服务器通过协商来交换心跳,那么SockJS的心跳就会被禁用。

Spring SockJS支持还允许配置task调度程序来调度心跳任务。

五、Servlet 3异步请求

HTTP流和HTTP长轮询SockJS传输需要一个连接保持比平常更长时间的连接。
在Servlet容器中,这是通过Servlet 3的异步支持完成的,这允许退出Servlet的容器线程处理一个请求,并继续从另一个线程中写入响应。

六、SockJS的CROS Headers

如果允许跨源请求,那么SockJS协议使用CORS在XHR流和轮询传输中跨域支持。