|
对于最新的稳定版本，请使用 Spring Session 3.5.2！ |
Spring Session - WebSocket
HttpSession 设置
第一步是将 Spring Session 与 HttpSession 集成。这些步骤已在 HttpSession with Redis 指南中概述。
在继续之前，请确保您已经将 Spring Session 与 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 连接。
websocket示例应用
这websocket示例应用程序演示了如何将 Spring Session 与 WebSockets 一起使用。
运行websocket示例应用
您可以通过获取源代码并调用以下命令来运行示例：
$ ./gradlew :spring-session-sample-boot-websocket:bootRun
|
为了测试会话过期，您可能希望在启动应用程序之前添加以下配置属性，将会话过期更改为 1 分钟（默认值为 30 分钟）： src/main/resources/application.properties
server.servlet.session.timeout=1m # Session timeout. If a duration suffix is not specified, seconds will be used. |
要使示例正常工作，您必须在本地主机上安装 Redis 2.8+ 并使用默认端口 （6379） 运行它。
或者，您可以更新RedisConnectionFactory指向 Redis 服务器。
另一种选择是使用 Docker 在本地主机上运行 Redis。
有关详细说明，请参阅 Docker Redis 存储库。 |
您现在应该能够在 localhost：8080/ 访问该应用程序
探索websocket示例应用
现在您可以尝试使用该应用程序。使用以下信息进行身份验证：
-
用户名抢劫
-
密码密码
现在点击 登录 按钮。您现在应该被身份验证为用户抢劫。
打开隐身窗口并访问 localhost：8080/
系统会提示您登录表单。使用以下信息进行身份验证：
-
用户名 luke
-
密码密码
现在向卢克发送一条从罗布的信息。应该会出现该消息。
等待两分钟，然后再次尝试从 rob 向 luke 发送消息。 您可以看到消息不再发送。
|
为什么是两分钟？
Spring Session 在 60 秒后过期，但不保证来自 Redis 的通知会在 60 秒内发生。 为了确保套接字在合理的时间内关闭，Spring Session 每分钟在 00 秒运行一个后台任务，强制清理任何过期的会话。 这意味着您最多需要等待两分钟才能关闭 WebSocket 连接。 |
您现在可以尝试访问 localhost：8080/ 系统会提示您再次进行身份验证。 这表明会话已正确过期。
现在重复相同的练习，但不要等待两分钟，而是每 30 秒发送一条来自每个用户的消息。 您可以看到消息继续发送。 尝试访问 localhost：8080/ 系统不会提示您再次进行身份验证。 这表明会话保持活动状态。
| 只有从用户发送的消息才能使会话保持活动状态。 这是因为只有来自用户的消息才暗示用户活动。 收到的消息并不意味着活动，因此不会更新会话到期。 |