1.java语言中生成gprc代码的源码三种方式：gradle、protoc、解析镜像的源码方式
2.5个步骤搞定protoc环境安装
3.在C++中使用Protobuf
4.protobuf 详解
5.一文读懂——Protobuf
6.使用protobuf实现序列化与反序列化

java语言中生成gprc代码的三种方式：gradle、protoc、解析镜像的源码方式

       在Java语言中生成gRPC代码有三种主要方式：使用Gradle插件、命令行工具protoc以及Docker容器。解析skynet源码分析.doc下面分别介绍这三种方法的源码步骤和原理。

       首先，解析配置Gradle插件生成gRPC代码。源码在项目proto目录下创建HelloService.proto文件，解析并在build.gradle中配置Gradle插件。源码确保使用的解析插件版本是最新的，以避免版本冲突问题。源码配置内容包括插件官方文档中的解析指令，如-I、源码--java_out、-plugin、-grpc_out等参数，这些参数指定protobuf文件位置、生成文件路径、插件执行文件和gRPC文件路径。执行./gradlew build或./gradlew generateProto命令，Gradle会通过底层的protoc工具生成所需的gRPC文件。

       其次，使用命令行工具protoc生成gRPC代码。访问protoc工具的官方文档以获取安装方法。

       第三，通过Docker容器生成gRPC代码。可以选择开源的protocbuf镜像，镜像源码地址在官方文档中提供。根据需要创建Dockerfile文件，设置架构和运行环境。对于特定架构（如x_），在构建镜像时使用docker build命令，并指定平台参数，如-docker build -f Dockfile . -t protoc:0.0.2 --platform linux/amd。运行容器后，执行protoc命令，实现与直接使用protoc相同的效果。使用自定义镜像的优势在于体积小且环境干净。

       总结这三种方式，Gradle插件是通过集成到构建系统中自动执行生成过程，适合集成到持续集成/持续部署流程。命令行工具protoc提供了高度灵活性，适用于独立执行或脚本自动化。而Docker容器方式则提供了隔离的运行环境，尤其适合跨平台部署和资源受限的环境。选择合适的方法取决于具体需求、项目规模和团队习惯。

5个步骤搞定protoc环境安装

       胖sir 提出疑问，工作中发现很多新接触GO的小伙伴安装protoc的环境需要折腾很久。兵长给出了解决方法，梳理总结快速高效安装protoc环境的步骤。

       protoc是用于将proto文件编程成各种语言源码文件的工具。它可以将proto文件编译生成适用于GO语言开发的源码文件。一般会和GRPC进行配套使用。快速安装protoc环境的关键在于明确安装步骤。

       对于Windows系统，安装protoc相对较为简单。首先，下载最新版的golang安装程序。

       然后，解压安装程序，多多淘宝客源码并将GOPATH的路径添加到环境变量中。如果不清楚GOPATH的位置，可以在终端输入go env进行查看。

       接下来，在命令行中执行相关命令，如果执行失败，可能需要配置代理。

       执行命令后，会生成对应的程序，表示环境配置成功。此时，可以开始使用protoc工具。

       步骤包括：下载并安装golang，配置GOPATH环境变量，执行相应命令，生成.pb.go文件，设置模块化，使用protoc工具编译proto文件，并在main.go文件中执行相关操作以正确解析protobuf文件。如有需要，可以使用grpc插件进行进一步的操作。

       以上步骤详细介绍了如何快速、高效地安装protoc环境。如果对技术有疑问，可以在评论区或后台提出你的问题，与作者和其他读者一起交流和成长。

       感谢阅读！如果你觉得文章对你有所帮助，请在评论区或后台点赞，分享到你的朋友圈。技术是开放的，让我们拥抱变化，共同前行，努力成长。

在C++中使用Protobuf

       ProtoBuf的定义和描述：

       Protocol Buffers是一种语言无关、平台无关、可扩展的序列化结构数据的方法，它适用于（数据）通信协议、数据存储等。

       Protocol Buffers是一种灵活、高效、自动化的结构数据序列化方法，类似于XML，但比XML更小（3 ~ 倍）、更快（ ~ 倍）、更简单。

       你可以定义数据的结构，然后使用特殊生成的源代码轻松地在各种数据流中使用各种语言进行编写和读取结构数据。你甚至可以更新数据结构，而不会破坏由旧数据结构编译的已部署程序。

       使用 ProtoBuf教程：

       在了解了ProtoBuf的基本概念之后，我们将具体了解如何使用ProtoBuf。

       第一步，创建.proto文件，定义数据结构，如下所示：

       我们在上例中定义了一个名为Person的消息，语法很简单，message关键字后跟消息名称。之后我们在其中定义了message具有的字段，形式为：

       第二步，protoc编译.proto文件生成读写接口：

       在.proto文件中定义了数据结构，这些数据结构是网站源码批量替换面向开发者和业务程序的，并不面向存储和传输。当需要把这些数据进行存储或传输时，就需要将这些结构数据进行序列化、反序列化以及读写。ProtoBuf提供相应的接口代码，可以通过protoc这个编译器来生成相应的接口代码，命令如下：

       生成的.h，.cpp文件为person.pb.h，person.pb.cpp，且.h的定义与proto文件的内容相关联：

       第三步，编写C++业务代码：

       c++业务代码对应的CMakeLists.txt为：

       参考链接:

protobuf 详解

       Protobuf，即Protocol Buffers，是Google公司设计的一种轻量级、高效的结构化数据存储格式，用于结构化数据的序列化。它被广泛应用于数据存储和远程过程调用（RPC）的数据交换，支持语言无关、平台无关、可扩展的序列化结构数据格式。目前主要提供了C++、Java和Python三种语言的API。

       Protobuf的优势在于其简洁性和高效性，允许开发者定义数据结构，并以二进制格式进行序列化和反序列化，从而节省了数据传输和存储的空间，同时也加快了数据处理的速度。然而，它也有一些劣势，比如学习曲线陡峭，对于初学者来说可能需要一定时间来熟悉其语法和使用方法。

       在安装Protobuf时，protoc（Protocol Compiler）是核心组件，它能将.proto文件编译成不同语言的源代码。为了在Windows环境下安装protoc，首先需从GitHub下载protobuf源码，解压后添加bin目录路径到系统环境变量，然后通过命令行运行protoc查看是否成功安装。

       对于Go语言的支持，由于protobuf本身并未直接提供Go语言的API，需要额外安装protoc-gen-go插件来生成Go语言的序列化和反序列化代码。在安装完protobuf后，使用Go1.+版本的命令行安装protoc-gen-go插件。如果需要生成gRPC相关的Go代码，则需要安装protoc-gen-go-grpc插件。

       Protobuf的语法涵盖了多种数据类型，包括标量类型、可选类型、重复类型、映射类型以及嵌套的message类型。message成员可以被指定为标量类型，如字符串、整数等，也可以嵌套其他message类型。消息字段可以被标记为可选或重复类型，以适应不同的数据需求。

       在.proto文件中定义消息类型时，可以使用默认值来简化序列化过程。默认值在解析数据时如果消息中未包含特定的字段，则将该字段设置为默认值。此外，Protobuf还支持enum（枚举类型）和oneof（互斥字段组）特性，用于定义具有预定义值列表的java thread类源码字段和最多只能设置其中一个字段的字段组。

       为了将message与RPC（远程过程调用）结合使用，可以在.proto文件中定义RPC服务接口。通过protobuf编译器protoc，可以生成特定语言的RPC服务代码，包括生成序列化和反序列化的代码以及RPC服务的客户端和服务器代码。

       使用protoc编译器将.proto文件编译成目标语言的源代码。编译命令通常会指定输出目录和目标语言，如Go语言。通过设置--go_out参数，可以指定生成的Go代码的基本路径。同时，--go_opt参数可以用来为生成的Go代码指定额外的优化选项。--proto_path参数用于设置Protobuf查找.proto文件的路径。

       生成gRPC相关的Go代码需要使用protoc-gen-go-grpc插件，并通过--go-grpc_out参数指定输出目录。这将产生用于gRPC服务的客户端和服务器代码。

       要使用protobuf，通常会从源代码下载protobuf，然后通过命令行工具protoc进行编译，从而生成特定语言的序列化和反序列化代码，以及RPC服务代码。对于Go语言，除了需要安装protobuf和protoc-gen-go插件外，还需根据需求安装protoc-gen-go-grpc插件来生成gRPC相关的代码。

一文读懂——Protobuf

       快速理解Protocol Buffers

       Protocol Buffers（简称Protobuf），是Google为内部通信和数据存储设计的一种高效轻量级的数据结构格式。全球已有超过,种报文格式定义和,个.proto文件应用于RPC系统和持久化存储。它的优势在于结构化数据的序列化与跨语言、平台的兼容性，适用于即时通讯和数据存储等领域。

       与XML和JSON相比，Protobuf体积更小，解析速度更快，特别适合像即时通讯这样对数据传输效率要求高的场景。它的核心特性体现在简化了服务端开发：服务端间通信只需关注接口方法（service）和参数（message），无需关注底层协议和字段解析，大大降低了开发成本。

       在Proto3版本中，相较于Proto2，语法更为简洁，例如移除了"required"和"optional"等复杂的规则，强调约定而非语法。Proto3的repeated标量数值类型默认为packed编码，而Proto2默认非packed，同时增加了Go、Ruby、JavaNano等更多语言支持。

       定义数据结构时，Protobuf提供一套基础数据类型，每个字段都有唯一编号，用于二进制标识。虽然编号范围广，但要避免使用~的预留区间。为了优化编码后的数据大小，高频率的字段建议使用1~范围的编号，但需留有扩展空间。

       Proto3中repeated字段的规则有所变化，而Proto2中的可扩展字段规定有所不同。在编写消息类型时，可以在一个.proto文件中定义多个相关消息，方便扩展和组织。

       添加注释支持C/C++风格，egret 棋牌游戏源码通过预留字段处理更新后的兼容性问题。默认值根据字段类型设定，如字符串、布尔值等。在枚举定义上，需确保第一个枚举值为0且无重复，除非启用别名选项。

       使用.proto文件定义的数据结构需通过protoc编译器生成接口代码，以支持序列化和反序列化。然而，使用CMake的execute_process命令可能存在重新生成源码导致频繁编译的问题。

       实例演示包括定义.proto文件、编写读写函数以及配置文件的使用，展示了如何在实际项目中应用Protocol Buffers。更多详细信息，请参考官方文档。

使用protobuf实现序列化与反序列化

       protobuf是用来干嘛的？

       protobuf是一种用于对结构数据进行序列化的工具，从而实现数据存储和交换。（主要用于网络通信中收发两端进行消息交互。所谓的“结构数据”是指类似于struct结构体的数据，可用于表示一个网络消息。当结构体中存在函数指针类型时，直接对其存储或传输相当于是“浅拷贝”，而对其序列化后则是“深拷贝”。）

       序列化：将结构数据或者对象转换成能够用于存储和传输的格式。 反序列化：在其他的计算环境中，将序列化后的数据还原为数据结构和对象。

       从“序列化”字面上的理解，似乎使用C语言中的struct结构体就可以实现序列化的功能：将结构数据填充到定义好的结构体中的对应字段即可，接收方再对结构体进行解析。

       在单机的不同进程间通信时，使用struct结构体这种方法实现“序列化”和“反序列化”的功能问题不大，但是，在网络编程中，即面向网络中不同主机间的通信时，则不能使用struct结构体，原因在于：

       （1）跨语言平台，例如发送方是用C语言编写的程序，接收方是用Java语言编写的程序，不同语言的struct结构体定义方式不同，不能直接解析；

       （2）struct结构体存在内存对齐和CPU不兼容的问题。

       因此，在网络编程中，实现“序列化”和“反序列化”功能需要使用通用的组件，如 Json、XML、protobuf 等。

       ① 性能高效： 与XML相比，protobuf更小（3 ~ 倍）、更快（ ~ 倍）、更为简单。

       ② 语言无关、平台无关： protobuf支持Java、C++、Python等多种语言，支持多个平台。

       ③ 扩展性、兼容性强： 只需要使用protobuf对结构数据进行一次描述，即可从各种数据流中读取结构数据，更新数据结构时不会破坏原有的程序。

       Protobuf与XML、Json的性能对比：

       测试万次序列化：

       测试万次反序列化：

       protobuf 2 中有三种数据类型限定修饰符：

       required表示字段必选，optional表示字段可选，repeated表示一个数组类型。

       其中， required 和 optional 已在 proto3 弃用了。

       protobuf中常用的数据类型：

       下载protobuf压缩包后，解压、配置、编译、安装，即可使用protoc命令查看Linux中是否安装成功：

       使用protobuf时，需要先根据应用需求编写 .proto 文件定义消息体格式，例如：

       其中，syntax关键字表示使用的protobuf的版本，如不指定则默认使用 "proto2"；package关键字表示“包”，生成目标语言文件后对应C++中的namespace命名空间，用于防止不同的消息类型间的命名冲突。

       然后使用 protobuf编译器（protoc命令）将编写好的 .proto 文件生成目标语言文件（例如目标语言是C++，则会生成 .cc 和 .h 文件），例如：

       其中：

       $SRC_DIR表示 .proto文件所在的源目录； $DST_DIR表示生成目标语言代码的目标目录； xxx.proto表示要对哪个.proto文件进行解析； --cpp_out表示生成C++代码。

       编译完成后，将会在目标目录中生成xxx.pb.h和xxx.pb.cc文件，将其引入到我们的C++工程中即可实现使用protobuf进行序列化：

       在C++源文件中包含xxx.pb.h头文件，在g++编译时链接xxx.pb.cc源文件即可：

       在protobuf源码中的/examples 目录下有官方提供的protobuf使用示例：addressbook.proto

       参考官方示例实现C++使用protobuf进行序列化和反序列化：

       addressbook.proto :生成的addressbook.pb.h 文件内容摘要：add_person.cpp :

       输出结果：

       三种序列化的方法没有本质上的区别，只是序列化后输出的格式不同，可以供不同的应用场景使用。 序列化的API函数均为const成员函数，因为序列化不会改变类对象的内容，而是将序列化的结果保存到函数入参指定的地址中。

       .proto文件中的option选项用于配置protobuf编译后生成目标语言文件中的代码量，可设置为SPEED， CODE_SIZE， LITE_RUNTIME 三种。 默认option选项为 SPEED，常用的选项为 LITE_RUNTIME。

       三者的区别在于：

       ① SPEED（默认值）： 表示生成的代码运行效率高，但是由此生成的代码编译后会占用更多的空间。

       ② CODE_SIZE： 与SPEED恰恰相反，代码运行效率较低，但是由此生成的代码编译后会占用更少的空间，通常用于资源有限的平台，如Mobile。

       ③ LITE_RUNTIME： 生成的代码执行效率高，同时生成代码编译后的所占用的空间也非常少。 这是以牺牲Protobuf提供的反射功能为代价的。 因此我们在C++中链接Protobuf库时仅需链接libprotobuf-lite，而非protobuf。

       SPEED 和 LITE_RUNTIME相比，在于调试级别上，例如 msg.SerializeToString(&str;); 在 SPEED 模式下会利用反射机制打印出详细字段和字段值，但是 LITE_RUNTIME 则仅仅打印字段值组成的字符串。

       因此：可以在调试阶段使用 SPEED 模式，而上线以后提升性能使用 LITE_RUNTIME 模式优化。

       最直观的区别是使用三种不同的 option 选项时，编译后产生的 .pb.h 中自定义的类所继承的 protobuf类不同：

       ① protobuf 将消息里的每个字段进行编码后，再利用TLV或者TV的方式进行数据存储； ② protobuf 对于不同类型的数据会使用不同的编码和存储方式； ③ protobuf 的编码和存储方式是其性能优越、数据体积小的原因。

Protocol Buffer详解（一）

       Protocol Buffer是一种支持多平台、多语言、可扩展的数据序列化机制，与XML相比，protobuf体积更小、速度更快、使用更简单，支持自定义数据结构。通过protobu编译器，可以生成特定语言的源代码，如C++、Java、Python，protoBuf对主流编程语言都提供了支持，使得序列化和反序列化变得非常方便。

       一、Message定义

       这里给出一个简单的例子，是一个搜索请求的message格式。

       上述例子中fields的种类都是数值型的（string和int），当然也可以指定更加复杂的fields，比如枚举类型enum，或者是嵌套的message类型。

       1、分配field编号

       上述例子中每个field都被分配了一个编号，这个编号是该field的唯一标识。需要注意的是，标识1-在编码时只占用一个字节，-占用两个字节，因此为了进一步优化程序，对于经常出现的element，建议使用1-作为其唯一标识；对于不经常使用的element，建议使用-。编号的范围是1-2^（-是系统预留的，不要使用）。

       2、field类型

       message中的field类型包含以下两种（proto3）：

       （1）singular

       （2）repeated：该类型的field可以在message中重复使用（类似于数组），它们的顺序会被保存，通过索引进行检索，数值类型的repeated默认使用packed编码方式。

       3、多message结构

       在一个proto文件中可以定义多个protobuf。

       4、reserved field类型

       在开发过程中可能会涉及到对proto文件中message各个fields的修改，可能是更新、删除某个field及其表示，这样可能会导致调用的服务失败。其中一个防止这种问题的方式是，确保你要删除的field的标识（或是名字）是reserved，具体protobuf的编译器会决定未来这个field表示能否被使用。

       5、编译结果

       对于C++开发者来说，使用protoc编译一个proto文件之后，会生成pb.h和pb.cc两个文件。

       二、数值类型

       具体proto类型对应生成类中的类型可以参考官方文档。

       三、默认值

       对于string和byte类型，默认值为空；对于bool类型，默认值是false；对于数值类型，默认值是0；对于枚举类型，默认值是第一个枚举值，默认为0；对于message类型，默认值由编程语言决定；对于repeated field，默认值为空。

       四、枚举类型

       当采用枚举类型的之后，枚举中的值都是预先定义好的，对于上述例子，我们可以再额外增加一个枚举类型corpus，具体如下。

       通常枚举类型的第一个值初始化为0，而且在message中使用枚举类型，必须要给定一个为0的值，而且这个为0的值应该为第一个元素。

       也可以给不同的元素以相同的alias，但是需要指定option allow_alias = true;具体如下。

       除此之外枚举类型不仅可以定义在message内部，也可以定义在message外部，而且在不同message中可以重用enum。

       在更改枚举类型field时，为保证系统运行正常，同样可以指定reserved数字标识和命名。

       五、使用其他message类型

       1、同文件引用

       具体如下：

       2、不同文件引用

       引用其他proto文件中定义好的message类型，具体如下。

       有时我们会对引用的proto文件进行更改，比如将其内容移动到另外一个地方，这样我们就需要对调用方import路径进行更改，当调用方非常多的时候，这种方法是非常低效的，protobuf提供一种机制，我们可以在原有位置提供一个新位置proto文件的“副本”，通过使用import public表示来实现，具体可以参考如下例子。

       这时编译器就会在某些固定目录下查询import的proto文件（具体在命令行编译的时候，由-I/—proto_path指定），如果上述路径找不到，编译器会在调用路径进行查找。通常将—proto_path设置为项目的根目录，然后import的时候使用完整的路径名。

       3、使用proto2中的message类型

       proto2中的枚举类型无法直接使用。

       六、嵌套类型

       具体如下。

       在parent message之外调用嵌套的message可以用如下方式：SearchResponse.Result，嵌套结构可以更加复杂，具体如下：

       七、更新message类型

       当现有的message已经无法满足现有业务需要，你需要更新你的message类型以支持更复杂的业务，这就涉及到向后兼容的问题了，为保证已有服务不受影响，需要遵守以下的一些规定：

       1、不要更改已经存在的fields的数字标识

       2、如果添加新的field，利用旧代码序列化得到的message可以使用新的代码进行解析，你需要记住各个元素的默认值。新代码创建的field同样可以由旧代码进行加解析

       3、field可以被删除，但是需要保证其对应的数字标识不再被使用，你可以通过加前缀的方式来重新使用这个field name，或者指定数字标识为reserved来避免这种情况

       4、int、int、uint、uint、bool这些类型都是互相兼容的，并不会影响前向、后向兼容性

       5、sint和sint之间是互相兼容的，但是和其他数字类型是不兼容的

       6、string和bytes是互相兼容的，只要使用的是UTF-8编码

       7、如果byte包含message的编码版本，则嵌套的message和bytes兼容

       8、flexed兼容sfixed,fixed,sfixed

       9、enum兼容 int, uint, int, and uint。对于这个值在转化时，不同语言的客户端处理方式会有所不同

       感兴趣的小伙伴可以关注公众号：独立团丶

Protobuf3简单使用

       首先，我们来理解什么是Protocol Buffers，简称Protobuf。官方定义它是一种语言和平台无关的结构化数据序列化方法，适用于通信协议和数据存储等领域，它的优点在于体积小、处理速度快且易于使用，特别是对于数据流中的结构化数据操作，它提供了特殊生成的源代码支持，允许在不同语言中轻松读写。

       在Protobuf的版本中，proto3是推荐的新手入门选择，相较于proto2，proto3增加了对更多语言的支持，简化了语法，并引入了新的约定。它删除了复杂特性，使得开发更加直观。

       Protobuf的核心功能包括提供对C++、Java、Python等语言的支持，以及动态编译生成与.proto文件对应的源代码，用于定义协议数据中的实体结构，如消息和字段。message用于定义数据结构，由字段组成，字段包含数据类型、名称、规则、唯一标识和默认值。常见的数据类型如整数、字符串等，字段规则有required（必须）、optional（可选）和repeated（可重复）等。

       举个实例，.proto文件通常以proto3语法声明，定义字段类型如整数、字符串和枚举，分配唯一的标识号。最小标识号从1开始，要预留频繁出现的标识号。字段规则的设置也很重要，尤其是repeated字段的默认编码规则。在单个.proto文件中，可以定义多个相关消息类型，并添加注释以提高可读性。

       当编译.proto文件时，protoc工具会生成特定语言的接口和序列化反序列化功能。解析消息时，字段的默认值会根据类型设定，重复字段默认为空。在IntelliJ IDEA中，可以通过安装Protobuf Support插件来支持.proto文件的语法高亮，并通过配置pom.xml文件和使用maven编译命令生成Java类。

Protobuf入门：在linux下编译使用protobuf

       Google Protocol Buffer（简称Protobuf）是一种由Google公司内部开发的数据标准，用于数据序列化。广泛应用于数据存储和远程过程调用（RPC）系统。它具备语言无关性、平台无关性和可扩展性，支持C++、Java和Python等语言。

       编译源码包：从GitHub下载Protobuf的源代码，以2.5.0版本为例。解压后，执行配置编译命令，创建文件。编译后，文件夹中将包含bin、include和lib目录。

       测试工程：将include目录下的文件按目录结构和lib/libprotobuf.a复制到测试目录。定义结构化数据Content，包含id（int）、str（string）和opt（可选成员）。使用protoc程序将Mymessage.proto文件编译成目标语言，生成Mymessage.pb.h和Mymessage.pb.cc文件。

       将编译后的Mymessage.pb.o文件与Writer.cpp文件一起编译，生成log文件。Reader从log文件读取，反序列化后获得结构化数据。

       Protobuf的优点在于高效、紧凑的二进制数据序列化方式，使其适合数据存储和RPC通信。然而，它缺乏复杂概念表示的能力，与XML相比在通用性上仍有不足。XML自解释性使其在文本描述方面优于Protobuf。

       高级应用包括嵌套消息、Import Message和动态编译。嵌套消息如Person包含PhoneNumber，用于Person中的phone域。Import Message允许在包中定义公用消息，通过包引入使用。动态编译允许在运行时处理未知的.proto文件。

       编写新编译器：利用Google Protocol Buffer源代码中的protoc编译器，可以开发支持其他语言的编译器。通过实现CodeGenerator派生类，实现代码生成功能。

       Protobuf的编码方式使用Varint表示数字，节省空间。Varint用一个或多个字节表示数字，值越小字节越少。消息序列化为紧凑的二进制数据流，无需分隔符，可优化大小。