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

内容概要
炉石使用Google.ProtocolBuffers来处理网络消息,这里我们就分析一下消息打包、解包等代码是适合实现的。

【欢迎转载,请注明作者:燕良,原文出处:游戏程序员的自我修养

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

整体机制描述

我们想要达到的目标大概是这样的:

炉石使用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.BytesReceived()“中实现的。当收到完整数据包时,会在主线程中触发”OnPacketCompleted“事件,实际上会调用到”ConnectAPI.PacketReceived()“,其内部主要是调用了”ConnectAPI.QueuePacketReceived()“,这个函数负责将TCP层接收到的byte[]解析成对应的IMessage对象。

重点来了!由于网络层发过来的数据包,只包含一个消息ID,那么客户端就需要解决从ID找到相应的消息Type的问题。想象中无非有两种方式去做:1是手动记录每个ID对应的Type;2是搞一个中间的对应关系的类,附加上自定义的Attribute,然后在使用反射机制自动收集这些类,其实和前者也差不多。炉石采用了第一种方式。整体机制是这样的:

    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来处理网络消息的机制就是这样,是不是已经很清晰啦!