C#学习教程：Google.Protobuf工具在C#中的使用方法分享

作者：castellaniygw_623 | 来源：互联网 | 2022-12-19 12:57

protobuf是一个语言无关、平台无关的序列化协议，由谷歌开源提供。再加上其高性能、存储占用更小等特点，在云原生的应用中越来越广泛。在C#中主要有两种方法来使用protobuf协

protobuf是一个语言无关、平台无关的序列化协议，由谷歌开源提供。再加上其高性能、存储占用更小等特点，在云原生的应用中越来越广泛。

在C#中主要有两种方法来使用protobuf协议，nuget包分别为Google.Protobuf和protobuf-net，其中Google.Protobuf由谷歌官方提供。本文简要记录和展示Google.Protobuf的使用方法和特点。

项目资料及文档

项目官网：https://developers.google.cn/protocol-buffers&＃63;hl=zh-cn

github主页：https://github.com/protocolbuffers/protobuf/

官方文档：https://developers.google.cn/protocol-buffers/docs/overview&＃63;hl=zh-cn

该nuget包支持.NETFramework 4.5、.NETStandard1.1、.net5等

准备工作

需要用到的nuget有如下两个：Google.Protobuf、Google.Protobuf.Tools，其中Google.Protobuf是主类库，运行时要用到。Google.Protobuf.Tools提供了命令行工具，用于根据.proto文件转为目标语言的类型，仅开发时使用，运行时不需要。

本次Demo使用的.proto文件内容如下：

syntax = "proto3"; option cc_enable_arenas = true; package Tccc.Demo.Protobuf; message ErrorLog { string LogID = 1; string COntext= 2; string Stack = 3; }

首先需要根据.proto文件生成目标类型，操作如下：

./google.protobuf.tools3.19.1toolswindows_x64protoc.exe --csharp_out=./generatedCode ./proto/ErrorLog.proto

其中--csharp_out选项是生成C#语言的目标类型，运行protoc.exe -h 查看帮助信息，可以看到还支持一下几种选项：

--proto_path=PATH --cpp_out=OUT_DIR Generate C++ header and source. --csharp_out=OUT_DIR Generate C# source file. --java_out=OUT_DIR Generate Java source file. --js_out=OUT_DIR Generate Javascript source. --kotlin_out=OUT_DIR Generate Kotlin file. --objc_out=OUT_DIR Generate Objective-C header and source. --php_out=OUT_DIR Generate PHP source file. --python_out=OUT_DIR Generate Python source file. --ruby_out=OUT_DIR Generate Ruby source file.

运行上述命令，会根据指定的ErrorLog.proto文件生成ErrorLog.cs文件，文件中就是C#类型ErrorLog。生成的代码中会给此类型增加方法void WriteTo(CodedOutputStream output)和只读属性Parser，接下来进行序列化和反序列化的关键。

生成的ErrorLog类的完整代码：

// // Generated by the protocol buffer compiler. DO NOT EDIT! // source: ProtoFiles/ErrorLog.proto // #pragma warning disable 1591, 0612, 3021 #region Designer generated code using pb = global::Google.Protobuf; using pbc = global::Google.Protobuf.Collections; using pbr = global::Google.Protobuf.Reflection; using scg = global::System.Collections.Generic; namespace Tccc.Demo.Protobuf { ///

Holder for reflection information generated from ProtoFiles/ErrorLog.proto

   public static partial class ErrorLogReflection {     #region Descriptor     /// File descriptor for ProtoFiles/ErrorLog.proto
     public static pbr::FileDescriptor Descriptor {       get { return descriptor; }     }     private static pbr::FileDescriptor descriptor;     static ErrorLogReflection() {       byte[] descriptorData = global::System.Convert.FromBase64String(           string.Concat(             "ChlQcm90b0ZpbGVzL0Vycm9yTG9nLnByb3RvEhJUY2NjLkRlbW8uUHJvdG9i",             "dWYiOQoIRXJyb3JMb2cSDQoFTG9nSUQYASABKAkSDwoHQ29udGV4dBgCIAEo",             "CRINCgVTdGFjaxgDIAEoCUID+AEBYgZwcm90bzM="));       descriptor = pbr::FileDescriptor.FromGeneratedCode(descriptorData,           new pbr::FileDescriptor[] { },           new pbr::GeneratedClrTypeInfo(null, null, new pbr::GeneratedClrTypeInfo[] {             new pbr::GeneratedClrTypeInfo(typeof(global::Tccc.Demo.Protobuf.ErrorLog), global::Tccc.Demo.Protobuf.ErrorLog.Parser, new[]{ "LogID", "Context", "Stack" }, null, null, null, null)           }));     }     #endregion   }   #region Messages   public sealed partial class ErrorLog : pb::IMessage   #if !GOOGLE_PROTOBUF_REFSTRUCT_COMPATIBILITY_MODE       , pb::IBufferMessage   #endif   {     private static readonly pb::MessageParser _parser = new pb::MessageParser(() => new ErrorLog());     private pb::UnknownFieldSet _unknownFields;     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public static pb::MessageParser Parser { get { return _parser; } }     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public static pbr::MessageDescriptor Descriptor {       get { return global::Tccc.Demo.Protobuf.ErrorLogReflection.Descriptor.MessageTypes[0]; }     }     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     pbr::MessageDescriptor pb::IMessage.Descriptor {       get { return Descriptor; }     }     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public ErrorLog() {       OnConstruction();     }     partial void OnConstruction();     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public ErrorLog(ErrorLog other) : this() {       logID_ = other.logID_;       context_ = other.context_;       stack_ = other.stack_;       _unknownFields = pb::UnknownFieldSet.Clone(other._unknownFields);     }     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public ErrorLog Clone() {       return new ErrorLog(this);     }     /// Field number for the "LogID" field.
     public const int LogIDFieldNumber = 1;     private string logID_ = "";     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public string LogID {       get { return logID_; }       set {         logID_ = pb::ProtoPreconditions.CheckNotNull(value, "value");       }     }     /// Field number for the "Context" field.
     public const int COntextFieldNumber= 2;     private string context_ = "";     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public string Context {       get { return context_; }       set {         context_ = pb::ProtoPreconditions.CheckNotNull(value, "value");       }     }     /// Field number for the "Stack" field.
     public const int StackFieldNumber = 3;     private string stack_ = "";     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public string Stack {       get { return stack_; }       set {         stack_ = pb::ProtoPreconditions.CheckNotNull(value, "value");       }     }     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public override bool Equals(object other) {       return Equals(other as ErrorLog);     }     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public bool Equals(ErrorLog other) {       if (ReferenceEquals(other, null)) {         return false;       }       if (ReferenceEquals(other, this)) {         return true;       }       if (LogID != other.LogID) return false;       if (Context != other.Context) return false;       if (Stack != other.Stack) return false;       return Equals(_unknownFields, other._unknownFields);     }     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public override int GetHashCode() {       int hash = 1;       if (LogID.Length != 0) hash ^= LogID.GetHashCode();       if (Context.Length != 0) hash ^= Context.GetHashCode();       if (Stack.Length != 0) hash ^= Stack.GetHashCode();       if (_unknownFields != null) {         hash ^= _unknownFields.GetHashCode();       }       return hash;     }     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public override string ToString() {       return pb::JsonFormatter.ToDiagnosticString(this);     }     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public void WriteTo(pb::CodedOutputStream output) {     #if !GOOGLE_PROTOBUF_REFSTRUCT_COMPATIBILITY_MODE       output.WriteRawMessage(this);     #else       if (LogID.Length != 0) {         output.WriteRawTag(10);         output.WriteString(LogID);       }       if (Context.Length != 0) {         output.WriteRawTag(18);         output.WriteString(Context);       }       if (Stack.Length != 0) {         output.WriteRawTag(26);         output.WriteString(Stack);       }       if (_unknownFields != null) {         _unknownFields.WriteTo(output);       }     #endif     }     #if !GOOGLE_PROTOBUF_REFSTRUCT_COMPATIBILITY_MODE     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     void pb::IBufferMessage.InternalWriteTo(ref pb::WriteContext output) {       if (LogID.Length != 0) {         output.WriteRawTag(10);         output.WriteString(LogID);       }       if (Context.Length != 0) {         output.WriteRawTag(18);         output.WriteString(Context);       }       if (Stack.Length != 0) {         output.WriteRawTag(26);         output.WriteString(Stack);       }       if (_unknownFields != null) {         _unknownFields.WriteTo(ref output);       }     }     #endif     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public int CalculateSize() {       int size = 0;       if (LogID.Length != 0) {         size += 1 + pb::CodedOutputStream.ComputeStringSize(LogID);       }       if (Context.Length != 0) {         size += 1 + pb::CodedOutputStream.ComputeStringSize(Context);       }       if (Stack.Length != 0) {         size += 1 + pb::CodedOutputStream.ComputeStringSize(Stack);       }       if (_unknownFields != null) {         size += _unknownFields.CalculateSize();       }       return size;     }     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public void MergeFrom(ErrorLog other) {       if (other == null) {         return;       }       if (other.LogID.Length != 0) {         LogID = other.LogID;       }       if (other.Context.Length != 0) {         COntext= other.Context;       }       if (other.Stack.Length != 0) {         Stack = other.Stack;       }       _unknownFields = pb::UnknownFieldSet.MergeFrom(_unknownFields, other._unknownFields);     }     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     public void MergeFrom(pb::CodedInputStream input) {     #if !GOOGLE_PROTOBUF_REFSTRUCT_COMPATIBILITY_MODE       input.ReadRawMessage(this);     #else       uint tag;       while ((tag = input.ReadTag()) != 0) {         switch(tag) {           default:             _unknownFields = pb::UnknownFieldSet.MergeFieldFrom(_unknownFields, input);             break;           case 10: {             LogID = input.ReadString();             break;           }           case 18: {             COntext= input.ReadString();             break;           }           case 26: {             Stack = input.ReadString();             break;           }         }       }     #endif     }     #if !GOOGLE_PROTOBUF_REFSTRUCT_COMPATIBILITY_MODE     [global::System.Diagnostics.DebuggerNonUserCodeAttribute]     [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]     void pb::IBufferMessage.InternalMergeFrom(ref pb::ParseContext input) {       uint tag;       while ((tag = input.ReadTag()) != 0) {         switch(tag) {           default:             _unknownFields = pb::UnknownFieldSet.MergeFieldFrom(_unknownFields, ref input);             break;           case 10: {             LogID = input.ReadString();             break;           }           case 18: {             COntext= input.ReadString();             break;           }           case 26: {             Stack = input.ReadString();             break;           }         }       }     }     #endif   }   #endregion } #endregion Designer generated code

序列化操作

 public static byte[] Serialize(ErrorLog log)         {             using (MemoryStream output = new MemoryStream())             {                 log.WriteTo(output);                 return output.ToArray();             }         }

反序列化操作 ErrorLog desErrorLog= ErrorLog.Parser.ParseFrom(data); 使用特点和理解

protoc.exe是支持生成多语言类型，这对于跨语言的混合编程比较方便。

根据上述使用步骤可以看到，必须先使用工具protoc生成目标类型，才能调用序列化和反序列化方法，这有些不符合.net平台的编码习惯。

一堆自动生成的C#类在可维护性方面欠佳，当需要调整属性字段时，还要通过工具重新生成，较为麻烦。

到此这篇关于Google.Protobuf工具在C#中的使用方法就介绍到这了。希望对大家的学习有所帮助，也希望大家多多支持<编程笔记>。

推荐阅读

io
后台获取视图对应的字符串

1.帮助类后台获取视图对应的字符串publicclassViewHelper{将View输出为字符串(注：不会执行对应的ac ... [详细]

蜡笔小新 2023-12-13 18:03:01
get
C#制作Java+Mysql+Tomcat环境安装程序，一键式安装教程

本文介绍了如何使用C#制作Java+Mysql+Tomcat环境安装程序，实现一键式安装。通过将JDK、Mysql、Tomcat三者制作成一个安装包，解决了客户在安装软件时的复杂配置和繁琐问题，便于管理软件版本和系统集成。具体步骤包括配置JDK环境变量和安装Mysql服务，其中使用了MySQL Server 5.5社区版和my.ini文件。安装方法为通过命令行将目录转到mysql的bin目录下，执行mysqld --install MySQL5命令。 ... [详细]

蜡笔小新 2023-12-12 19:29:55
get
Android开发笔记：使用Picasso加载网络图片等比例缩放

在Android开发中，使用Picasso库可以实现对网络图片的等比例缩放。本文介绍了使用Picasso库进行图片缩放的方法，并提供了具体的代码实现。通过获取图片的宽高，计算目标宽度和高度，并创建新图实现等比例缩放。 ... [详细]

蜡笔小新 2023-12-14 17:34:00
uri
Spring源码解密之默认标签的解析方式分析

本文分析了Spring源码解密中默认标签的解析方式。通过对命名空间的判断，区分默认命名空间和自定义命名空间，并采用不同的解析方式。其中，bean标签的解析最为复杂和重要。 ... [详细]

蜡笔小新 2023-12-14 17:24:50
list
C#学习教程：在Console中工作但在Windows窗体中不工作的异步代码分享

本文分享了一个关于在C#中使用异步代码的问题，作者在控制台中运行时代码正常工作，但在Windows窗体中却无法正常工作。作者尝试搜索局域网上的主机，但在窗体中计数器没有减少。文章提供了相关的代码和解决思路。 ... [详细]

蜡笔小新 2023-12-14 15:56:00
include
HDU 2372 El Dorado（DP）的最长上升子序列长度求解方法

本文介绍了解决HDU 2372 El Dorado问题的一种动态规划方法，通过循环k的方式求解最长上升子序列的长度。具体实现过程包括初始化dp数组、读取数列、计算最长上升子序列长度等步骤。 ... [详细]

蜡笔小新 2023-12-14 15:08:18
get
Spring特性实现接口多类的动态调用详解

本文详细介绍了如何使用Spring特性实现接口多类的动态调用。通过对Spring IoC容器的基础类BeanFactory和ApplicationContext的介绍，以及getBeansOfType方法的应用，解决了在实际工作中遇到的接口及多个实现类的问题。同时，文章还提到了SPI使用的不便之处，并介绍了借助ApplicationContext实现需求的方法。阅读本文，你将了解到Spring特性的实现原理和实际应用方式。 ... [详细]

蜡笔小新 2023-12-14 03:24:19
get
关于cuowu类的错误提示和使用AdjustmentListener的问题

本文讨论了一个关于cuowu类的问题，作者在使用cuowu类时遇到了错误提示和使用AdjustmentListener的问题。文章提供了16个解决方案，并给出了两个可能导致错误的原因。 ... [详细]

蜡笔小新 2023-12-13 22:09:56
get
java 线程死锁模拟

1，关于死锁的理解死锁，我们可以简单的理解为是两个线程同时使用同一资源，两个线程又得不到相应的资源而造成永无相互等待的情况。 2，模拟死锁背景介绍：我们创建一个朋友 ... [详细]

蜡笔小新 2023-12-13 19:12:25
lua
lua语言闭包、模式匹配、日期、编译、模块的特性及应用

本文介绍了lua语言中闭包的特性及其在模式匹配、日期处理、编译和模块化等方面的应用。lua中的闭包是严格遵循词法定界的第一类值，函数可以作为变量自由传递，也可以作为参数传递给其他函数。这些特性使得lua语言具有极大的灵活性，为程序开发带来了便利。 ... [详细]

蜡笔小新 2023-12-14 18:18:21
timestamp
Android 新闻App的本地服务器搭建教程

本文介绍了在开发Android新闻App时，搭建本地服务器的步骤。通过使用XAMPP软件，可以一键式搭建起开发环境，包括Apache、MySQL、PHP、PERL。在本地服务器上新建数据库和表，并设置相应的属性。最后，给出了创建new表的SQL语句。这个教程适合初学者参考。 ... [详细]

蜡笔小新 2023-12-14 17:15:19
timestamp
Java猜拳小游戏代码

本文介绍了一个Java猜拳小游戏的代码，通过使用Scanner类获取用户输入的拳的数字，并随机生成计算机的拳，然后判断胜负。该游戏可以选择剪刀、石头、布三种拳，通过比较两者的拳来决定胜负。 ... [详细]

蜡笔小新 2023-12-14 15:39:08
get
OC学习笔记之@property和@synthesize

本文介绍了OC学习笔记中的@property和@synthesize，包括属性的定义和合成的使用方法。通过示例代码详细讲解了@property和@synthesize的作用和用法。 ... [详细]

蜡笔小新 2023-12-14 12:05:06
uri
知识图谱——机器大脑中的知识库

本文介绍了知识图谱在机器大脑中的应用，以及搜索引擎在知识图谱方面的发展。以谷歌知识图谱为例，说明了知识图谱的智能化特点。通过搜索引擎用户可以获取更加智能化的答案，如搜索关键词"Marie Curie"，会得到居里夫人的详细信息以及与之相关的历史人物。知识图谱的出现引起了搜索引擎行业的变革，不仅美国的微软必应，中国的百度、搜狗等搜索引擎公司也纷纷推出了自己的知识图谱。 ... [详细]

蜡笔小新 2023-12-14 10:06:19
uri
Oracle seg,V$TEMPSEG_USAGE与Oracle排序的关系及使用方法

本文介绍了Oracle seg,V$TEMPSEG_USAGE与Oracle排序之间的关系，V$TEMPSEG_USAGE是V_$SORT_USAGE的同义词，通过查询dba_objects和dba_synonyms视图可以了解到它们的详细信息。同时，还探讨了V$TEMPSEG_USAGE的使用方法。 ... [详细]

蜡笔小新 2023-12-12 17:57:15

castellaniygw_623

这个家伙很懒，什么也没留下！

Tags | 热门标签

RankList | 热门文章