Protobuf 在Unity中的使用

什么是Protobuf

Google官方描述的大致意思为：

1. protocol buffers 是一种语言无关、平台无关、可扩展的序列化结构数据的方法，它可用于（数据）通信协议、数据存储等。
2. 灵活 高效的序列化数据结构的方法，比json和xml高效，并拥有强大的可拓展性以及良好的兼容性

因其更小的体积和更快的解析速度，所以Protobuf多用于网络数据交换。在说使用之前首先我们应该先把需要用到的资源下载下来并进行必要的配置

Protobuf和Protoc的下载

Protobuf和Protoc下载链接：https://github.com/protocolbuffers/protobuf/releases

Protobuf编译成Dll文件

用VS打开：protobuf-3.19.3/csharp/src/Google.Protobuf.sln

如果有输出如下错误，那就是因为vs使用的dotnet core sdk版本过高和proto工程里使用的sdk版本不一致导致的。可以打开视图/终端在命令行里通过dotnet --version 查看当前系统使用的dotnet core sdk版本，然后修改 proto 工程根目录的 global.json 文件中 sdk 版本号来解决。
Detailed Information: Unable to locate the .NET Core SDK. Check that it is installed and that the version specified in global.json (if any) matches the installed version.

右键选中 Google.Protobuf 执行生成，即可生成 Google.Protobuf.dll 文件。生成的 dll 文件位于 bin/Debug 目录下。默认是生成 .Net 4.5的 dll，放在 net45 目录下。

将net45目录下的所有文件拷贝到Unity工程中的Plugins文件夹下。

Protoc的使用

Protoc主要是用来将proto脚本转化为c# 脚本的。

下载Protobuf-Unity插件放入Unity工程
Protobuf-Unity下载链接：https://github.com/5argon/protobuf-unity

Unity工程打开Editor/Preferences/Protobuf并将下载的Protoc路径填入Path to protoc中
这个插件可以遍历Unity工程目录下的所有proto文件，并生成对应的c#文件。

使用

Proto语言指南：https://developers.google.com/protocol-buffers/docs/proto3
首先手写一个proto格式的脚本，假设脚本名字叫ProtoTest.proto,并将这个proto脚本放入Unity工程中，proto脚本如下：

syntax = "proto3";

message SJL {
  string name = 1;
  int32 age = 2;
  int32 height = 3;
}

Unity工程打开Editor/Preferences/Protobuf点击Force Compilation会在ProtoTest.proto文件所属的文件夹下自动生成一个ProtoTest.cs脚本，这个脚本就是由proto文件转化来的。

写一个测试脚本来测试序列化和反序列化，如下：

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

public class Demo : MonoBehaviour
{
    public string fileName = "sjl.txt";
    private string dirPath = Application.streamingAssetsPath + "/";
    private string filePath;
    public Button WriteBtn;
    public Button ReadBtn;

    void Start()
    {
        if (!Directory.Exists(dirPath))
        {
            Directory.CreateDirectory(dirPath);
#if UNITY_EDITOR
            UnityEditor.AssetDatabase.Refresh();
#endif
        }

        filePath = dirPath + fileName;
        WriteBtn.onClick.AddListener(WriteTo);
        ReadBtn.onClick.AddListener(ReadFrom);
    }

    /// 

    /// 序列化对象并保存到本地
    /// 
    public void WriteTo()
    {
        SJL sr = new SJL()
        {
            Name = "sjl",
            Age = 26,
            Height = 176
        };

        using (FileStream fs = File.OpenWrite(filePath))
        {
            byte[] bytes = sr.ToByteArray();
            fs.Write(bytes, 0, bytes.Length);
        }
#if UNITY_EDITOR
        UnityEditor.AssetDatabase.Refresh();
#endif
    }

    /// 

    /// 反序列化文件
    /// 
    public void ReadFrom()
    {
        using (Stream stream = File.OpenRead(filePath))
        {
            SJL sjl = SJL.Parser.ParseFrom(stream);
            Debug.LogFormat("Name:{0} Age:{1} Height:{2}", sjl.Name, sjl.Age, sjl.Height);
        }
    }
}

测试结果如下：

Demo 下载