Spring开发系列教程(27)——使用WebSocket

WebSocket是一种基于HTTP的长链接技术。传统的HTTP协议是一种请求-响应模型，如果浏览器不发送请求，那么服务器无法主动给浏览器推送数据。如果需要定期给浏览器推送数据，例如股票行情，或者不定期给浏览器推送数据，例如在线聊天，基于HTTP协议实现这类需求，只能依靠浏览器的JavaScript定时轮询，效率很低且实时性不高。

因为HTTP本身是基于TCP连接的，所以，WebSocket在HTTP协议的基础上做了一个简单的升级，即建立TCP连接后，浏览器发送请求时，附带几个头：

GET /chat HTTP/1.1 Host: www.example.com Upgrade: websocket Connection: Upgrade

就表示客户端希望升级连接，变成长连接的WebSocket，服务器返回升级成功的响应：

HTTP/1.1 101 Switching Protocols Upgrade: websocket Connection: Upgrade

收到成功响应后表示WebSocket“握手”成功，这样，代表WebSocket的这个TCP连接将不会被服务器关闭，而是一直保持，服务器可随时向浏览器推送消息，浏览器也可随时向服务器推送消息。双方推送的消息既可以是文本消息，也可以是二进制消息，一般来说，绝大部分应用程序会推送基于JSON的文本消息。

现代浏览器都已经支持WebSocket协议，服务器则需要底层框架支持。Java的Servlet规范从3.1开始支持WebSocket，所以，必须选择支持Servlet 3.1或更高规范的Servlet容器，才能支持WebSocket。最新版本的Tomcat、Jetty等开源服务器均支持WebSocket。

我们以实际代码演示如何在Spring MVC中实现对WebSocket的支持。首先，我们需要在pom.xml中加入以下依赖：

• org.apache.tomcat.embed:tomcat-embed-websocket:10.1.1
• org.springframework:spring-websocket:6.0.0

第一项是嵌入式Tomcat支持WebSocket的组件，第二项是Spring封装的支持WebSocket的接口。

接下来，我们需要在AppConfig中加入Spring Web对WebSocket的配置，先增加一个@EnableWebSocket注解，然后创建一个WebSocketConfigurer实例：

@Configuration @ComponentScan @EnableWebMvc @EnableWebSocket // 启用WebSocket支持 public class AppConfig { @Bean WebSocketConfigurer createWebSocketConfigurer( @Autowired ChatHandler chatHandler, @Autowired ChatHandshakeInterceptor chatInterceptor) { return new WebSocketConfigurer() { public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { // 把URL与指定的WebSocketHandler关联，可关联多个: registry.addHandler(chatHandler, "/chat").addInterceptors(chatInterceptor); } }; } ... }

此实例在内部通过WebSocketHandlerRegistry注册能处理WebSocket的WebSocketHandler，以及可选的WebSocket拦截器HandshakeInterceptor。我们注入的这两个类都是自己编写的业务逻辑，后面我们详细讨论如何编写它们，这里只需关注浏览器连接到WebSocket的URL是/chat。

处理WebSocket连接

和处理普通HTTP请求不同，没法用一个方法处理一个URL。Spring提供了TextWebSocketHandler和BinaryWebSocketHandler分别处理文本消息和二进制消息，这里我们选择文本消息作为聊天室的协议，因此，ChatHandler需要继承自TextWebSocketHandler：

@Component public class ChatHandler extends TextWebSocketHandler { ... }

当浏览器请求一个WebSocket连接后，如果成功建立连接，Spring会自动调用afterConnectionEstablished()方法，任何原因导致WebSocket连接中断时，Spring会自动调用afterConnectionClosed方法，因此，覆写这两个方法即可处理连接成功和结束后的业务逻辑：

@Component public class ChatHandler extends TextWebSocketHandler { // 保存所有Client的WebSocket会话实例: private Map<String, WebSocketSession> clients = new ConcurrentHashMap<>(); @Override public void afterConnectionEstablished(WebSocketSession session) throws Exception { // 新会话根据ID放入Map: clients.put(session.getId(), session); session.getAttributes().put("name", "Guest1"); } @Override public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception { clients.remove(session.getId()); } }

每个WebSocket会话以WebSocketSession表示，且已分配唯一ID。和WebSocket相关的数据，例如用户名称等，均可放入关联的getAttributes()中。

用实例变量clients持有当前所有的WebSocketSession是为了广播，即向所有用户推送同一消息时，可以这么写：

String json = ... TextMessage message = new TextMessage(json); for (String id : clients.keySet()) { WebSocketSession session = clients.get(id); session.sendMessage(message); }

我们发送的消息是序列化后的JSON，可以用ChatMessage表示：

public class ChatMessage { public long timestamp; public String name; public String text; }

每收到一个用户的消息后，我们就需要广播给所有用户：

@Component public class ChatHandler extends TextWebSocketHandler { ... @Override protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception { String s = message.getPayload(); String r = ... // 根据输入消息构造待发送消息 broadcastMessage(r); // 推送给所有用户 } }

如果要推送给指定的几个用户，那就需要在clients中根据条件查找出某些WebSocketSession，然后发送消息。