C#使用protobuf-net進行序列化的詳細操作
protobuf 是 google的一個開源項目,可用于以下兩種用途:
(1)數據的存儲(序列化和反序列化),類似于xml、json等;
(2)制作網絡通信協議。
源代碼下載地址:https://github.com/mgravell/protobuf-net;
開源項目地址如下:https://code.google.com/p/protobuf-net/。
前一篇文章我們看到使用Google.Protobuf有諸多不便(參考《www.dbjr.com.cn/article/230186.htm》),這次我們來看看另一個工具的使用體驗。
相關資料、鏈接:
- 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工具后,還可以在開發(fā)時對目標類型(添加了[ProtoContract]注解)的定義進行檢查,比如字段順序重復、使用的字段類型不符合protobuf要求等。比如因疏忽設置了重復的字段順序,提示效果如下:
序列化操作
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()分別執(zhí)行序列化和反序列化,而不用依賴任何生成的代碼。
- 只針對.NET平臺的話,不需要.proto文件就可以應用protobuf序列化協議。如果需要跨語言編程,再根據C#類型編寫.proto文件(也可以通過工具自動生成proto文件),然后生產目標語言的對應類型。
- 借助于protobuf-net.BuildTools工具的輔助,可以及早的發(fā)現編碼錯誤,一定程度上提高了開發(fā)效率。
- 綜上,對于.NET平臺為主的開發(fā)者來說,使用protobuf-net相對來說代碼可讀性更高、維護成本更小,同時也能兼顧跨語言開發(fā),建議首先此方式。
到此這篇關于C#中使用protobuf-net進行序列化的文章就介紹到這了,更多相關C# protobuf-net序列化內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!