|
对于最新稳定版本，请使用 Spring Session 4.0.2！ |
Spring Session - WebSocket
HttpSession 设置
第一步是将Spring Session与HttpSession集成。这些步骤已经在Redis HttpSession指南中详细说明。
请确保您已经将 Spring Session 集成到 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 连接。
websocket示例应用程序
The websocket 样本应用程序演示了如何使用 Spring Session 与 WebSocket。
运行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示例应用程序
现在您可以尝试使用应用程序了。使用以下信息进行身份验证：
-
用户名 rob
-
密码 密码
现在点击 登录 按钮。你应该已经被认证为用户 rob。
打开无痕窗口并访问 http://localhost:8080/
您将看到一个登录表单。请使用以下信息进行身份验证：
-
用户名 luke
-
密码 密码
现在从rob发送一条消息给luke。这条消息应该出现。
等待两分钟后再尝试从rob发送消息给luke。 你将看到消息不再被发送。
|
为什么是两分钟？
Spring Session 在60秒后过期，但来自 Redis 的通知并不保证在60秒内发生。 为了确保在合理的时间内关闭 socket，Spring Session 每分钟的00秒会运行一个后台任务，强制清理任何已过期的会话。 这意味着您最多需要等待两分钟才能使 WebSocket 连接被关闭。 |
您现在可以尝试访问 localhost:8080/ 系统会提示您重新进行身份验证。 这表明会话已正确过期。
现在重复相同的练习，但这次不是等待两分钟，而是每30秒从每个用户发送一条消息。 你可以看到消息会继续被发送。 尝试访问 localhost:8080/ 你不会再次被提示进行身份验证。 这表明会话保持活跃。
| 只有用户发送的消息才能保持会话活跃。 这是因为只有来自用户的消息才表示用户活动。 收到的消息并不表明有活动，因此不会更新会话过期时间。 |