源碼分析系列之PomeloForEgret

在我上一個手游項目中，前端使用的是白鷺引擎，后端使用的框架是pomelo，前端使用的網(wǎng)絡(luò)庫是pomelo提供給白鷺的，可以在git上拿到這份源代碼，或者應(yīng)該pomelo的官網(wǎng)也可以找到。

本文是對這份PomeloForEgret源碼的分析。一個完整的客戶端網(wǎng)絡(luò)庫應(yīng)該包括初始化，握手，發(fā)送心跳包，協(xié)議數(shù)據(jù)的發(fā)送和接收。PomeloForEgret基于websocket，完整的包含了上述的功能，數(shù)據(jù)的發(fā)送和接收同時支持json數(shù)據(jù)和根據(jù)protobuf數(shù)據(jù)結(jié)構(gòu)協(xié)議序列化的二進制數(shù)據(jù)。本文主要對協(xié)議數(shù)據(jù)的發(fā)送和接收的部分進行解讀。

先介紹下PomeloForEgret主要的包含的類：Pomelo，Package，Message，Protocol，Protobuf。Pomelo是跟外界交互的業(yè)務(wù)邏輯類，而Package，Message，Protocol和Protobuf類作為Pomelo的工具類。

Message的數(shù)據(jù)傳送類型包括TYPE_REQUEST，TYPE_NOTIFY，TYPE_RESPONSE，TYPE_PUSH。

Package的業(yè)務(wù)類型包括TYPE_HANDSHAKE，TYPE_HANDSHAKE，TYPE_HEARTBEAT，TYPE_DATA，TYPE_KICK。

一、 協(xié)議的數(shù)據(jù)發(fā)送數(shù)據(jù)
協(xié)議的數(shù)據(jù)發(fā)送需要經(jīng)過以下3個流程：

1. Pomelo類的request方法。
   requet(route,msg,cg)有以下三個步驟：
   a. reqId++
   b. sendMessage(reqId,route,msg)
   c. callbacks[reqId]=cb，routeMap[reqId]=route，保存協(xié)議發(fā)送的回調(diào)，這個回調(diào)用來處理同一次同一個協(xié)議(路由)返回的數(shù)據(jù)。
2. Pomelo的sendMessage方法，就是上面的1.b方法。
   sendMessage(reqId,route,msg)有以下步驟：
   a. byte:egrete.ByteArray
   b. this._message.encode(reqId,route,msg)，利用Message工具類對發(fā)送的數(shù)據(jù)序列化成二進制數(shù)據(jù)(需要用到Protobuf工具類或Protocol工具類)。
   c. this._package.encode(Package.TYPE_DATA,byte)，利用Package工具類，加上Package的業(yè)務(wù)類型(見上)，后面加上2.b步驟的二進制數(shù)據(jù)，寫入字節(jié)流。
3. Pomelo的send方法。
   a． this.socket.writeByte(byte)
   b． this.socket.flush

特別的，上面的2.b和2.c的步驟具體如下：
2.b Message的encode方法將協(xié)議發(fā)送的數(shù)據(jù)進行序列化：
把Message的數(shù)據(jù)傳送類型(見上)寫入字節(jié)流。
把reqId寫入字節(jié)流。
把路由寫入字節(jié)流。
利用Protobuf或Protocol工具類把協(xié)議的數(shù)據(jù)寫入字節(jié)流，具體如下[tag,type][value] [tag,type][value] [tag,type][value]……。
所以message的字節(jié)流應(yīng)該是這樣的：[傳送類型][reqId][route][protobuf序列化數(shù)據(jù)]
2.c Package的encode方法步驟如下：
寫入Package業(yè)務(wù)類型(見上)。
寫入2.b生成的二進制數(shù)據(jù)長度，占3個字節(jié)。
寫入2.b生成的二進制。

所以package的字節(jié)流應(yīng)該這樣的：[業(yè)務(wù)類型][message的數(shù)據(jù)長度占3個字節(jié)][Message的數(shù)據(jù)]

2. 協(xié)議的數(shù)據(jù)接收。
   協(xié)議的數(shù)據(jù)接收主要包括以下的步驟：

3. this._package.decode(byte)：
   a． 讀取Package的業(yè)務(wù)類型(見上)。
   b． 讀取message的長度
   c． 讀取message。
   return {type:type，body:body，length:len}

4. this._message.decode(data)：
   a．Message的數(shù)據(jù)傳送類型(見上)。
   b．讀取reqId。
   c．讀取路由
   d．利用Protobuf或Protocol類將2.c的message數(shù)據(jù)轉(zhuǎn)化為對象或者所需的數(shù)據(jù)。

協(xié)議的數(shù)據(jù)發(fā)送和接受的流程是反過來一一對應(yīng)的。

最后再貼下Protobuf類序列化和反序列化無符號int的寫法，感覺挺巧妙的：

完。