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 被添加为 WebSocketTransportRegistration 的一个 WebSocketHandlerDecoratorFactory。这确保会触发一个包含 WebSocketSession 的自定义 SessionConnectEvent。当 Spring Session 结束时，WebSocketSession 对于终止任何仍然打开的 WebSocket 连接是必要的。

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

  • SessionRepositoryMessageInterceptor 被添加为我们的入站 ChannelRegistration 的一个 ChannelInterceptor。这确保每当接收到入站消息时，我们的 Spring Session 的最后访问时间都会得到更新。

  • WebSocketRegistryListener 被创建为一个 Spring bean。这确保我们拥有所有 Session ID 与相应的 WebSocket 连接的映射。通过维护此映射，当 Spring Session (HttpSession) 结束时，我们可以关闭所有 WebSocket 连接。