Tomcat如何实现WebSocket

关注

转载最新推荐文章于 2026-06-27 14:12:02 发布 2.4k 阅读 AI 写同款· GEO 优化 ›

在Tomcat中启用虚拟线程特性趁着国庆前后阅读了虚拟线程相关的源码，写了一篇《虚拟线程 - VirtualThread源码透视》，里面介绍了虚拟线程的实现原理和使用示例。线程池甚至可以设计为一个完全自定义的虚拟线程调度器，可以参考前面一篇文章，这里不再赘述。的线程池是最终调用看到的控制台输出的虚拟线程名称是一个空字符串。实现比较简单，就是在控制台打印一些虚拟线程和载体线程的一些信息，然后返回。还没有适配虚拟线程，主要是没有改造监视器锁的引用导致虚拟线程。）使用的是还是旧的规范，对应的类是。，这只是其中一个接口，大部分和。阅读详情

Tomcat如何实现WebSocket

原创 2016年11月25日 10:06:20

标签：
tomcat /
websocket /
html5 /
ajax

WebSocket协议属于HTML5标准，越来越多浏览器已经原生支持WebSocket，它能让客户端和服务端实现双向通信。在客户端和服务器端建立一条WebSocket连接后，服务器端消息可直接发送到客户端，从而打破传统的请求响应模式，避免了无意义的请求。比如传统的方式可能会使用AJAX不断请求服务器端，而WebSocket则可以直接发送数据到客户端且客户端不必请求。同时，由于有了浏览器的原生支持，编写客户端应用程序也变得更加便捷且不必依赖第三方插件。另外，WebSocket协议摒弃了HTTP协议繁琐的请求头，而是以数据帧的方式进行传输，效率更高。

图为WebSocket协议通信的过程，首先客户端会发送一个握手包告诉服务器端我想升级成WebSocket，不知道你服务器端是否同意，这时如果服务器端支持WebSocket协议则会返回一个握手包告诉客户端没问题，升级已确认。然后就成功建立起了一条WebSocket连接，该连接支持双向通信，并且使用WebSocket协议的数据帧格式发送消息。

这里写图片描述

握手过程需要说明下，为了让WebSocket协议能和现有HTTP协议Web架构互相兼容，所以WebSocket协议的握手要基于HTTP协议，比如客户端会发送类似如下的HTTP报文到服务器端请求升级为WebSocket协议，其中包含的Upgrade: websocket就是告诉服务器端我想升级协议：

    GET ws://localhost:8080/hello HTTP/1.1
    Origin: http://localhost:8080
    Connection: Upgrade
    Host: localhost:8080
    Sec-WebSocket-Key: uRovscZjNol/umbTt5uKmw==
    Upgrade: websocket
    Sec-WebSocket-Version: 13
   1
2
3
4
5
6
7

此时如果服务器端支持WebSocket协议，则它会发送一个同意客户端升级协议的报文，具体报文类似如下，其中Upgrade: websocket就是告诉客户端我同意你升级协议：

    HTTP/1.1 101 WebSocket Protocol Handshake
    Date: Fri, 10 Feb 2016 17:38:18 GMT
    Connection: Upgrade
    Server: Kaazing Gateway
    Upgrade: WebSocket
    Sec-WebSocket-Accept: rLHCkw/SKsO9GAH/ZSFhBATDKrU=
   1
2
3
4
5
6

完成如上握手后，HTTP协议连接就被打破，接下去则是开始使用WebSocket协议进行双方通信，这条连接还是原来的那条TCP/IP连接，端口也还是原来的80或443。

下面举一个Tomcat中编写WebSocket的简单例子：

public class HelloWebSocketServlet extends WebSocketServlet {
    private static List<MessageInbound> socketList = new ArrayList<MessageInbound>();

    protected StreamInbound createWebSocketInbound(String subProtocol,HttpServletRequest request){
        return new WebSocketMessageInbound();
    }

    public class WebSocketMessageInbound extends MessageInbound{
        protected void onClose(int status){
            super.onClose(status);
            socketList.remove(this);            
        }
        protected void onOpen(WsOutbound outbound){
            super.onOpen(outbound);
            socketList.add(this);
        }
        @Override
        protected void onBinaryMessage(ByteBuffer message) throws IOException {

        }
        @Override
        protected void onTextMessage(CharBuffer message) throws IOException {
            for(MessageInbound messageInbound : socketList){
                CharBuffer buffer = CharBuffer.wrap(message);
                WsOutbound outbound = messageInbound.getWsOutbound();
                outbound.writeTextMessage(buffer);
                outbound.flush();               
            }
        }
    }
}
   1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

这个Servlet必须要继承WebSocketServlet，接着创建一个继承MessageInbound的WebSocketMessageInbound类，在该类中填充onClose、onOpen、onBinaryMessage和onTextMessage等方法即可完成各个事件的逻辑，其中onOpen会在一个WebSocket连接建立时被调用，onClose会在一个WebSocket关闭时被调用，onBinaryMessage则是Binary方式下接收到客户端数据时被调用，onTextMessage则是Text方式下接收到客户端数据时被调用。上面一段代码实现了一个广播的效果。

按照上面的处理逻辑，Tomcat对WebSocket的集成就不会太难了，就是在处理请求时如果遇到WebSocket协议请求则做特殊处理，保持住连接并在适当的时机调用WebSocketServlet的MessageInbound的onClose、onOpen、onBinaryMessage和onTextMessage等方法。由于WebSocket一般建议在NIO模式下使用，所以看看NIO模式集成WebSocket协议。

如图，对于WebSocket的客户端连接被接收器接收后注册到NioChannel队列中，Poller组件不断轮休是否有NioChannel需要处理，如果有则经过处理管道后进到继承了WebSocketServlet的Servlet上，WebSocketServlet的doGet方法会处理WebSocket握手，告诉返回客户端同意升级协议。往后Poller继续不断轮休相关NioChannel，一旦发现是使用WebSocket协议的管道则会调用MessageInbound的相关方法，完成不同事件的处理，从而实现对WebSocket协议的支持。

这里写图片描述