Tomcat 实现WebSocket详细介绍

tomcat 如何实现websocket

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

此时如果服务器端支持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=

完成如上握手后，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();        
      }
    }
  }
}

这个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协议的支持。

感谢阅读，希望能帮助到大家，谢谢大家对本站的支持！