此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Session 3.4.0！spring-doc.cn

Spring 会话 - WebSocket

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

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

HttpSession 设置

第一步是将 Spring Session 与 HttpSession 集成。这些步骤已在 HttpSession with Redis 指南中概述。spring-doc.cn

在继续之前，请确保您已经将 Spring Session 与 HttpSession 集成。spring-doc.cn

Spring 配置

在典型的 Spring WebSocket 应用程序中，您将实现 . 例如，配置可能如下所示：WebSocketMessageBrokerConfigurerspring-doc.cn

@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 支持。 以下示例显示了如何执行此操作：spring-doc.cn

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

}

要 hook Spring Session 支持，我们只需要改变两件事：spring-doc.cn

1 我们不是实现 ，而是扩展WebSocketMessageBrokerConfigurerAbstractSessionWebSocketMessageBrokerConfigurer
2 我们将方法重命名为registerStompEndpointsconfigureStompEndpoints

幕后是做什么的？AbstractSessionWebSocketMessageBrokerConfigurerspring-doc.cn

  • WebSocketConnectHandlerDecoratorFactory作为 添加到 。 这可确保触发包含 . 这是结束 Spring Session 结束时仍然打开的任何 WebSocket 连接所必需的。WebSocketHandlerDecoratorFactoryWebSocketTransportRegistrationSessionConnectEventWebSocketSessionWebSocketSessionspring-doc.cn

  • SessionRepositoryMessageInterceptor将作为 添加到 每个 。 这可确保将 添加到 WebSocket 属性中，以启用上次访问时间的更新。HandshakeInterceptorStompWebSocketEndpointRegistrationSessionspring-doc.cn

  • SessionRepositoryMessageInterceptor作为 添加到我们的入站 。 这确保了每次收到入站消息时，我们的 Spring Session 的最后访问时间都会更新。ChannelInterceptorChannelRegistrationspring-doc.cn

  • WebSocketRegistryListener创建为 Spring bean。 这可确保我们将所有 ID 映射到相应的 WebSocket 连接。 通过维护这个映射，我们可以在 Spring Session （HttpSession） 结束时关闭所有 WebSocket 连接。Sessionspring-doc.cn

websocket示例应用程序

示例应用程序演示了如何将 Spring Session 与 WebSockets 一起使用。websocketspring-doc.cn

运行示例应用程序websocket

您可以通过获取源码并调用以下命令来运行该示例：spring-doc.cn

$ ./gradlew :spring-session-sample-boot-websocket:bootRun

为了测试会话过期时间，您可能希望在启动应用程序之前添加以下配置属性，将会话过期时间更改为 1 分钟（默认值为 30 分钟）：spring-doc.cn

src/main/resources/application.properties
server.servlet.session.timeout=1m # Session timeout. If a duration suffix is not specified, seconds will be used.
要使该示例正常工作，您必须在 localhost 上安装 Redis 2.8+，并使用默认端口 （6379） 运行它。 或者，您也可以将 to 更新为 指向 Redis 服务器。 另一种选择是使用 Docker 在本地主机上运行 Redis。 有关详细说明，请参阅 Docker Redis 存储库。RedisConnectionFactory

您现在应该能够访问 localhost：8080/ 中的应用程序spring-doc.cn

探索示例应用程序websocket

现在您可以尝试使用该应用程序。使用以下信息进行身份验证：spring-doc.cn

现在单击 Login 按钮。现在，您应该以用户 rob.spring-doc.cn

打开一个隐身窗口并访问 localhost：8080/spring-doc.cn

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

现在从 rob 向 luke 发送消息。此时应显示该消息。spring-doc.cn

等待 2 分钟，然后再次尝试从 rob 向 luke 发送消息。 您可以看到该消息不再发送。spring-doc.cn

为什么是 2 分钟？

Spring Session 将在 60 秒后过期，但不能保证在 60 秒内收到来自 Redis 的通知。 为了确保套接字在合理的时间内关闭，Spring Session 每分钟在 00 秒运行一个后台任务，强制清理任何过期的会话。 这意味着您最多需要等待两分钟，然后 WebSocket 连接才会关闭。spring-doc.cn

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

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

只有从用户发送的消息才能使会话保持活动状态。 这是因为只有来自用户的消息才暗示用户活动。 收到的消息并不意味着活动，因此不会续订会话过期。