跳到主要内容

WebSocket 集成

QWen Max 中英对照 WebSocket Integration

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

备注

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

为什么选择 Spring Session 和 WebSockets？​

那么为什么我们在使用 WebSocket 时需要 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");
	}

}
java

我们可以更新配置以使用 Spring Session 的 WebSocket 支持。以下示例展示了如何做到这一点：

@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");
	}

}
java

要接入 Spring Session 支持，我们只需要更改两处：

  • 我们不再实现 WebSocketMessageBrokerConfigurer，而是扩展 AbstractSessionWebSocketMessageBrokerConfigurer

  • 我们将 registerStompEndpoints 方法重命名为 configureStompEndpoints

AbstractSessionWebSocketMessageBrokerConfigurer 在幕后做了什么？

  • WebSocketConnectHandlerDecoratorFactory 作为 WebSocketHandlerDecoratorFactory 添加到 WebSocketTransportRegistration。这确保了一个包含 WebSocketSession 的自定义 SessionConnectEvent 被触发。当 Spring Session 结束时，WebSocketSession 是必需的，用于结束所有仍然打开的 WebSocket 连接。

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

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

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