egret websocket连接笔记

---

egret.websocket的使用

---

egret.WebSocket 类启用代码以建立传输控制协议 (TCP) 套接字连接，用于发送和接收字符串或二进制数据。套接字以异步方式传输和接收数据。

//下面上socket实例

public Connect(ip:string,port:number){

    //创建 WebSocket 对象
    this.socket = new egret.WebSocket();
    //设置数据格式为二进制，默认为字符串
    this.socket.type = egret.WebSocket.TYPE_BINARY;
    //添加收到数据侦听，收到数据会调用此方法
    this.socket.addEventListener(egret.ProgressEvent.SOCKET_DATA, (e:egret.Event)=>{
        this.socket.readBytes(this._recvCache, this._recvCache.length);
        
        this.handler()
    }, this);

    //添加链接打开侦听，连接成功会调用此方法
    this.socket.addEventListener(egret.Event.CONNECT,(e:egret.Event)=>{
        this.trace("WebSocketOpen");
    }, this);

    //添加链接关闭侦听，手动关闭或者服务器关闭连接会调用此方法
    this.socket.addEventListener(egret.Event.CLOSE,(e:egret.Event)=>{
        this.trace("WebSocketClose");
    }, this);

    //添加异常侦听，出现异常会调用此方法
    this.socket.addEventListener(egret.IOErrorEvent.IO_ERROR, (e:egret.Event)=>{
        this.trace("WebSocketError");
    }, this);

    this.socket.connect(ip, port);
}


public SendString(id:number,str:string){

    let body = new egret.ByteArray();
    body.writeUTFBytes(str);
    body.position = 0;
    let msg  = new egret.ByteArray();
    msg.writeShort(body.length+2);
    msg.writeShort(id);
    msg.writeBytes(body)

    var len: number = body.length;

    if(len > 0){ 
        this.socket.writeBytes(msg);
        this.socket.flush();
    }
}

/** 接受到数据时调用此函数 */
private handler():void{

    if(this._recvCache.length == 0){
        return;
    }
    
    while(this._recvCache.bytesAvailable >= 2){

        if(this._messageLength == -1){
            this._messageLength = this._recvCache.readUnsignedShort()-2;
        } 
        if(this._messageId == -1){
            this._messageId = this._recvCache.readUnsignedShort();
        }
        
        if(this._messageLength <= this._recvCache.bytesAvailable){
            if(this._messageLength==0){
                this.parseData(this._messageId , null);
            }else{
                let _data = new egret.ByteArray();
                this._recvCache.readBytes(_data, 0, this._messageLength);
                this.parseData(this._messageId , _data);
            }
    
            this._messageId = -1;
            this._messageLength = -1;
        } 
        else{
            break;
        }
    }
    
    if(this._recvCache.position == this._recvCache.length){
        this._recvCache.clear();
    }
}

private _msgCount:number=0;
private parseData(ID:number,messageByte:egret.ByteArray) : void{

    if(ID<=0){
        console.log("webSocket 错误！parseData：messageID < =0");
        return;
    }
    
    //根据消息获取数据具体类型
    if(framework.net.Protobuf.Ins.IdByClassName(ID.toString())){

        var clazz:any = framework.net.Protobuf.Ins.GetIdByClass(ID.toString(),messageByte);
        if(data.Config.IsDebug)
            console.log("socket handler message type:",ID,"clsss:",clazz.toString()," index:",this._msgCount++);

        core.Controller.Ins.SendName(Socket.SocketMessageEvent,[ID.toString(),clazz]);
        //core.Controller.Ins.SendName(ID.toString(),messageByte);
    }else
        if(Game.Ins.Config.IsDebug)console.log("错误,无法解析消息，消息ID：",ID);

    return;
}


private trace(msg:any):void {
    console.log(msg);
}

该例发送和接收 格式是

allmessage.length + id + content，

即2个字节的消息体总长度 + 2个字节的消息ID + 消息内容

所以算长度时发送时 是内容的length + 2，接收消息算长度时都需要 - 2来处理，每接收到消息都会判断 while(this._recvCache.bytesAvailable >= 2) 则代表消息内容存在，if(this._messageLength <= this._recvCache.bytesAvailable) 则是为了确保消息的准确性

---

2019.2.13

本文中数据类型采用protobuf存储

以下根据消息ID，以及流数据，创建具体实类

let className:string =this.IdByClassName(ID);
let cls = this.protobuff.build(className);  
if(message == null){
      return new cls();
}
if(!className){
      if(Game.Ins.Config.IsDebug)console.log("错误,无法解析消息，消息ID：",ID,'将返回结果滞空来跳过该类');
          return null;
}
return cls.decode(message.buffer);