Spring Session - WebSocket

本指南介绍如何使用 Spring Session 来确保 WebSocket 消息保持 HttpSession 的活动状态。

Spring Session 的 WebSocket 支持仅适用于 Spring 的 WebSocket 支持。具体来说，它不适用于直接使用 JSR-356，因为 JSR-356 没有拦截传入 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 支持。以下示例展示了如何操作

src/main/java/samples/config/WebSocketConfig.java
@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。这确保了我们拥有所有 Session ID 到相应 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示例应用程序

现在您可以尝试使用该应用程序。使用以下信息进行身份验证

  • 用户名 rob

  • 密码 password

现在单击登录按钮。您现在应该以用户rob的身份进行身份验证。

打开一个隐身窗口并访问localhost:8080/

系统将提示您输入登录表单。使用以下信息进行身份验证

  • 用户名 luke

  • 密码 password

现在从 rob 发送一条消息到 luke。该消息应该出现。

等待两分钟，然后尝试再次从 rob 发送消息到 luke。您可以看到消息不再发送。

为什么是两分钟？

Spring Session 在 60 秒内过期，但 Redis 的通知不能保证在 60 秒内发生。为了确保套接字在合理的时间内关闭，Spring Session 每分钟在 00 秒运行一个后台任务，强制清理所有过期的会话。这意味着您需要等待最多两分钟才能关闭 WebSocket 连接。

您现在可以尝试访问localhost:8080/系统会提示您再次进行身份验证。这表明会话已正确过期。

现在重复相同的练习，但不要等待两分钟，而是每 30 秒从每个用户发送一条消息。您可以看到消息继续发送。尝试访问localhost:8080/系统不会提示您再次进行身份验证。这表明会话保持活动状态。

只有来自用户的消息才能保持会话活动。这是因为只有来自用户的消息才意味着用户活动。接收到的消息并不意味着活动，因此不会更新会话过期时间。