《炉石传说》架构设计赏析(7):使用Google.ProtocolBuffers处理网络消息

发表于2015-07-29
评论0 800浏览

想免费获取内部独家PPT资料库?观看行业大牛直播?点击加入腾讯游戏学院游戏程序行业精英群

711501594
这段时间琢磨了一下unity3D网络游戏开发中的网络消息处理。网络游戏的服务端一般都是自主开发的,所以对应的网络消息处理也要自己开发。客户端/服务端之间的消息传到目前使用JSON和Google.ProtocolBuffers是两种常见的做法。打开炉石的代码看了看它的处理方式,感觉代码写的还是很好的,把它的思路分析一下,与大家分享。

整体机制描述

我们想要达到的目标大概是这样的:
有N个网络消息,每个消息对应一个Proto中的message描述;
每个消息对应一个数字ID;
底层在收到消息是,将其解析成为Google.ProtocolBuffers.IMessage对象,这个对象的具体类型应该是前面那个message生成的代码;
发送消息就简单了,因为知道其类型,可以直接执行序列化;
炉石使用Google.ProtocolBuffers类库,可以看这里:http://www.nuget.org/packages/Google.ProtocolBuffers/
消息发送

发送的机制很简单,首先使用ProtocolBuffer生成的message类构造一个消息对象,例如:

ConnectAPI.SendPing()

public static void SendPing()
{
    Ping.Builder body = Ping.CreateBuilder();
    QueueGamePacket(0x73, body);
    s_lastGameServerPacketSentTime = DateTime.Now;
}


底层会构造一个“PegasusPacket”数据包对象,添加到发送队列之中,这个数据包对象主要包含3部分:消息ID,消息大小,具体消息数据。详见PegasusPacket.Encode()函数:

public override byte[] Encode()
{
    if (!(this.Body is IMessageLite))
    {
        return null;
    }
    IMessageLite body = (IMessageLite) this.Body;
    this.Size = body.SerializedSize;
    byte[] destinationArray = new byte[8 + this.Size];
    Array.Copy(BitConverter.GetBytes(this.Type), 0, destinationArray, 0, 4);
    Array.Copy(BitConverter.GetBytes(this.Size), 0, destinationArray, 4, 4);
    body.WriteTo(CodedOutputStream.CreateInstance(destinationArray, 8, this.Size));
    return destinationArray;
}


消息接收与解析

接下来我们重点看一下消息的接收与解析机制。首先因为TCP是流式的,所以底层应该检测数据包头,并收集到一个完整的数据包,然后再发送到上层解析,这部分逻辑是在”ClientConnection<PacketType>.BytesReceived()“中实现的。当收到完整数据包时,会在主线程中触发”OnPacketCompleted“事件,实际上会调用到”ConnectAPI.PacketReceived()“,其内部主要是调用了”ConnectAPI.QueuePacketReceived()“,这个函数负责将TCP层接收到的byte[]解析成对应的IMessage对象。

重点来了!由于网络层发过来的数据包,只包含一个消息ID,那么客户端就需要解决从ID找到相应的消息Type的问题。想象中无非有两种方式去做:1是手动记录每个ID对应的Type;2是搞一个中间的对应关系的类,附加上自定义的Attribute,然后在使用反射机制自动收集这些类,其实和前者也差不多。炉石采用了第一种方式。整体机制是这样的:
客户端每个消息对应一个PacketDecoder的派生类对象;
ConnectAPI类使用一个字典,用来保存<消息ID,Decoder对象>之间的对应关系:ConnectAPI.s_packetDecoders:SortedDictionary<Int32,ConnectAPI.PacketDecoder>;
如果每个消息都要写一个Decoder,而其内部代码由完全一致,岂不是很蛋疼?!好吧,我们用模板来实现,详见后续分析;
在ConnectAPI.ConnectInit()初始化的时候,创建Decoder对象,并保存到上述dict之中,类似这样:

s_packetDecoders.Add(0x74, new DefaultProtobufPacketDecoder<Pong, Pong.Builder>());

最后在上述的收到完整数据包的函数中,根据数据包中记录的消息ID,去查找Decoder,然后调用其方法得到具体的消息对象,类似这样:

if (s_packetDecoders.TryGetValue(packet.Type, out decoder))
{
    PegasusPacket item = decoder.HandlePacket(packet);
    if (item != null)
    {
        queue.Enqueue(item);
    }
}
else
{
    Debug.LogError("Could not find a packet decoder for a packet of type " + packet.Type);
}

最后我们看一下,Decoder模板的实现技巧。首先消息解析的具体操作是有Google.ProtocolBuffers生成的代码去实现的,所以具体操作流程是完全一致的,这些写到基类的的静态模板函数中:

public abstract class PacketDecoder
{
    // Methods
    public abstract PegasusPacket HandlePacket(PegasusPacket p);
    public static PegasusPacket HandleProtoBuf<TMessage, TBuilder>(PegasusPacket p) where TMessage: IMessageLite<TMessage, TBuilder> where TBuilder: IBuilderLite<TMessage, TBuilder>, new()
    {
        byte[] body = (byte[]) p.Body;
        TBuilder local2 = default(TBuilder);
        TBuilder local = (local2 == null) ? Activator.CreateInstance<TBuilder>() : default(TBuilder);
        p.Body = local.MergeFrom(body).Build();
        return p;
    }
}


其次,使用一个模板派生类,实现HandlePacket()这个虚函数,主要的目的只是把TMessage和TBuilder这两个类型传给那个静态函数而已:

public class DefaultProtobufPacketDecoder<TMessage, TBuilder> : ConnectAPI.PacketDecoder where TMessage: IMessageLite<TMessage, TBuilder> where TBuilder: IBuilderLite<TMessage, TBuilder>, new()
{
    // Methods
    public override PegasusPacket HandlePacket(PegasusPacket p)
    {
        return ConnectAPI.PacketDecoder.HandleProtoBuf<TMessage, TBuilder>(p);
    }
}


OK,炉石是使用使用ProtocolBuffers来处理网络消息的机制就是这样,是不是已经很清晰啦!
喜欢《炉石传说》系列文章的话,欢迎大家关注楼主的博客:http://blog.csdn.net/neil3d,并且欢迎大家到我的QQ群来交流:264656505

原文链接

著作权归作者所有,商业转载请联系作者获得授权,非商业转载请注明出处。

如社区发表内容存在侵权行为,您可以点击这里查看侵权投诉指引

游戏学院公众号二维码
腾讯游戏学院
微信公众号

提供更专业的游戏知识学习平台