对于最新的稳定版本，请使用 Spring Session 3.4.0！spring-doc.cn

WebSocket 集成

Spring Session 提供了与 Spring 的 WebSocket 支持的透明集成。spring-doc.cn

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

为什么选择 Spring Session 和 WebSockets？

那么，当我们使用 WebSockets 时，为什么还需要 Spring Session呢？spring-doc.cn

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

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

WebSocket 使用情况

WebSocket 示例提供了如何将 Spring Session 与 WebSockets 集成的工作示例。 您可以按照以下几个标题中描述的基本集成步骤进行操作，但我们鼓励您在与自己的应用程序集成时遵循详细的 WebSocket 指南。spring-doc.cn

HttpSession集成

在使用 WebSocket 集成之前，您应该确保 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