Java实现WebSocket服务

简介: Java可以使用Tomcat提供的WebSocket库接口实现WebSocket服务,代码编写也非常的简单。现在的H5联网游戏基本上都是使用WebSocket协议,基于长连接,服务器可以主动推送消息,而不是传统的网页采用客户端轮询的方式获取服务器的消息。下面给出简单使用Tomcat的WebSocket服务的基本代码结构。

Java实现WebSocket服务


一、使用Tomcat提供的WebSocket库


   Java可以使用Tomcat提供的WebSocket库接口实现WebSocket服务,代码编写也非常的简单。现在的H5联网游戏基本上都是使用WebSocket协议,基于长连接,服务器可以主动推送消息,而不是传统的网页采用客户端轮询的方式获取服务器的消息。下面给出简单使用TomcatWebSocket服务的基本代码结构。


@ServerEndpoint("/webSocket")  
public class WebSocket {  
  @OnOpen
  public void onOpen(Session session) throws IOException{
    logger.debug("新连接");
  }
  @OnClose
  public void onClose(){
    logger.debug("连接关闭");
  }
  @OnMessage
  public void onMessage(String message, Session session) throws IOException {
    logger.debug("收到消息");
  }
  @OnError
  public void onError(Session session, Throwable error){
    error.printStackTrace();
  }
}


二、WebSocket协议的整个流程


   1. 基于TCP协议


       WebSocket本质是基于TCP协议的,采用Java编写WebSocket服务时可以使用NIO或者AIO实现高并发的服务。


   2. 握手过程


       客户端采用TCP协议连接服务器指定端口后,首先需要发送一条HTTP的握手协议


GET /web HTTP/1.1
Upgrade: websocket
Connection: Upgrade
Host: 127.0.0.1:8001
Origin: http://127.0.0.1:8001
Sec-WebSocket-Key: hj0eNqbhE/A0GkBXDRrYYw==
Sec-WebSocket-Version: 13


       请求的头里面必须包含以下内容:    

 

           1. Connection 其值为Upgrade,表示升级协议


           2. Upgrade  其值为websocket,表示升级为WebSocket协议


          3. Sec-WebSocket-Key 客户端发送给服务器的密钥,用于标识每个客户端,其值是16位的随机base64编码。


           4. Sec-WebSocket-Version WebSocket的协议版本


       服务器收到这条协议验证成功后进行协议升级,并且不会关闭
Socket连接,并发送给客户端响应升级握手成功的HTTP协议包。


HTTP/1.1 101 Switching Protocols
Content-Length: 0
Upgrade: websocket
Sec-Websocket-Accept: ZEs+c+VBk8Aj01+wJGN7Y15796g=
Connection: Upgrade
Date: Wed, 21 Jun 2017 03:29:14 GMT


       响应的协议包里面,首先是101的状态码,更换协议;其中最重要的就是Sec-WebSocket-Accept字段。其值是通过客户端的Key加上固定的"258EAFA5-E914-47DA-95CA-C5AB0DC85B11"密钥,通过采用16位的base64编码后发送给客户端验证,如果客户端也验证成功就表示握手完成。


String acc = secKey + WEBSOCK_MAGIC_TAG;
MessageDigest sh1 = MessageDigest.getInstance("SHA1");
String key = Base64.getEncoder().encodeToString(sh1.digest(acc.getBytes()));


   3. 数据的读写


       握手成功后就可以进行数据发送和读取,WebSocket的数据可以是二进制或者纯文本。每次读取和发送数据需要打包成帧数据,需要按照其标准的格式进行发送或读取才能够正常的进行数据通信。


微信图片_20220424143341.png


       上图就是帧数据的结构图,解析帧数据的代码如下,由于是摘录的部分代码,所以只能作为理解和参考,不可直接使用。


protected WebSocketFrameData ParseFrame(NetPacketBuffer bytes){
   bytes.mark();
   WebSocketFrameData frame = new WebSocketFrameData();
   int opData = bytes.readByte();
   frame.UnPackOpCodeHeader(opData); // 第一步
   int length = frame.UnPackMaskHeader(bytes.readByte()); // 第二步
   // 读取长度
   if (length == 126) {
      length = bytes.readShort();
   } else if (length == 127){
      length = (int) bytes.readInt64();
   }
   // 数据不足,进来的是半包
   if(length + 4 > bytes.remaining()){
      bytes.reset(); //
      return null;
   }
   // 读取mask if frame.mMasked 
   byte[] masks = new byte[4]; // 第三步
   for (int i = 0; i < 4; i++) {
      masks[i] = (byte) bytes.readByte();
   }
   frame.mLength = length;
   frame.mData = bytes.readMulitBytes(length);
   frame.MaskData(masks);  // 第四步
   return frame;
}


       上面代码中第一步是解析出当前帧是否是最后帧mFin标记、操作码mOpCode,采用位处理,具体的实现如下。


public void UnPackOpCodeHeader(int opData){
  mRsv1 = (opData & 64) == 64;
  mRsv2 = (opData & 32) == 32;
  mRsv3 = (opData & 16) == 16;
  mFin = (opData & 128) == 128;
  mOpCode = (opData & 15);
}


       第二步在读取长度前,先解析当前帧是否有采用Mask掩码加密处理,并且里面有可能包含整个帧的长度信息,具体看上面的判断代码。


public int UnPackMaskHeader(int mkData){
  mMasked = (mkData & 128) == 128;
  return (mkData & 127); // 这里返回的是长度信息
}


       接下来就是读取Mask内容,注意只有客户端发送给服务端时需要采用Mask对数据做处理,服务端发送给客户端时不需要做处理。最后通过Mask掩码解析出真实数据。


public void MaskData(byte[] masks){
  if (!mMasked or masks.length == 0) return ;
  for (int i = 0; i < mLength; i++) {
      mData[i] = (byte) (mData[i] ^ masks[i % 4]);
  }
}


       以上就解析出单帧的数据,帧数据可以分为消息数据(细分为文本数据和二进制数据)、PING包、PONG包、CLOSE包、CONTINUATION包(数据未发送完成包)。而且帧数据又有mFin标记数据是否完整,否则需要将多个帧数据合成一个完整的消息数据。


// 读取帧数据,可能存在多帧数据,因此需要手动拆分
WebSocketFrameData frame = ParseFrame(mCachePacket);
if(frame == null){
  break; // 说明数据不完整,暂不处理。
}
// 不完整的帧的时候,只有第一帧会标记帧的类型
opCode = opCode == -1? frame.mOpCode: opCode; 
mCacheFrame.append(frame.mData, 0, frame.mLength);
if(!frame.mFin) // 非完整的数据不处理。
{
  continue;
}
// 处理完整的数据
switch(opCode)
{
  case WebSocketFrameData.OP_TEXT:
  case WebSocketFrameData.OP_BINARY:
    mCacheFrame.flip();
    this.OnMessage(mCacheFrame, opCode);
    break;
  case WebSocketFrameData.OP_PING:
    this.OnPing(mCacheFrame);
    break;
  case WebSocketFrameData.OP_PONG:
    this.OnPong(mCacheFrame);
    break;
  case WebSocketFrameData.OP_CLOSE:
    this.OnClosed();
    break;
  case WebSocketFrameData.OP_CONTINUATION:
    this.Close();
    break;
}
opCode = -1;
mCacheFrame.clear();


       读取整个客户端的协议数据流程就已经完成了,服务端发送回去的数据就只需要注意两点:


       1. 大的数据包需要分帧数据发送。


       2. 不需要采用Mask掩码加密,因此Mask位置设置为0,并且不写入掩码数据。


三、最后


   WebSocket协议已经在H5的游戏中使用了,学习有助于以后工作中的使用。欢迎微信搜索"游戏测试开发"关注一起沟通交流。

相关文章
|
13天前
|
监控 JavaScript 前端开发
《理解 WebSocket:Java Web 开发的实时通信技术》
【4月更文挑战第4天】WebSocket是Java Web实时通信的关键技术,提供双向持久连接,实现低延迟、高效率的实时交互。适用于聊天应用、在线游戏、数据监控和即时通知。开发涉及服务器端实现、客户端连接及数据协议定义,注意安全、错误处理、性能和兼容性。随着实时应用需求增加,WebSocket在Java Web开发中的地位将更加重要。
|
13天前
|
Java 关系型数据库 MySQL
Elasticsearch【问题记录 01】启动服务&停止服务的2类方法【及 java.nio.file.AccessDeniedException: xx/pid 问题解决】(含shell脚本文件)
【4月更文挑战第12天】Elasticsearch【问题记录 01】启动服务&停止服务的2类方法【及 java.nio.file.AccessDeniedException: xx/pid 问题解决】(含shell脚本文件)
68 3
|
7天前
|
Java API 数据库
利用Java构建高性能的RESTful Web服务
在现代软件开发中,RESTful Web服务已成为一种流行的架构模式,用于构建可扩展、可维护的网络应用。本文将探讨如何使用Java编程语言及其相关框架(如Spring Boot)来构建高性能的RESTful Web服务。我们将不仅仅关注基本的RESTful API设计,还将深入讨论性能优化、安全性、以及服务扩展性等方面的技术细节。通过本文,读者将能够掌握构建高效RESTful Web服务的核心技术和实践。
|
13天前
|
JSON JavaScript 前端开发
KOI 后台新的架构下,webshop如何消费后台服务 - websocket 初始化
KOI 后台新的架构下,webshop如何消费后台服务 - websocket 初始化
13 0
|
13天前
|
JavaScript 小程序 Java
Java毕设之在线医疗服务系统的设计与实现
Java毕设之在线医疗服务系统的设计与实现
20 3
|
13天前
|
小程序 Java 关系型数据库
Java毕设之农产品供销服务系统
Java毕设之农产品供销服务系统
20 2
|
13天前
|
安全 Java API
使用Java构建RESTfulWeb服务
使用Java构建RESTfulWeb服务
12 0
|
13天前
|
Arthas 安全 Java
java服务报错 FileNotFoundException:打开的文件过多
java服务报错 FileNotFoundException:打开的文件过多
18 0
|
13天前
|
定位技术 开发者 UED
基于位置的服务中,WebSocket有哪些用途?
【5月更文挑战第3天】基于位置的服务中,WebSocket有哪些用途?
26 6
|
13天前
|
存储 网络协议 Java
本地MinIO存储服务通过Java程序结合cpolar实现远程连接上传文件
本地MinIO存储服务通过Java程序结合cpolar实现远程连接上传文件