《Dotnet9》系列-Google ProtoBuf在C#中的簡單應用

測試摘要

時間如流水，隻能流去不流回！

點贊再看，養成習慣，這是您給我創作的動力！

本文 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#中怎麼使用？

一、準備工作

1. Visual Studio 2019(其他版本亦可）
2. Nuget安裝：Google.Protobuf和Google.Protobuf.Tools
3. 準備.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、生成解碼器

1. 建立兩個檔案夾，一個名為src,另一個為gen
2. 把準備好的proto檔案全部放到src中，如我的test.proto
3. 運作指令:.\protoc.exe –proto_path=src –csharp_out=gen test.proto
4. 把所有的proto檔案都生成一遍
5. 在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

參考文章如下：

1. Protocol Buffer Basics: C#
2. C# 中使用 Protocol Buffers 協定來序列化與反序列化物件
3. 在C#中使用Google ProtoBuf

除非注明，文章均由 Dotnet9 整理釋出，歡迎轉載。

轉載請注明本文位址：https://dotnet9.com/2019/12/it-technology/csharp/dotnet9-series-google-protobuf-in-csharp.html

如有所收獲，請大力轉發（能點贊及推薦那是極好的）；如覺小編寫文不易，歡迎給Dotnet9站點打賞，小編謝謝了；謝謝大家對dotnet技術的關注和支援 。

時間如流水，隻能流去不流回。