跳到主要内容

Spring Session - WebSocket

QWen Max 中英对照 WebSockets Spring Session - WebSocket

本指南描述了如何使用 Spring Session 确保 WebSocket 消息使您的 HttpSession 保持活动状态。

备注

Spring Session 的 WebSocket 支持仅与 Spring 的 WebSocket 支持兼容。具体来说，它不支持直接使用 JSR-356，因为 JSR-356 没有拦截传入 WebSocket 消息的机制。

Index

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");
	}

}
java

我们可以更新配置以使用 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");
	}

}
java

要接入 Spring Session 支持，我们只需要更改两处：

  • 我们不再实现 WebSocketMessageBrokerConfigurer，而是扩展 AbstractSessionWebSocketMessageBrokerConfigurer

  • 我们将 registerStompEndpoints 方法重命名为 configureStompEndpoints

AbstractSessionWebSocketMessageBrokerConfigurer 在幕后做了什么？

  • WebSocketConnectHandlerDecoratorFactory 被添加为 WebSocketTransportRegistration 的 WebSocketHandlerDecoratorFactory。这确保了一个包含 WebSocketSession 的自定义 SessionConnectEvent 会被触发。WebSocketSession 是必需的，以便在 Spring Session 结束时关闭所有仍然打开的 WebSocket 连接。

  • SessionRepositoryMessageInterceptor 被添加为每个 StompWebSocketEndpointRegistration 的 HandshakeInterceptor。这确保了 Session 被添加到 WebSocket 属性中，以启用更新最后访问时间的功能。

  • SessionRepositoryMessageInterceptor 被添加为我们入站 ChannelRegistration 的 ChannelInterceptor。这确保了每次接收到入站消息时，我们的 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分钟），方法是添加以下配置属性：

server.servlet.session.timeout=1m # 会话超时。如果未指定持续时间后缀，则使用秒。
备注

为了让示例正常工作，您必须在本地主机上安装 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/。你不会被再次提示进行身份验证。这表明会话是保持活跃的。

备注

只有用户发送的消息才能保持会话活跃。这是因为只有来自用户的消息才意味着用户活动。收到的消息并不意味着活动，因此不会延长会话有效期。