|
对于最新稳定版本，请使用 Spring Session 4.0.2！ |
WebSocket 集成
Spring Session 提供了与 Spring 的 WebSocket 支持的透明集成。
| Spring Session 的 WebSocket 支持仅与 Spring 的 WebSocket 支持一起工作。 具体来说，它不支持直接使用 JSR-356，因为 JSR-356 没有拦截传入的 WebSocket 消息的机制。 |
为什么选择 Spring Session 和 WebSockets？
当我们使用WebSockets时，为什么还需要Spring Session？
考虑一个电子邮件应用程序，大部分工作是通过HTTP请求完成的。
但是，在其中也嵌入了一个聊天应用程序，它是基于WebSocket API工作的。
如果用户正在与某人聊天，我们不应该将超时设置为HttpSession，因为这会带来非常糟糕的用户体验。
然而，恰恰是
另一个问题是，根据JSR-356规范，如果HttpSession超时，那么使用该HttpSession和已认证用户的任何WebSocket都应该被强制关闭。
这意味着，在我们的应用中正在积极聊天且未使用HttpSession的情况下，我们也将从对话中断开连接。
WebSocket 使用
The WebSocket样例 提供了如何将 Spring Session 与 WebSockets 集成的一个工作示例。
你可以遵循接下来几个段落中描述的基本集成步骤，但在自己应用中进行集成时我们鼓励你参考详细的 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支持。<br> 以下示例展示了如何做到这一点：<br>
@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 | 我们将 registerStompEndpoints 方法重命名为 configureStompEndpoints |
AbstractSessionWebSocketMessageBrokerConfigurer 在幕后做了些什么？
-
WebSocketConnectHandlerDecoratorFactory是添加为WebSocketHandlerDecoratorFactory到WebSocketTransportRegistration。 这确保了一个自定义的SessionConnectEvent被触发，该事件包含WebSocketSession。WebSocketSession用于结束任何在 Spring Session 结束时仍然打开的 WebSocket 连接。 -
SessionRepositoryMessageInterceptor作为HandshakeInterceptor添加到每一个StompWebSocketEndpointRegistration。 这确保了Session被添加到 WebSocket 属性中，以启用更新最后访问时间。 -
SessionRepositoryMessageInterceptor被作为ChannelInterceptor添加到我们的入站ChannelRegistration中。 这确保每次接收入站消息时，Spring Session 的最后访问时间都会更新。 -
WebSocketRegistryListener是作为 Spring bean 创建的。 这确保了我们有一个SessionID 到对应的 WebSocket 连接的映射。 通过维护这个映射，当我们结束一个 Spring 会话（HttpSession）时可以关闭所有 WebSocket 连接。