Unity之C#端使用protobuf

Posted PassionY

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Unity之C#端使用protobuf相关的知识,希望对你有一定的参考价值。

什么是protobuf

protobuf全称Protocol Buffers,由Google推出的一种平台、语言无关的数据交互格式,目前使用最广泛的一种数据格式,尤其在网络传输过程中,有很强的安全性,而且数据量比json和xml要小很多。
最主要的是protobuf支持的语言非常多,不管你是.net,java,lua,iosandroid,python,go,等等等等。都可以支持互相通信。
我们之前的游戏框架都是lua的,所以protobuf用的也都是lua版本的。最近转用C#写框架了,所以需要一套.net端的protobuf,所以把踩得坑总结下来。

protobuf库选择

protobuf的.net实现主要有两个版本:

  • (Google.Protobuf](https://github.com/protocolbuffers/protobuf)
    Google官方维护,项目前身是protobuf-csharp-port。
    优势:在多平台协作开发时,定义一份协议,可以在各个语言中共用。

  • protobuf-net
    社区维护,主要由Marc Gravell管理维护
    优势:相对来说,更符合.net开发习惯;对于纯粹的.NET程序,使用起来更加方便

google.protobuf使用

如果使用google版本的,那么就可以使用官方提供的最新的语法,最新的工具,等等,官方文档
库下载:
安装Nuget包:Google.Protobuf和Google.Protobuf.Tools
.proto生成.cs代码工具:
直接使用tools中或者从github下载最新的protoc。因google把全平台的proto都整合了统一通过protoc.exe来生成。
生成命令:或可参考https://protobuf.dev/reference/csharp/csharp-generated/

protoc --proto_path=bar --csharp_out=src --csharp_opt=base_namespace=Example player.proto

序列化示例

public void SimplestUse()

    Player player= new Player ();
    player.ID = 2;
    player.Name = "测试 Google.ProtoBuf";

    using (MemoryStream memoryStream = new MemoryStream())
    
        player.WriteTo(memoryStream);
    

protobuf-net使用

使用protobuf-net版本,是目前大多数C#项目所选择的方向,原因大概率是语法习惯比较友好吧。protobuf-net的数据类不仅可以通过.proto生成,还可以手写。不过我觉得可能手写有点太麻烦了。网络交互肯定还是要和服务器公用.proto文件的。
示例:

using ProtoBuf;
namespace Test

    [ProtoContract]
    public class Player
    
        [ProtoMember(1)]
        public int ID  get; set; 

        [ProtoMember(2)]
        public string Name  get; set; 
    

安装Nuget包:protobuf-net和protobuf-net.ProtoGen
目前这两个文件,除了Nuget,我还没有找到纯正的官方途径下载。不过protobuf-net最近没啥更新,所以从哪里下载都是一样的。
生成命令:

protogen.exe -i:player.proto -o:player.cs

序列化示例:

public void SimplestUse()

    Player player= new Player ();
    player.ID = 1;
    player.Name = "测试 protobuf-net";

    using (MemoryStream memoryStream = new MemoryStream())
    
        ProtoBuf.Serializer.Serialize(memoryStream, player);
    

性能比较:

两个库直接性能差距并不是很大,测试数据参考:https://www.shisujie.com/blog/Google-ProtoBuf-vs-ProtoBuf-Net

最后

Unity技术开发干活 - 总目录

Unity精选 - 专栏目录

Unity之ASE入门到精通 - 专栏目录

UniRx入门到精通 - 专栏目录

ProtoBuf在Unity3D中的简单使用!

目前Unity3D依然是移动手机开发的主流开发工具。

而在移动端推荐的打包解包方法是使用Protobuf协议:主要优点就是效率高,传输量小,节省带宽。而想要在Android和IOS端都能使用Protobuf,我使用的方法是把Protobuf-net源代码拷贝到项目中的Scripts文件夹中,而当拷贝到文件夹时会出现如下错误。(文章结尾附有源代码)


我们只需要在Assets目录下创建smcs.rsp文件,并在文件中写入-unsafe,重新编译,即可发现错误消失。

这样前期配置工作就完成了,下面就是简单的编码部分。

1、首先创建一个cs文件,命名为Person.cs,具体源码如下

[ProtoContract]
public class Person 
    [ProtoMember(1)]
    public int Id  get; set; 
    [ProtoMember(2)]
    public string Name  get; set; 
    [ProtoMember(3)]
    public Address Address  set; get; 

    public override string ToString()
    
        return "Id = " + Id + " " + "Name = " + Name + " " + "Address = " + Address;
    

[ProtoContract]
public class Address

    [ProtoMember(1)]
    public string Line1  get; set; 
    [ProtoMember(2)]
    public string Line2  get; set; 

    public override string ToString()
    
        return "Line1 = " + Line1 + " " + "Line2 = " + Line2;
    
2、在项目中创建一个Test.cs文件,并挂载到Main Camera上
public class Test : MonoBehaviour

    List<Person> persons = new List<Person>();
    void Start()
    
        Person p1 = new Person()
        
            Address = new Address() Line1 = "one line address", Line2 = "two line address",
            Id = 1,
            Name = "肖明"
        ;
        Person p2 = new Person() Address = new Address() Line1 = "one line", Line2 = "two line", Id = 1, Name = "肖红";
        persons.Add(p1);
        persons.Add(p2);
        using (var file = File.Create("test.bin"))//把对象序列化到文件中
        
            Serializer.Serialize(file,persons);
        
     

    void OnGUI()
    
        if (GUILayout.Button("反序列化"))
        
            Deserialize();
        
    

    void Deserialize()
    
        List<Person> personList =new List<Person>();
        using (var file = File.OpenRead("test.bin"))
        
            personList = Serializer.Deserialize<List<Person>>(file);
        

        foreach (var person in personList)
        
            Debug.Log(person);
        
    
3、运行程序,你会发现在你的项目根目录中有一个test.bin文件,里面就存放的是我们被序列化的对象

4、点击场景中的反序列化Button,,会看到输出了如下字符串

5、我简单写了一个protobuf工具类,主要提供把对象序列化到文件或者内存中去,和把文件或者内存中的数据反序列化出来,下面是主要源代码

public class ProtobufHelper

    /// <summary>
    /// 把对象序列化到内存中
    /// </summary>
    /// <typeparam name="T"></typeparam>
    /// <param name="t"></param>
    /// <returns></returns>
    public static string Serialize<T>(T t)
    
        using (MemoryStream ms = new MemoryStream())
        
            Serializer.Serialize(ms, t);
            return Encoding.UTF8.GetString(ms.ToArray());
        
    
    /// <summary>
    /// 把对象序列化到文件中
    /// </summary>
    /// <typeparam name="T"></typeparam>
    /// <param name="path"></param>
    /// <param name="t"></param>
    public static void Serialize<T>(string path, T t)
    
        using (var file = File.Create(path))
        
            Serializer.Serialize(file,t);
        
    
    /// <summary>
    /// 把对象从内存中反序列化回来
    /// </summary>
    /// <typeparam name="T"></typeparam>
    /// <param name="content"></param>
    /// <returns></returns>
    public static T Deserialize<T>(string content)
    

        using (MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(content)))
        
            T t = Serializer.Deserialize<T>(ms);
            return t;
        
    

    /// <summary>
    /// 把对象从文件中反序列化回来
    /// </summary>
    /// <typeparam name="T"></typeparam>
    /// <param name="s"></param>
    /// <returns></returns>
    public static T Deserialize<T>(Stream s)
    
        return Serializer.Deserialize<T>(s);
    
6、下面是这个类的简单实用方法(把数据序列化到内存中,并把对象从内存中反序列化回来),在Test.cs修改代码如下
public class Test : MonoBehaviour

    List<Person> persons = new List<Person>();
    string strResult = String.Empty;
    void Start()
    
        Person p1 = new Person()
        
            Address = new Address() Line1 = "one line address", Line2 = "two line address",
            Id = 1,
            Name = "肖明"
        ;
        Person p2 = new Person() Address = new Address() Line1 = "one line", Line2 = "two line", Id = 1, Name = "肖红";
        persons.Add(p1);
        persons.Add(p2);
        strResult = ProtobufHelper.Serialize(persons);//序列化到内存中
     

    void OnGUI()
    
        if (GUILayout.Button("反序列化"))
        
            Deserialize();
        
    

    void Deserialize()
    
        List<Person> personList =new List<Person>();
        personList = ProtobufHelper.Deserialize<List<Person>>(strResult);从内存中反序列化出来

        foreach (var person in personList)
        
            Debug.Log(person);
        
    
 
7、下面是把数据序列化到文件中,并把对象从文件中反序列化回来,在Test.cs修改代码如下
public class Test : MonoBehaviour

    List<Person> persons = new List<Person>();
    private string path;
    void Start()
    
        path = Application.streamingAssetsPath + "/test.bin";
        Person p1 = new Person()
        
            Address = new Address() Line1 = "one line address", Line2 = "two line address",
            Id = 1,
            Name = "肖明"
        ;
        Person p2 = new Person() Address = new Address() Line1 = "one line", Line2 = "two line", Id = 1, Name = "肖红";
        persons.Add(p1);
        persons.Add(p2);
        ProtobufHelper.Serialize<List<Person>>(path,persons);//把对象序列化到文件中
     

    void OnGUI()
    
        if (GUILayout.Button("反序列化"))
        
            Deserialize();
        
    

    void Deserialize()
    
        List<Person> personList =new List<Person>();
        using (var file = File.OpenRead(path))//从文件中读取
        
            personList = ProtobufHelper.Deserialize<List<Person>>(file);
        

        foreach (var person in personList)
        
            Debug.Log(person);
        
    
 

8.这就是一个简单的Protobuf序列化与反序列化介绍,我附上protobuf-net源代码供大家下载

链接:http://pan.baidu.com/s/1kUBZDYZ 密码:4b01

以上是关于Unity之C#端使用protobuf的主要内容,如果未能解决你的问题,请参考以下文章

Unity使用webSocket与服务器通信——C#服务端(Fleck)与Unity客户端( NativeWebSocket)传输多种数据数据

C# unity (发布到安卓端中使用)解析json字符串—使用微软官方的包Newtonsoft.Json

C# unity (发布到安卓端中使用)解析json字符串—使用微软官方的包Newtonsoft.Json

C# unity (发布到安卓端中使用)解析json字符串—使用微软官方的包Newtonsoft.Json

Unity3D游戏开发之C#编程中常见数据结构的比较

ET介绍——强大的基于.dotnet7+Unity3d的双端C#开源游戏框架