# WebSocket 整合

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

|   |Spring Session 的 WebSocket 支持仅对 Spring 的 WebSocket 支持有效。<br/>具体来说，它不能直接使用[JSR-356](https://www.jcp.org/en/jsr/detail?id=356)，因为 JSR-356 没有拦截传入 WebSocket 消息的机制。|
|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

## 为什么要使用会话和 WebSockets？

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

考虑一个电子邮件应用程序，它的大部分工作都是通过 HTTP 请求完成的。然而，其中还嵌入了一个聊天应用程序，该应用程序可以在 WebSocket API 上工作。如果用户正在积极地与某人聊天，我们不应该超时`HttpSession`，因为这将是一个非常糟糕的用户体验。然而，这正是[JSR-356](https://java.net/jira/browse/WEBSOCKET_SPEC-175)所做的。

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

##  WebSocket 用法

[ WebSocket Sample](samples.html#samples)提供了如何将 Spring Session 与 WebSockets 集成的工作示例。你可以遵循下面几个标题中描述的集成的基本步骤，但我们鼓励你在与自己的应用程序集成时遵循详细的 WebSocket 指南。

### `HttpSession`积分

在使用 WebSocket 集成之前，你应该确保首先有[`HttpSession`集成]（http-session.html#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`被触发。当 Spring Session 结束时，要结束任何 WebSocket 仍处于打开状态的连接，`WebSocketSession`是必需的。

* `SessionRepositoryMessageInterceptor`作为`HandshakeInterceptor`添加到每个`StompWebSocketEndpointRegistration`。这确保将`Session`添加到 WebSocket 属性中，以允许更新上次访问的时间。

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

* `WebSocketRegistryListener`被创建为 Spring  Bean。这确保了我们将所有`Session`ID 映射到相应的 WebSocket 连接。通过维护此映射，我们可以在 Spring Session 结束时关闭所有 WebSocket 连接。