WebSocket 集成

Doubao 中英对照 WebSocket Integration

Spring Session 提供与 Spring 的 WebSocket 支持的透明集成。

备注

Spring Session 的 WebSocket 支持仅适用于 Spring 的 WebSocket 支持。具体来说，它不适用于直接使用 JSR-356，因为 JSR-356 没有用于拦截传入 WebSocket 消息的机制。

为什么使用 Spring Session 与 WebSocket？

那么，当我们使用 WebSocket 时，为什么还需要 Spring Session？

考虑一个主要通过 HTTP 请求完成工作的电子邮件应用程序。但是，其中还嵌入了一个通过 WebSocket API 工作的聊天应用程序。如果用户正在积极地与某人聊天，我们不应该让 HttpSession 超时，因为这会是相当糟糕的用户体验。然而，这正是 JSR-356 所做的事情。

另一个问题是，根据 JSR-356，如果 HttpSession 超时，那么使用该 HttpSession 创建的、带有已认证用户的任何 WebSocket 都应被强制关闭。这意味着，如果我们在应用程序中积极聊天而不使用 HttpSession，我们也会断开与对话的连接。

WebSocket 用法

WebSocket 示例 提供了一个可运行的示例，展示如何将 Spring Session 与 WebSocket 集成。你可以遵循接下来几个标题中描述的基本集成步骤，但我们建议你在将其集成到自己的应用程序时，参考详细的 WebSocket 指南。

HttpSession 集成

在使用 WebSocket 集成之前，你应确保已先让 HttpSession 集成 正常工作。

Spring 配置

在典型的 Spring WebSocket 应用程序中，你会实现 WebSocketMessageBrokerConfigurer。例如，配置可能大致如下：

@Configuration
@EnableScheduling
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {

	@Override
	public void registerStompEndpoints(StompEndpointRegistry registry) {
		registry.addEndpoint("/messages").withSockJS();
	}

	@Override
	public void configureMessageBroker(MessageBrokerRegistry registry) {
		registry.enableSimpleBroker("/queue/", "/topic/");
		registry.setApplicationDestinationPrefixes("/app");
	}

}

我们可以更新配置以使用 Spring Session 的 WebSocket 支持。以下示例展示了如何这样做：

@Configuration
@EnableScheduling
@EnableWebSocketMessageBroker
public class WebSocketConfig extends AbstractSessionWebSocketMessageBrokerConfigurer<Session> { 1

	@Override
	protected void configureStompEndpoints(StompEndpointRegistry registry) { 2
		registry.addEndpoint("/messages").withSockJS();
	}

	@Override
	public void configureMessageBroker(MessageBrokerRegistry registry) {
		registry.enableSimpleBroker("/queue/", "/topic/");
		registry.setApplicationDestinationPrefixes("/app");
	}

}

要接入 Spring Session 支持，我们只需更改两处：

• 我们不实现 WebSocketMessageBrokerConfigurer，而是扩展 AbstractSessionWebSocketMessageBrokerConfigurer

• 我们将 registerStompEndpoints 方法重命名为 configureStompEndpoints

AbstractSessionWebSocketMessageBrokerConfigurer 在幕后做了什么？

• WebSocketConnectHandlerDecoratorFactory 作为 WebSocketHandlerDecoratorFactory 添加到 WebSocketTransportRegistration。这确保触发一个包含 WebSocketSession 的自定义 SessionConnectEvent。WebSocketSession 是必要的，以便在 Spring Session 结束时结束所有仍处于打开状态的 WebSocket 连接。
• SessionRepositoryMessageInterceptor 作为 HandshakeInterceptor 添加到每个 StompWebSocketEndpointRegistration。这确保将 Session 添加到 WebSocket 属性中，以便更新最后访问时间。
• SessionRepositoryMessageInterceptor 作为 ChannelInterceptor 添加到我们的入站 ChannelRegistration。这确保每次收到入站消息时，都会更新我们 Spring Session 的最后访问时间。
• WebSocketRegistryListener 创建为一个 Spring bean。这确保我们拥有所有 Session ID 到对应 WebSocket 连接的映射。通过维护此映射，我们可以在 Spring Session（HttpSession）结束时关闭所有 WebSocket 连接。