|
对于最新的稳定版本，请使用 Spring Session 3.5.2！ |
WebSocket 集成
Spring Session 提供与 Spring 的 WebSocket 支持的透明集成。
| Spring Session 的 WebSocket 支持仅适用于 Spring 的 WebSocket 支持。 具体来说，它不能直接使用 JSR-356，因为 JSR-356 没有拦截传入 WebSocket 消息的机制。 |
为什么选择 Spring Session 和 WebSockets？
那么为什么我们在使用 WebSocket 时需要 Spring Session 呢？
考虑一个电子邮件应用程序，它通过 HTTP 请求完成大部分工作。
但是，其中还嵌入了一个通过 WebSocket API 运行的聊天应用程序。
如果用户正在主动与某人聊天，我们不应该超时HttpSession，因为这将是一个非常糟糕的用户体验。
然而，这正是 JSR-356 所做的。
另一个问题是，根据 JSR-356，如果HttpSession超时，则使用该 WebSocket 创建的任何 WebSocketHttpSession并且应强制关闭经过身份验证的用户。
这意味着，如果我们在应用程序中积极聊天并且没有使用 HttpSession，我们也会断开与对话的连接。
WebSocket 用法
WebSocket 示例提供了如何将 Spring Session 与 WebSockets 集成的工作示例。 您可以按照接下来几个标题中描述的基本集成步骤进行作，但我们鼓励您在与自己的应用程序集成时遵循详细的 WebSocket 指南。
HttpSession集成
在使用 WebSocket 集成之前，您应该确保您拥有HttpSession集成首先工作。
弹簧配置
在典型的 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 支持，我们只需要更改两件事：
| 1 | 而不是实施WebSocketMessageBrokerConfigurer，我们扩展AbstractSessionWebSocketMessageBrokerConfigurer |
| 2 | 我们将registerStompEndpointsmethod 设置为configureStompEndpoints |
什么AbstractSessionWebSocketMessageBrokerConfigurer做幕后？
-
WebSocketConnectHandlerDecoratorFactory被添加为WebSocketHandlerDecoratorFactory自WebSocketTransportRegistration. 这确保了自定义SessionConnectEvent被触发，其中包含WebSocketSession. 这WebSocketSession是结束 Spring 会话结束时仍打开的任何 WebSocket 连接所必需的。 -
SessionRepositoryMessageInterceptor被添加为HandshakeInterceptor对每个StompWebSocketEndpointRegistration. 这确保了Session添加到 WebSocket 属性中，以启用更新上次访问时间。 -
SessionRepositoryMessageInterceptor被添加为ChannelInterceptor到我们的入境ChannelRegistration. 这确保了每次收到入站消息时，都会更新我们的 Spring Session 的上次访问时间。 -
WebSocketRegistryListener创建为 Spring bean。 这确保了我们拥有所有SessionID 到相应的 WebSocket 连接。 通过维护此映射，我们可以在 Spring Session （HttpSession） 结束时关闭所有 WebSocket 连接。