使用WebSocket

共计 4332 个字符，预计需要花费 11 分钟才能阅读完成。

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 的配置，此处我们需要创建一个 WebSocketConfigurer 实例：

@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，然后发送消息。

注意到我们在注册 WebSocket 时还传入了一个 ChatHandshakeInterceptor，这个类实际上可以从HttpSessionHandshakeInterceptor 继承，它的主要作用是在 WebSocket 建立连接后，把 HttpSession 的一些属性复制到 WebSocketSession，例如，用户的登录信息等：

@Component
public class ChatHandshakeInterceptor extends HttpSessionHandshakeInterceptor {public ChatHandshakeInterceptor() {// 指定从 HttpSession 复制属性到 WebSocketSession:
        super(List.of(UserController.KEY_USER));
    }
}

这样，在 ChatHandler 中，可以从 WebSocketSession.getAttributes() 中获取到复制过来的属性。

客户端开发

在完成了服务器端的开发后，我们还需要在页面编写一点 JavaScript 逻辑：

// 创建 WebSocket 连接:
var ws = new WebSocket('ws://' + location.host + '/chat');
// 连接成功时:
ws.addEventListener('open', function (event) {console.log('websocket connected.');
});
// 收到消息时:
ws.addEventListener('message', function (event) {console.log('message:' + event.data);
    var msgs = JSON.parse(event.data);
    // TODO:
});
// 连接关闭时:
ws.addEventListener('close', function () {console.log('websocket closed.');
});
// 绑定到全局变量:
window.chatWs = ws;

用户可以在连接成功后任何时候给服务器发送消息：

var inputText = 'Hello, WebSocket.';
window.chatWs.send(JSON.stringify({text: inputText}));

最后，连调浏览器和服务器端，如果一切无误，可以开多个不同的浏览器测试 WebSocket 的推送和广播。

和上一节我们介绍的异步处理类似，Servlet 的线程模型并不适合大规模的长链接。基于 NIO 的 Netty 等框架更适合处理 WebSocket 长链接，我们将在后面介绍。

练习

使用 WebSocket 编写一个聊天室。

下载练习

小结

在 Servlet 中使用 WebSocket 需要 3.1 及以上版本；

通过 spring-websocket 可以简化 WebSocket 的开发。