SockJS 回退

在公共互联网上，你无法控制的限制性代理可能会阻止 WebSocket 交互，原因可能是它们未配置为传递 Upgrade 头，或者它们关闭了看起来空闲的长期连接。解决此问题的方法是 WebSocket 仿真——即，首先尝试使用 WebSocket，然后回退到基于 HTTP 的技术，这些技术模仿 WebSocket 交互并公开相同的应用层 API。在 Servlet 栈上，Spring Framework 为 SockJS 协议提供了服务器（以及客户端）支持。

概述

SockJS 的目标是让应用程序使用 WebSocket API，但在运行时必要时回退到非 WebSocket 替代方案，而无需更改应用程序代码。

SockJS 包含：

  • SockJS 协议以可执行的 叙述性测试形式定义。

  • SockJS JavaScript 客户端——一个用于浏览器中的客户端库。

  • SockJS 服务器实现，包括 Spring Framework spring-websocket 模块中的一个。

  • spring-websocket 模块中的 SockJS Java 客户端（自版本 4.1 起）。

SockJS 专为在浏览器中使用而设计。它使用各种技术来支持广泛的浏览器版本。有关 SockJS 传输类型和浏览器的完整列表，请参阅 SockJS 客户端页面。传输分为三类：WebSocket、HTTP Streaming 和 HTTP Long Polling。有关这些类别的概述，请参阅 此博客文章。

SockJS 客户端首先发送 GET /info 从服务器获取基本信息。之后，它必须决定使用哪种传输。如果可能，使用 WebSocket。如果不能，在大多数浏览器中，至少有一个 HTTP 流选项。如果不能，则使用 HTTP (长)轮询。

所有传输请求都具有以下 URL 结构：

https://host:port/myApp/myEndpoint/{server-id}/{session-id}/{transport}

其中：

  • {server-id} 对于集群中的请求路由很有用，但除此之外不使用。

  • {session-id} 关联属于 SockJS 会话的 HTTP 请求。

  • {transport} 指示传输类型（例如，websocket、xhr-streaming 等）。

WebSocket 传输只需要一个 HTTP 请求来完成 WebSocket 握手。此后所有消息都在该套接字上交换。

HTTP 传输需要更多请求。例如，Ajax/XHR 流依赖于一个用于服务器到客户端消息的长时间运行请求，以及用于客户端到服务器消息的额外 HTTP POST 请求。长轮询类似，只是它在每次服务器到客户端发送后结束当前请求。

SockJS 添加了最小的消息帧。例如，服务器最初发送字母 o（“open” 帧），消息以 a["message1","message2"]（JSON 编码数组）发送，如果 25 秒内（默认情况下）没有消息流，则发送字母 h（“heartbeat” 帧），并发送字母 c（“close” 帧）以关闭会话。

要了解更多信息，请在浏览器中运行一个示例并观察 HTTP 请求。SockJS 客户端允许固定传输列表，因此可以一次查看一个传输。SockJS 客户端还提供了一个调试标志，可在浏览器控制台中启用有用的消息。在服务器端，你可以为 org.springframework.web.socket 启用 TRACE 日志记录。有关更多详细信息，请参阅 SockJS 协议 叙述性测试。

启用 SockJS

你可以通过配置启用 SockJS，如以下示例所示：

前面的示例用于 Spring MVC 应用程序，应包含在 DispatcherServlet 的配置中。然而，Spring 的 WebSocket 和 SockJS 支持不依赖于 Spring MVC。在 SockJsHttpRequestHandler 的帮助下，将其集成到其他 HTTP 服务环境中相对简单。

在浏览器端，应用程序可以使用 sockjs-client（版本 1.0.x）。它模拟 W3C WebSocket API 并与服务器通信以选择最佳传输选项，具体取决于其运行的浏览器。请参阅 sockjs-client 页面和浏览器支持的传输类型列表。客户端还提供了一些配置选项——例如，指定要包含哪些传输。

IE 8 和 9

Internet Explorer 8 和 9 仍在被使用。它们是使用 SockJS 的一个关键原因。本节涵盖了在这些浏览器中运行的重要注意事项。

SockJS 客户端通过使用 Microsoft 的 XDomainRequest 支持 IE 8 和 9 中的 Ajax/XHR 流。这可以跨域工作，但不支持发送 cookie。Cookie 通常对于 Java 应用程序至关重要。然而，由于 SockJS 客户端可以与许多服务器类型（不仅仅是 Java）一起使用，它需要知道 cookie 是否重要。如果是，SockJS 客户端更喜欢 Ajax/XHR 进行流式传输。否则，它依赖于基于 iframe 的技术。

SockJS 客户端的第一个 /info 请求是请求可能影响客户端传输选择的信息。其中一个细节是服务器应用程序是否依赖 cookie（例如，用于身份验证目的或使用粘性会话进行集群）。Spring 的 SockJS 支持包含一个名为 sessionCookieNeeded 的属性。它默认启用，因为大多数 Java 应用程序依赖于 JSESSIONID cookie。如果你的应用程序不需要它，你可以关闭此选项，然后 SockJS 客户端应该在 IE 8 和 9 中选择 xdr-streaming。

如果你确实使用基于 iframe 的传输，请记住浏览器可以通过将 HTTP 响应头 X-Frame-Options 设置为 DENY、SAMEORIGIN 或 ALLOW-FROM <origin> 来指示阻止在给定页面上使用 IFrames。这用于防止 点击劫持。

Spring Security 3.2+ 提供对在每个响应上设置 X-Frame-Options 的支持。默认情况下，Spring Security Java 配置将其设置为 DENY。在 3.2 中，Spring Security XML 命名空间默认不设置该头，但可以配置为设置。将来，它可能会默认设置。请参阅 Spring Security 文档的 默认安全头以了解如何配置 X-Frame-Options 头的设置。你还可以参阅 gh-2718 以获取更多背景信息。

如果你的应用程序添加了 X-Frame-Options 响应头（应该如此！）并依赖于基于 iframe 的传输，你需要将头值设置为 SAMEORIGIN 或 ALLOW-FROM <origin>。Spring SockJS 支持还需要知道 SockJS 客户端的位置，因为它从 iframe 加载。默认情况下，iframe 设置为从 CDN 位置下载 SockJS 客户端。建议配置此选项以使用与应用程序同源的 URL。

以下示例展示了如何在 Java 配置中执行此操作：

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {

	@Override
	public void registerStompEndpoints(StompEndpointRegistry registry) {
		registry.addEndpoint("/portfolio").withSockJS()
				.setClientLibraryUrl("http://localhost:8080/myapp/js/sockjs-client.js");
	}

	// ...

}

XML 命名空间通过 <websocket:sockjs> 元素提供了一个类似的选项。

在初始开发期间，请启用 SockJS 客户端 devel 模式，该模式可防止浏览器缓存 SockJS 请求（例如 iframe），否则这些请求将被缓存。有关如何启用它的详细信息，请参阅 SockJS 客户端页面。

心跳

SockJS 协议要求服务器发送心跳消息，以防止代理认为连接已挂起。Spring SockJS 配置有一个名为 heartbeatTime 的属性，你可以使用它来自定义频率。默认情况下，如果连接上没有发送其他消息，则在 25 秒后发送心跳。此 25 秒值符合以下 IETF 建议用于公共互联网应用程序。

当通过 WebSocket 和 SockJS 使用 STOMP 时，如果 STOMP 客户端和服务器协商交换心跳，则 SockJS 心跳将被禁用。

Spring SockJS 支持还允许你配置 TaskScheduler 来调度心跳任务。任务调度程序由一个线程池支持，默认设置基于可用处理器数量。你应该考虑根据你的具体需求自定义设置。

客户端断开连接

HTTP 流和 HTTP 长轮询 SockJS 传输要求连接保持打开时间比平时更长。有关这些技术的概述，请参阅 此博客文章。

在 Servlet 容器中，这是通过 Servlet 3 异步支持完成的，该支持允许退出 Servlet 容器线程，处理请求，并从另一个线程继续写入响应。

一个具体的问题是 Servlet API 不提供客户端已离开的通知。请参阅 eclipse-ee4j/servlet-api#44。然而，Servlet 容器在后续尝试写入响应时会引发异常。由于 Spring 的 SockJS 服务支持服务器端发送心跳（默认每 25 秒），这意味着客户端断开连接通常在该时间段内（或更早，如果消息发送更频繁）被检测到。

因此，可能会因为客户端断开连接而发生网络 I/O 故障，这会使日志充满不必要的堆栈跟踪。Spring 尽最大努力识别此类表示客户端断开连接的网络故障（特定于每个服务器），并使用专用日志类别 DISCONNECTED_CLIENT_LOG_CATEGORY（在 AbstractSockJsSession 中定义）记录最小消息。如果你需要查看堆栈跟踪，可以将该日志类别设置为 TRACE。

SockJS 和 CORS

如果你允许跨域请求（请参阅 允许的来源），SockJS 协议在 XHR 流和轮询传输中为跨域支持使用 CORS。因此，CORS 头会自动添加，除非检测到响应中存在 CORS 头。所以，如果应用程序已经配置为提供 CORS 支持（例如，通过 Servlet 过滤器），Spring 的 SockJsService 会跳过这一部分。

也可以通过在 Spring 的 SockJsService 中设置 suppressCors 属性来禁用这些 CORS 头的添加。

SockJS 期望以下头和值：

  • Access-Control-Allow-Origin：从 Origin 请求头的值初始化。

  • Access-Control-Allow-Credentials：始终设置为 true。

  • Access-Control-Request-Headers：从等效请求头的值初始化。

  • Access-Control-Allow-Methods：传输支持的 HTTP 方法（请参阅 TransportType 枚举）。

  • Access-Control-Max-Age：设置为 31536000（1 年）。

有关确切的实现，请参阅 AbstractSockJsService 中的 addCorsHeaders 和源代码中的 TransportType 枚举。

或者，如果 CORS 配置允许，请考虑排除带有 SockJS 端点前缀的 URL，从而让 Spring 的 SockJsService 处理它。

SockJsClient

Spring 提供了一个 SockJS Java 客户端，用于连接到远程 SockJS 端点而无需使用浏览器。这在两个服务器之间需要通过公共网络进行双向通信时特别有用（即，网络代理可能阻止使用 WebSocket 协议的地方）。SockJS Java 客户端对于测试目的也非常有用（例如，模拟大量并发用户）。

SockJS Java 客户端支持 websocket、xhr-streaming 和 xhr-polling 传输。其余的仅适用于在浏览器中使用。

你可以使用以下配置 WebSocketTransport：

  • JSR-356 运行时中的 StandardWebSocketClient。

  • 使用 Jetty 9+ 原生 WebSocket API 的 JettyWebSocketClient。

  • Spring 的 WebSocketClient 的任何实现。

XhrTransport，顾名思义，支持 xhr-streaming 和 xhr-polling，因为从客户端的角度来看，除了用于连接服务器的 URL 之外，没有区别。目前有两种实现：

  • RestTemplateXhrTransport 使用 Spring 的 RestTemplate 进行 HTTP 请求。

  • JettyXhrTransport 使用 Jetty 的 HttpClient 进行 HTTP 请求。

以下示例展示了如何创建 SockJS 客户端并连接到 SockJS 端点：

List<Transport> transports = new ArrayList<>(2);
transports.add(new WebSocketTransport(new StandardWebSocketClient()));
transports.add(new RestTemplateXhrTransport());

SockJsClient sockJsClient = new SockJsClient(transports);
sockJsClient.doHandshake(new MyWebSocketHandler(), "ws://example.com:8080/sockjs");

SockJS 使用 JSON 格式的数组作为消息。默认情况下，使用 Jackson 2，并且需要将其放在类路径上。或者，你可以配置 SockJsMessageCodec 的自定义实现并在 SockJsClient 上配置它。

要使用 SockJsClient 模拟大量并发用户，你需要配置底层 HTTP 客户端（用于 XHR 传输）以允许足够的连接和线程数。以下示例展示了如何使用 Jetty 执行此操作：

HttpClient jettyHttpClient = new HttpClient();
jettyHttpClient.setMaxConnectionsPerDestination(1000);
jettyHttpClient.setExecutor(new QueuedThreadPool(1000));

以下示例显示了你还应该考虑自定义的服务器端 SockJS 相关属性（有关详细信息，请参阅 javadoc）：

@Configuration
public class WebSocketConfig extends WebSocketMessageBrokerConfigurationSupport {

	@Override
	public void registerStompEndpoints(StompEndpointRegistry registry) {
		registry.addEndpoint("/sockjs").withSockJS()
			.setStreamBytesLimit(512 * 1024) [id="CO1-1"]1
			.setHttpMessageCacheSize(1000) [id="CO1-2"]2
			.setDisconnectDelay(30 * 1000); [id="CO1-3"]3
	}

	// ...
}
<1>  将 `streamBytesLimit` 属性设置为 512KB（默认值为 128KB——`128 * 1024`）。
<1>  将 `httpMessageCacheSize` 属性设置为 1,000（默认值为 `100`）。
<1>  将 `disconnectDelay` 属性设置为 30 秒（默认值为 5 秒——`5 * 1000`）。