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。这确保会触发包含WebSocketSession的自定义SessionConnectEvent。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.

为了使示例能够工作，您必须在localhost上安装Redis 2.8+并使用默认端口(6379)运行它。或者，您可以更新RedisConnectionFactory以指向Redis服务器。另一个选择是使用Docker在localhost上运行Redis。有关详细说明，请参阅Docker Redis存储库。

您现在应该能够通过localhost:8080/访问该应用程序

探索`websocket`示例应用程序

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

用户名 rob
密码 password

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

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

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

用户名 luke
密码 password

密码 password

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

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

为什么是两分钟？

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

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

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