WebSocket 集成

Spring Session 提供与 Spring 的 WebSocket 支持的透明集成。

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

为什么选择 Spring Session 和 WebSockets？

那么，当我们使用 WebSockets 时，为什么需要 Spring Session 呢？

考虑一个电子邮件应用程序，它的大部分工作都是通过 HTTP 请求完成的。但是，它内部还嵌入了一个通过 WebSocket API 工作的聊天应用程序。如果用户正在积极地与某人聊天，我们不应该使 HttpSession 超时，因为这会带来非常糟糕的用户体验。然而，这正是 JSR-356 所做的。

另一个问题是，根据 JSR-356，如果 HttpSession 超时，则使用该 HttpSession 和经过身份验证的用户创建的任何 WebSocket 都应强制关闭。这意味着，如果我们正在应用程序中积极地聊天并且没有使用 HttpSession，我们也会断开与对话的连接。

WebSocket 用法

WebSocket 示例 提供了一个关于如何将 Spring Session 与 WebSockets 集成的有效示例。您可以按照接下来几个标题中描述的基本集成步骤操作，但我们建议您在与自己的应用程序集成时，参考详细的 WebSocket 指南。

HttpSession 集成

在使用 WebSocket 集成之前，您应该确保首先已使 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 连接。