C#下使用protobuf(Google Protocol Buffers)

一时失言乱红尘 2022-06-09 08:18 1192阅读 0赞

Protobuf是google提供的一个开源序列化框架，类似于XML，JSON这样的数据表示语言，其最大的特点是基于二进制，因此比传统的XML表示高效短小得多。除了比Json、XML有速度上的优势和使用上的方便外，protocolbuf还可以做到向前兼容和向后兼容。

protobuf 虽然只支持JAVA、C++和Pyton，但protobuf社区的protobuf.net组件让protobuf可以支持更多的语言，其中就包括了C\#。

**protobuf协议**

定义protobuf协议必须创建一个以.proto为后缀的文件，以本篇 创建了一个名为myproto.proto的文件，如下：

**\[cpp\]**  [view plain][]   [copy][view plain]

1.  package ProtoTest;  
2.    
3.  message TestInfo\{  
4.   required string test = 1;  
5.   optional int32 num = 2;  
6.  \}  
7.    
8.  message Msg\{  
9.   required int32 id = 1;  
10.  optional TestInfo msg = 2;  
11.  optional string str = 3 \[defalut="Test String"\];  
12. \}

package在Java里面代表这个文件所在的包名，在c\#里面代表该文件的命名空间，message代表一个类， required 代表该字段必填，optional 代表该字段可选，并可以为其设置默认值，string的默认值格式为\[defalut="字符串"\]  整型的默认值格式为\[defalut=23333\]

下面是protobuf在.proto文件中的字段类型转换表：

<table style="border-collapse:collapse; margin-top:10px; margin-bottom:10px; color:rgb(0,0,0); font-family:Simsun"> 
 <tbody style="background-color:inherit"> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:rgb(97,153,223)"> .proto Type </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:rgb(97,153,223)"> Notes </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:rgb(97,153,223)"> C++ Type </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:rgb(97,153,223)"> <a href="http://lib.csdn.net/base/java" title="Java 知识库" style="color:rgb(223,52,52); font-weight:bold" rel="nofollow">Java&nbsp;</a>Type </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:rgb(97,153,223)"> <a href="http://lib.csdn.net/base/python" title="Python知识库" style="color:rgb(223,52,52); font-weight:bold" rel="nofollow">Python</a>Type[2] </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> double </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> double </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> double </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> float </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> float </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> float </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> float </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> float </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int32 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int32 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int64 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int64 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> long </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int/long[3] </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> uint32 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> Uses variable-length encoding. </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> uint32 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int[1] </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int/long[3] </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> uint64 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> Uses variable-length encoding. </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> uint64 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> long[1] </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int/long[3] </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> sint32 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int32 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> sint64 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int64 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> long </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int/long[3] </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> fixed32 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> Always four bytes. More efficient than uint32 if values are often greater than 228. </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> uint32 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int[1] </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> fixed64 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> Always eight bytes. More efficient than uint64 if values are often greater than 256. </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> uint64 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> long[1] </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int/long[3] </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> sfixed32 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> Always four bytes. </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int32 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> sfixed64 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> Always eight bytes. </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int64 </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> long </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> int/long[3] </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> bool </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> bool </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> boolean </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> boolean </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> string </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> A string must always contain UTF-8 encoded or 7-bit ASCII text. </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> string </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> String </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> str/unicode[4] </td> 
 </tr> 
 <tr style="background-color:inherit"> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> bytes </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> May contain any arbitrary sequence of bytes. </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> string </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> ByteString </td> 
 <td style="word-break:break-all; border:1px solid rgb(153,153,153); padding:5px 16px 5px 12px; min-height:25px; min-width:25px; height:25px; background-color:inherit"> str 
 <div> 
 
 </div> </td> 
 </tr> 
 </tbody> 
</table>

**如何编译proto文件**

在windows如何下载并编译protobuff，这部分参考博客：http://kuaile.in/archives/1214

github仓库地址：[https://github.com/google/protobuf][https_github.com_google_protobuf]

Google下载protobuff下载地址：https://developers.google.com/protocol-buffers/docs/downloads 。

在解压后的文件夹中，打开vsprojects目录，目录中的文件如图所示：

![20150808170552540][]

![20150808171101656][]

![47359749][]

分别依次右键编译生成libprotobuf.lib，libprotobuf-lite.lib，libprotoc.lib，protoc.exe  到这里就完成了protobuff的编译。

打开cmd，cd到protoc.exe所在的文件夹，即../vsproject/。假设E:\\proto\\存在myproto.proto文件。输入

**\[html\]**  [view plain][]   [copy][view plain]

1.  protoc \-I=e:\\proto \--cpp\_out=e:\\proto e:\\proto\\myproto.proto

就会在e:\\proto 下生成myproto.h 和myproto.cpp文件，测试成功就说明protobuff已经安装成功。

**如何将proto文件编译成.cs文件**

接下来要将proto文件编译成.cs文件。.net版的protobuf来源于proto社区，有两个版本：

一个版本叫protobuf-net，下载地址为：[http://code.google.com/p/protobuf-net/][http_code.google.com_p_protobuf-net]  写法上比较符合c\#一贯的写法，而且效率更高。

另一个为protobuf-csharp-sport ， 官方站点：[http://code.google.com/p/protobuf-csharp-port/][http_code.google.com_p_protobuf-csharp-port] 写法上跟java上的使用极其相似，比较遵循Google 的原生态写法，跨平台选择此版本比较好。

这里使用的是protobuf-net，下载解压后，将 Precompile\\precompile.exe 以及 ProtoGen\\protogen.exe 两个文件加入到环境变量中，打开cmd， 使用方法如下：

**\[html\]**  [view plain][]   [copy][view plain]

1.  //使用方法为：

**\[html\]**  [view plain][]   [copy][view plain]

1.  protogen -i:input.proto -o:output.cs  
2.  protogen -i:input.proto -o:output.xml -t:xml  
3.  protogen -i:input.proto -o:output.cs -p:datacontract -q  
4.  protogen -i:input.proto -o:output.cs \-p:observable=true

以E:\\proto\\myproto.proto为例，cmd下输入

**\[html\]**  [view plain][]   [copy][view plain]

1.  protogen -i:e:\\proto\\myproto.proto -o:myproto.cs

运行成功后就会在文件夹内生成myproto.cs文件

**如何将myproto.cs加入你的项目中**

有两种方法可以将.cs文件加入到你的项目中：第一种就是预编译成.dll文件，然后加入到你的项目中就可以了。第二种就是直接使用源码（这样的话编译速度会比较慢），将你的.cs文件直接加入到你的项目中，然后在项目中引用protobuf-net.dll的库，就可以使用了。

参考文章：

在ios android设备上使用 Protobuf (使用源码方式)    http://game.ceeger.com/forum/read.php? tid=14359&fid=27&page=1

android与PC，C\#与Java利用protobuf 进行无障碍通讯 http://www.cnblogs.com/TerryBlog/archive/2011/04/23/2025654.html

windows下Google Protocol Buffer 编译安装教程 http://kuaile.in/archives/1214

[view plain]: /images/20220609/e3215ab11e5c452d9c374bbfc07e063f.png#
[https_github.com_google_protobuf]: https://github.com/google/protobuf
[20150808170552540]: /images/20220609/059a81c8d7db4af884cf0582d733002c.png
[20150808171101656]: /images/20220609/c008ea4c6f9746198166c8d5f67b2521.png
[47359749]: /images/20220609/e3215ab11e5c452d9c374bbfc07e063f.png
[http_code.google.com_p_protobuf-net]: http://code.google.com/p/protobuf-net/
[http_code.google.com_p_protobuf-csharp-port]: http://code.google.com/p/protobuf-csharp-port/