時間如流水,只能流去不流回! 點贊再看,養成習慣,這是您給我創作的動力! 本文 Dotnet9 https://dotnet9.com 已收錄,站長樂於分享dotnet相關技術,比如Winform、WPF、ASP.NET Core等,亦有C++桌面相關的Qt Quick和Qt Widgets等,只分 ...
時間如流水,只能流去不流回!
點贊再看,養成習慣,這是您給我創作的動力!
本文 Dotnet9 https://dotnet9.com 已收錄,站長樂於分享dotnet相關技術,比如Winform、WPF、ASP.NET Core等,亦有C++桌面相關的Qt Quick和Qt Widgets等,只分享自己熟悉的、自己會的。
簡介
什麼是 Google Protocol Buffer? 假如您在網上搜索,應該會得到類似這樣的文字介紹:
Google Protocol Buffer( 簡稱 Protobuf) 是 Google 公司內部的混合語言數據標準,目前已經正在使用的有超過 48,162 種報文格式定義和超過 12,183 個 .proto 文件。他們用於 RPC 系統和持續數據存儲系統。
Protocol Buffers 是一種輕便高效的結構化數據存儲格式,可以用於結構化數據串列化,或者說序列化。它很適合做數據存儲或 RPC 數據交換格式。可用於通訊協議、數據存儲等領域的語言無關、平臺無關、可擴展的序列化結構數據格式。目前提供了 C++、Java、Python 三種語言的 API。
說一千道一萬,Google Protocol Buffer是一個序列化數據結構好幫手, 相對於XML、二進位序列化方式,Protobuf效率較高,支持數據量較大,protobuf序列化後的大小是json的1/10,xml格式的1/20,是二進位序列化的1/10 (具體本人未測試過,數據由此篇文章得到:protobuf效率)
C#中怎麼使用?
一、準備工作
- Visual Studio 2019(其他版本亦可)
- Nuget安裝:Google.Protobuf和Google.Protobuf.Tools
- 準備.proto文件
二、關於proto文件
使用ProtoBuf,主要有兩個操作:序列化和反序列化。這兩個操作都需要協議描述文件,也就是.proto文件。如果要使用protobuf存儲自定義的數據,就要自己編寫proto文件,如果要讀取其他的ProtoBuf序列化文件,就要先知道要讀取的ProtoBuf序列化文件的協議,也就是要獲得對應的.proto文件,這是一個必須條件,沒有對應的proto文件,就無法正確打開ProtoBuf序列化文件。
三、步驟
1、安裝Google.Protobuf和Google.Protobuf.Tools的Nuget包
2、在Google.Protobuf.Tools下找到編譯工具protoc.exe,我的電腦中路徑是:C:\Users\admin.nuget\packages\google.protobuf.tools\3.10.1\tools\windows_x64,在此目錄之上,還有很多版本,看您程式具體版本及tools版本而定。
3、準備好協議描述文件xx.proto,需要註意的是,proto文件之間可以互相引用,要正常使用,必須把所有相關的proto文件都準備好。下麵是我自己寫的一個測試文件test.proto:
syntax = "proto3"; option cc_enable_arenas = true; package Test; message TestContact { int32 ID = 1; string Address = 2; string Name = 3; }
4、生成解碼器
- 建立兩個文件夾,一個名為src,另一個為gen
- 把準備好的proto文件全部放到src中,如我的test.proto
- 運行命令:.\protoc.exe –proto_path=src –csharp_out=gen test.proto
- 把所有的proto文件都生成一遍
- 在gen文件夾中,會發現有等量的.cs文件,這就是對應的解碼器,我們要把他們放進自己的工程中。
5、打開安裝了Google.Protobuf和Google.Protobuf.Tools的Nuget包的C#工程,把剛剛生成的解碼器導入工程中。
我把tools工具和proto文件及proto cs文件一起放入工程的代碼結構
6、具體使用代碼
using Google.Protobuf; using System; using System.IO; using Test; namespace protoctest { class Program { static void Main(string[] args) { TestContact t = new TestContact(); t.ID = 1; t.Name = "xiao ming"; t.Address = "Cheng Du"; Console.WriteLine($"序列化之前:{t}"); //序列化操作 byte[] data = new byte[t.CalculateSize()]; using (CodedOutputStream cos = new CodedOutputStream(data)) { t.WriteTo(cos); //data = cos.to.ToArray(); } //反序列化操作 TestContact t1 = TestContact.Parser.ParseFrom(data); Console.WriteLine($"反序列化得到:{t1}"); Console.ReadKey(); } } }
7、運行效果如下
四、代碼
代碼已上傳CSDN:C#使用Google ProtoBuf例子
gitee: https://gitee.com/lsq6/GoogleProtoCSharpTest
參考文章如下:
除非註明,文章均由 Dotnet9 整理髮布,歡迎轉載。
轉載請註明本文地址:https://dotnet9.com/2019/12/it-technology/csharp/dotnet9-series-google-protobuf-in-csharp.html
如有所收穫,請大力轉發(能點贊及推薦那是極好的);如覺小編寫文不易,歡迎給Dotnet9站點打賞,小編謝謝了;謝謝大家對dotnet技術的關註和支持 。