源码分析系列之PomeloForEgret

Erick 2019-10-27

在我上一个手游项目中,前端使用的是白鹭引擎,后端使用的框架是pomelo,前端使用的网络库是pomelo提供给白鹭的,可以在git上拿到这份源代码,或者应该pomelo的官网也可以找到。

本文是对这份PomeloForEgret源码的分析。一个完整的客户端网络库应该包括初始化,握手,发送心跳包,协议数据的发送和接收。PomeloForEgret基于websocket,完整的包含了上述的功能,数据的发送和接收同时支持json数据和根据protobuf数据结构协议序列化的二进制数据。本文主要对协议数据的发送和接收的部分进行解读。

先介绍下PomeloForEgret主要的包含的类:Pomelo,Package,Message,Protocol,Protobuf。Pomelo是跟外界交互的业务逻辑类,而Package,Message,Protocol和Protobuf类作为Pomelo的工具类。

Message的数据传送类型包括TYPE_REQUEST,TYPE_NOTIFY,TYPE_RESPONSE,TYPE_PUSH。

Package的业务类型包括TYPE_HANDSHAKE,TYPE_HANDSHAKE,TYPE_HEARTBEAT,TYPE_DATA,TYPE_KICK。

一、 协议的数据发送数据
协议的数据发送需要经过以下3个流程:

  1. Pomelo类的request方法。
    requet(route,msg,cg)有以下三个步骤:
    a. reqId++
    b. sendMessage(reqId,route,msg)
    c. callbacks[reqId]=cb,routeMap[reqId]=route,保存协议发送的回调,这个回调用来处理同一次同一个协议(路由)返回的数据。
  2. Pomelo的sendMessage方法,就是上面的1.b方法。
    sendMessage(reqId,route,msg)有以下步骤:
    a. byte:egrete.ByteArray
    b. this._message.encode(reqId,route,msg),利用Message工具类对发送的数据序列化成二进制数据(需要用到Protobuf工具类或Protocol工具类)。
    c. this._package.encode(Package.TYPE_DATA,byte),利用Package工具类,加上Package的业务类型(见上),后面加上2.b步骤的二进制数据,写入字节流。
  3. Pomelo的send方法。
    a. this.socket.writeByte(byte)
    b. this.socket.flush

特别的,上面的2.b和2.c的步骤具体如下:
2.b Message的encode方法将协议发送的数据进行序列化:
把Message的数据传送类型(见上)写入字节流。
把reqId写入字节流。
把路由写入字节流。
利用Protobuf或Protocol工具类把协议的数据写入字节流,具体如下[tag,type][value] [tag,type][value] [tag,type][value]……。
所以message的字节流应该是这样的:[传送类型][reqId][route][protobuf序列化数据]
2.c Package的encode方法步骤如下:
写入Package业务类型(见上)。
写入2.b生成的二进制数据长度,占3个字节。
写入2.b生成的二进制。

所以package的字节流应该这样的:[业务类型][message的数据长度占3个字节][Message的数据]

  1. 协议的数据接收。
    协议的数据接收主要包括以下的步骤:
  2. this._package.decode(byte):
    a. 读取Package的业务类型(见上)。
    b. 读取message的长度
    c. 读取message。
    return {type:type,body:body,length:len}

  3. this._message.decode(data):
    a.Message的数据传送类型(见上)。
    b.读取reqId。
    c.读取路由
    d.利用Protobuf或Protocol类将2.c的message数据转化为对象或者所需的数据。

协议的数据发送和接受的流程是反过来一一对应的。

最后再贴下Protobuf类序列化和反序列化无符号int的写法,感觉挺巧妙的:
源码分析系列之PomeloForEgret
源码分析系列之PomeloForEgret

完。

相关推荐