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 连接。