此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Session 3.4.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 所做的。
另一个问题是,根据 JSR-356,如果HttpSession
超时,则使用该HttpSession
并且应强制关闭经过身份验证的用户。
这意味着,如果我们在应用程序中主动聊天并且没有使用 HttpSession,我们也会断开与对话的连接。
WebSocket 使用情况
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 支持。 以下示例显示了如何执行此作:
@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");
}
}
要 hook Spring Session 支持,我们只需要改变两件事:
1 | 而不是实施WebSocketMessageBrokerConfigurer ,我们扩展AbstractSessionWebSocketMessageBrokerConfigurer |
2 | 我们将registerStompEndpoints method 设置为configureStompEndpoints |
什么AbstractSessionWebSocketMessageBrokerConfigurer
做幕后工作?
-
WebSocketConnectHandlerDecoratorFactory
添加为WebSocketHandlerDecoratorFactory
自WebSocketTransportRegistration
. 这可确保自定义SessionConnectEvent
触发的WebSocketSession
. 这WebSocketSession
对于结束 Spring Session 结束时仍然打开的任何 WebSocket 连接是必需的。 -
SessionRepositoryMessageInterceptor
添加为HandshakeInterceptor
到每一个StompWebSocketEndpointRegistration
. 这可确保Session
添加到 WebSocket 属性中,以启用上次访问时间的更新。 -
SessionRepositoryMessageInterceptor
添加为ChannelInterceptor
到我们的入站ChannelRegistration
. 这确保了每次收到入站消息时,我们的 Spring Session 的最后访问时间都会更新。 -
WebSocketRegistryListener
创建为 Spring bean。 这确保了我们拥有所有Session
ID 添加到相应的 WebSocket 连接。 通过维护这个映射,我们可以在 Spring Session (HttpSession) 结束时关闭所有 WebSocket 连接。