C#中使用protobuf-net進行序列化

chenzk 發表於 2021-11-25
C#

前一篇文章我們看到使用Google.Protobuf有諸多不便(參考《如何在C#中使用Google.Protobuf工具》),這次我們來看看另一個工具的使用體驗。

相關資料、連結:

  • github專案:https://github.com/protobuf-net/protobuf-net
  • nuget包名稱:protobuf-net、protobuf-net.BuildTools
  • 作者:Marc Gravell
  • 支援.net平臺:.net5\.NETFramework4.6.1\.NETStandard2.0等
  • protobuf-net BuildTools文件:https://protobuf-net.github.io/protobuf-net/build_tools

準備工作

在C#中編寫目標型別:
在類級別增加註解[ProtoContract],在欄位級別增加註解[ProtoMember(orderxxx)]
    [ProtoContract]
    public class ErrorLog
    {
        [ProtoMember(1)]
        public string LogID { get; set; }
        [ProtoMember(2)]

        public string Context { get; set; }
        [ProtoMember(3)]

        public string Stack { get; set; }
    }

當安裝了protobuf-net.BuildTools工具後,還可以在開發時對目標型別(新增了[ProtoContract]註解)的定義進行檢查,比如欄位順序重複、使用的欄位型別不符合protobuf要求等。比如因疏忽設定了重複的欄位順序,提示效果如下:

C#中使用protobuf-net進行序列化

 

序列化操作

        public static byte[] Serialize(ErrorLog log)
        {
            using (MemoryStream memoryStream = new MemoryStream())
            {
                ProtoBuf.Serializer.Serialize(memoryStream, log);
                return memoryStream.ToArray();
            }
        }

 

反序列化操作

        public static ErrorLog DeSerialize(byte[] data)
        {
            using (MemoryStream ms = new MemoryStream(data))
            {
                return ProtoBuf.Serializer.Deserialize<ErrorLog>(ms);
            }
        }

 

總結、理解 

  • 這個工具的使用體驗屬於Code-First模式,先定義型別,並使用註解進行標記,不需要先編寫.proto檔案。
  • 通過類庫提供的ProtoBuf.Serializer.Serialize()和ProtoBuf.Serializer.Deserialize()分別執行序列化和反序列化,而不用依賴任何生成的程式碼。
  • 只針對.NET平臺的話,不需要.proto檔案就可以應用protobuf序列化協議。如果需要跨語言程式設計,再根據C#型別編寫.proto檔案(也可以通過工具自動生成proto檔案),然後生產目標語言的對應型別。
  • 藉助於protobuf-net.BuildTools工具的輔助,可以及早的發現編碼錯誤,一定程度上提高了開發效率。
  • 綜上,對於.NET平臺為主的開發者來說,使用protobuf-net相對來說程式碼可讀性更高、維護成本更小,同時也能兼顧跨語言開發,建議首先此方式。