UN5L7——Protobuf协议使用

本章代码关键字

Google.Protobuf                    // ProtoBuf相关命名空间，该命名空间内有为IMessage的WriteTo方法的拓展方法，使得流可以传入到方法内
iMessage.Writeto()                // 所有的ProtoBuf生成的消息类都继承自IMessage，因此可以调用该方法将自己序列化写入到流内
iMessage.ToByteArray()            // 在Google.Protobuf命名空间中为IMessage拓展的方法，该方法可以直接将类对象序列化为字节数组
messageParser<>.ParseFrom()        // 所有ProtoBuf消息类都有MessageParser<>静态变量，可通过Parse属性调用，它可以将流中的数据或者字节数组反序列化

Protobuf协议使用

Protobuf 的序列化和反序列化都要通过流对象来进行处理

如果是进行本地存储则可以使用文件流
如果是进行网络传输则可以使用内存流获取字节数组

注意：Protobuf 生成的消息类没有为我们自动实现生成消息 ID 和消息体长度的逻辑，
这意味着区分消息逻辑和解决分包黏包问题需要我们自己来处理，例如添加消息 ID 和消息体长度都需要我们自己来做

消息类序列化

注：Writeto() 是 IMessage 内声明的方法，所有的 ProtoBuf 生成的消息类都继承自它

序列化到本地文件

主要使用

生成的类中的 WriteTo() 方法
文件流 FileStream 对象

在初始化了 ProtoBuf 生成的消息类后，我们就可以对其序列化生成为本地文件存储
我们需要使用一个文件流传入到其 WriteTo() 方法内，但是要注意，WriteTo() 方法不支持直接传入文件流
想让 WriteTo() 可以直接传入文件流，需要引入命名空间 Google.Protobuf
因为 Google.Protobuf 命名空间中，有 WriteTo() 的拓展方法，它可以让我们直接传入文件流

using GamePlayerTest;
using Google.Protobuf;
using System.IO;
using UnityEngine;

public class Lesson41 : MonoBehaviour
{
    void Start()
    {
        TestMsg msg = new TestMsg();
        //TestMsg初始化相关
        msg.ListInt.Add(1);
        msg.TestBool = false;
        msg.TestD = 5.5;
        msg.TestMap.Add(1, "唐老狮");
        msg.TestMsg2 = new TestMsg2();
        msg.TestMsg2.TestInt32 = 88;
        msg.TestMsg3 = new TestMsg.Types.TestMsg3();
        msg.TestMsg3.TestInt32 = 66;

        print(Application.persistentDataPath);
        //序列化为本地文件
        using (FileStream fs = File.Create(Application.persistentDataPath + "/TestMsg.Tang"))
        {
            msg.WriteTo(fs);
        }
    }
}

序列化为字节数组

主要使用

生成的类中的 WriteTo 方法
内存流 MemoryStream 对象

获取序列化后的字节数组很简单，使用内存流传入到 WriteTo() 方法内即可，注意引入命名空间 Google.Protobuf

using GamePlayerTest;
using Google.Protobuf;
using System.IO;
using UnityEngine;

public class Lesson41 : MonoBehaviour
{
    // Start is called before the first frame update
    void Start()
    {
        TestMsg msg = new TestMsg();
        msg.ListInt.Add(1);
        msg.TestBool = false;
        msg.TestD = 5.5;
        msg.TestMap.Add(1, "唐老狮");
        msg.TestMsg2 = new TestMsg2();
        msg.TestMsg2.TestInt32 = 88;
        msg.TestMsg3 = new TestMsg.Types.TestMsg3();
        msg.TestMsg3.TestInt32 = 66;

        msg.TestHeart = new GameSystemTest.HeartMsg();
        msg.TestHeart.Time = 7777;
        //序列化到内存流
        using (MemoryStream memoryStream = new MemoryStream())
        {
            msg.WriteTo(memoryStream);
            //通过字节数组获取内存流内数据
            byte[] bytes = memoryStream.ToArray();
            print("字节数组长度：" + bytes);
        }
    }
}

更方便的序列化为字节数组

在 Google.Protobuf 命名空间中，有一个为 IMessage 拓展的方法 ToByteArray()，该方法可以直接将类对象序列化为字节数组

// 序列化Protobuf生成的对象
public static byte[] GetProtoBytes(IMessage msg)
{
    return msg.ToByteArray();
}

消息类反序列化

注：ParseFrom() 是 MessageParser<> 内声明的方法，所有 ProtoBuf 消息类都有该类的静态变量（泛型参数为自己），可通过 Parse 调用它

从本地文件反序列化

主要使用

生成的类中的 Parser.ParseFrom 方法
文件流 FileStream 对象

将读取文件的文件流传入到要接收消息的数据类的 Parser.ParseFrom() 方法内

using GamePlayerTest;
using Google.Protobuf;
using System.IO;
using UnityEngine;

public class Lesson41 : MonoBehaviour
{
    void Start()
    {
        TestMsg msg = new TestMsg();
        msg.ListInt.Add(1);
        msg.TestBool = false;
        msg.TestD = 5.5;
        msg.TestMap.Add(1, "唐老狮");
        msg.TestMsg2 = new TestMsg2();
        msg.TestMsg2.TestInt32 = 88;
        msg.TestMsg3 = new TestMsg.Types.TestMsg3();
        msg.TestMsg3.TestInt32 = 66;

        msg.TestHeart = new GameSystemTest.HeartMsg();
        msg.TestHeart.Time = 7777;
        //序列化为本地文件
        print(Application.persistentDataPath);
        using (FileStream fs = File.Create(Application.persistentDataPath + "/TestMsg.Tang"))
        {
            msg.WriteTo(fs);
        }
        //从本地文件反序列化出来数据
        using (FileStream fs = File.OpenRead(Application.persistentDataPath + "/TestMsg.Tang"))
        {
            print("文件流当中反序列化的内容");
            TestMsg msg2 = TestMsg.Parser.ParseFrom(fs);
            //输出反序列出来的数据
            print(msg2.TestMap[1]);
            print(msg2.ListInt[0]);
            print(msg2.TestD);
            print(msg2.TestMsg2.TestInt32);
            print(msg2.TestMsg3.TestInt32);
            print(msg2.TestHeart.Time);
        }
    }
}

从字节数组反序列化

主要使用

生成的类中的 Parser.ParseFrom 方法
内存流 MemoryStream 对象

从字节数组反序列化很简单，将要反序列化的字节数组传入到内存流的构造方法内，再将内存流传入到 Parser.ParseFrom() 方法内即可

using GamePlayerTest;
using Google.Protobuf;
using System.IO;
using UnityEngine;

public class Lesson41 : MonoBehaviour
{
    void Start()
    {
        TestMsg msg = new TestMsg();
        msg.ListInt.Add(1);
        msg.TestBool = false;
        msg.TestD = 5.5;
        msg.TestMap.Add(1, "唐老狮");
        msg.TestMsg2 = new TestMsg2();
        msg.TestMsg2.TestInt32 = 88;
        msg.TestMsg3 = new TestMsg.Types.TestMsg3();
        msg.TestMsg3.TestInt32 = 66;

        msg.TestHeart = new GameSystemTest.HeartMsg();
        msg.TestHeart.Time = 7777;

        byte[] bytes = null;
        using (MemoryStream memoryStream = new MemoryStream())
        {
            msg.WriteTo(memoryStream);
            bytes = memoryStream.ToArray();
            print("字节数组长度：" + bytes.Length);
        }

        using (MemoryStream memoryStream = new MemoryStream(bytes))
        {
            print("内存流当中反序列化的内容");
            TestMsg msg2 = TestMsg.Parser.ParseFrom(memoryStream);
            print(msg2.TestMap[1]);
            print(msg2.ListInt[0]);
            print(msg2.TestD);
            print(msg2.TestMsg2.TestInt32);
            print(msg2.TestMsg3.TestInt32);
            print(msg2.TestHeart.Time);
        }
    }
}

更方便的从字节数组反序列化

在 MessageParser<> 内同样有更方便的从字节数组中直接反序列化的方法

1
2
3

TestMsg msg = new TestMsg();
byte[] bytes = msg.ToByteArray();
TestMsg msg2 = TestMsg.Parser.ParseFrom(bytes);

由于声明 ParseFrom() 的 MessageParser<> 在 Protobuf 生成的消息类里是静态属性，
因此我们可以通过反射方便的获取该静态属性，进而通过该静态属性反射出 ParseFrom 方法，在通过反射出的消息调用执行该方法

// 反序列化字节数组为Protobuf相关的对象
public static T GetProtoMsg<T>(byte[] bytes) where T : class, IMessage
{
    Type type = typeof(T);
    //通过反射得到对应的静态成员属性对象
    PropertyInfo pInfo = type.GetProperty("Parser");
    object parserObj = pInfo.GetValue(null, null);
    //得到了MeseageParser对象，那么可以得到该对象中的对应方法
    Type parserType = parserObj.GetType();
    //这是通过类型，指定得到某一个重载函数
    MethodInfo mInfo = parserType.GetMethod("ParseFrom", new Type[] { typeof(byte[]) });
    //调用反射得到的方法，反序列化为指定的对象
    object msg = mInfo.Invoke(parserObj, new object[] { bytes });
    return msg as T;
}

‍