1.一文读懂——Protobuf
2.网络数据通信—ProtoBuf实现序列化和反序列化
3.1.1.1模型描述与序列化方法之Protobuf(一):初步使用
4.protobuf 详解
5.在C++中使用Protobuf
6.七爪源码:学习用于序列化结构化数据的源码协议缓冲区 (Protobuf) — 第 1 部分
一文读懂——Protobuf
快速理解Protocol Buffers
Protocol Buffers(简称Protobuf),是分析Google为内部通信和数据存储设计的一种高效轻量级的数据结构格式。全球已有超过,源码种报文格式定义和,个.proto文件应用于RPC系统和持久化存储。它的分析优势在于结构化数据的序列化与跨语言、平台的源码兼容性,适用于即时通讯和数据存储等领域。分析工时系统java源码 与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++风格,通过预留字段处理更新后的兼容性问题。默认值根据字段类型设定,如字符串、布尔值等。在枚举定义上,需确保第一个枚举值为0且无重复,除非启用别名选项。 使用.proto文件定义的数据结构需通过protoc编译器生成接口代码,以支持序列化和反序列化。win linux集群源码然而,使用CMake的execute_process命令可能存在重新生成源码导致频繁编译的问题。 实例演示包括定义.proto文件、编写读写函数以及配置文件的使用,展示了如何在实际项目中应用Protocol Buffers。更多详细信息,请参考官方文档。网络数据通信—ProtoBuf实现序列化和反序列化
Protobuf实现序列化和反序列化 本文将介绍如何通过Protobuf实现网络数据通信,具体案例中我们构建一个通讯录应用,包含客户端和服务器端的交互。主要需求包括: 客户端可执行的操作:新增联系人、删除联系人、查询通讯录列表、查询联系人详细信息。 服务器端提供增删查能力,并确保数据持久化。 客户端与服务器间交互数据使用Protobuf。 环境搭建 选择cpp-/yhirose/cpp-... CentOS环境注意事项 在CentOS下,若使用自带的g++版本(如4.8.5,发布于年),在编译项目时可能遇到问题。解决方法是升级gcc/g++至更高版本。 约定双端交互接口新增联系人
删除联系人
查询通讯录列表
查询联系人详细信息
约定双端交互req/resp 设计了多个protobuf文件用于定义请求和响应结构,包括base_response.proto、add_contact_request.proto至find_all_contacts_response.proto等。 相关视频推荐高性能服务器通信协议设计的奥秘:XML、JSON、Protobuf性能对比分析
Protobuf序列化协议工程应用方法和实践分析
qq微信即时通讯技术细节:方案选择
C/C++ Linux服务器架构师学习资料分享群:(包含C/C++、Linux、golang等技术资料)
客户端代码实现main.cc:主程序
ContactException.h:异常类定义
ContactsServer.h:客户端通讯录服务端定义
ContactsServer.cc:客户端通讯录服务实现
服务端代码实现定义通讯录结构(contacts.proto)
main.cc:服务端主程序
ContactException.h:异常类定义
ContactsServer.h:通讯录服务定义
ContactsServer.cc:通讯录服务实现
Utils.h:工具类定义
ContactsMapper.h:数据持久化接口定义
ContactsMapper.cc:数据持久化接口实现
注:在实际应用中,应将通讯录数据存储至数据库,此处为简化流程,以本地文件作为数据存储。1.1.1模型描述与序列化方法之Protobuf(一):初步使用
protobuf的使用流程相对直接,主要包括安装、编译.proto文件和生成可执行文件。本文将主要关注.proto文件的语法规则。1. 安装与配置
尽管具体版本需要在实际操作中指定,但安装过程通常是下载并执行相应的protobuf可执行文件protoc。2. 编译.proto文件
将编写好的.proto文件通过protoc工具编译,生成工程所需的pb.h和pb.cpp源文件。命令行操作简单,只需指定输入目录、输出目录和要编译的.proto文件名。3. 生成可执行文件
将编译得到的.pb.h和.pb.cpp文件与你的cpp源码一起编译,使用pkg-config提供的福利直播聚合源码protobuf编译参数。4. Proto文件语法详解
Proto文件的基本结构为"字段规则 数据类型 名称 = 域值 [选项 = 选项值];"。字段规则有repeated、optional、required和reserved。例如:repeated string name = 1; 表示可多次出现,包括0次。
optional string name = 1 [default ""]; 表示0次或1次出现,可指定默认值。
required string name = 1; 必须出现1次。
reserved name; 表示废弃,用于迭代更新。
数据类型分为基本类型(如float、uint、string、bool)和复合类型(如message、enum、oneof和map)。message类似C++中的类,而enum则对应枚举。5. 选项与优化
选项如default和packed用于设置默认值和优化编码效率,而deprecated用于标记过时属性。6. 其他
高级功能如extensions、service和options通常不常用,相关内容请参考官方文档。7. 代码接口
编译后的接口结构在官方文档中详细说明,此处不再赘述。protobuf 详解
Protobuf,即Protocol Buffers,是Google公司设计的一种轻量级、高效的结构化数据存储格式,用于结构化数据的序列化。它被广泛应用于数据存储和远程过程调用(RPC)的数据交换,支持语言无关、平台无关、可扩展的序列化结构数据格式。目前主要提供了C++、Java和Python三种语言的API。
Protobuf的优势在于其简洁性和高效性,允许开发者定义数据结构,并以二进制格式进行序列化和反序列化,从而节省了数据传输和存储的空间,同时也加快了数据处理的速度。然而,它也有一些劣势,比如学习曲线陡峭,对于初学者来说可能需要一定时间来熟悉其语法和使用方法。ios源码分析工具
在安装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(互斥字段组)特性,用于定义具有预定义值列表的字段和最多只能设置其中一个字段的字段组。
为了将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相关的代码。
在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) — 第 1 部分
在深入探讨 Protocol Buffers 之前,让我们先了解序列化和反序列化的基本概念。序列化是指将对象转换为线性字节序列以便存储或传输到另一位置的过程。反序列化则是获取存储信息并从中重新创建对象的过程。随着数据的不断增长,序列化和反序列化的数据方法也在不断发展。
CSV(逗号分隔值)是一种易于解析和读取的方法,但存在一些缺点,如必须推断数据类型且不保证。当数据包含逗号且列名存在或不存在时,解析变得困难。关系表定义添加了类型信息,数据是完全类型化的,且可以放入表格中。然而,数据必须是平面的,并且不同数据库的数据定义各不相同。JSON(JavaScript 对象表示法)是一种广泛接受的网络格式,数据可以采用任意形式,易于被多数编程语言读取,并且可通过网络轻松共享。然而,JSON 数据没有模式强制,且 JSON 对象大小较大,因为重复的键。
XML(可扩展标记语言)使用类似于 JSON 的元标记,但带有结束标记。由于它们具有结束标记,因此与 JSON 相比,它们的大小要大得多。
Protocol Buffers(或 Protobuf)是一种语言中立、平台中立的可扩展数据序列化协议,不同于 JSON 或 XML。Protobuf 不适合人类使用,因为序列化数据是编译后的字节,难以供人类阅读。它是 Google 用于序列化结构化数据的机制。
Protocol Buffers 的优点包括易于跨编程语言共享数据。在 .proto 文件上运行 Protocol Buffers 编译器时,编译器会以所选语言生成代码。我们只需使用在 .proto 文件中描述的消息类型,包括获取、设置字段值、将消息序列化到输出流以及从输入流解析消息。
为了更高效地设计 .proto 文件,Google 提供了样式指南,应尽量遵守。标准文件格式包括许可证标题(如有适用)、文件概述、语法、包装、导入(排序)、文件选项和其他内容。在 Protocol Buffers 中,字段标签非常重要。最小标签值可以是 1,最大标签值可以是 2²⁹–1 或 ,,。编号从 1 到 的标签使用 1 个字节,而编号从 到 的标签使用 2 个字节。对经常填充的字段使用 1 到 个标签号。
Protocol Buffers 支持多种字段类型,如布尔型、字符串、字节、重复字段、枚举等。在 Protocol Buffers 中,字段名称不重要,它们仅在编程中引用字段时重要。字段标签很重要,最小标签值可以是 1,最大标签值可以是 ,,。编号从 1 到 的标签使用 1 个字节,而编号从 到 的标签使用 2 个字节。对经常填充的字段使用 1 到 个标签号。
枚举允许我们定义事先知道的一个字段可以取的所有值。默认字段值为布尔型的假、数字的 0、字符串的空字符串、字节的空字节、重复的空列表和枚举的第一个值。我们还可以使用其他消息类型作为字段类型。嵌套类型有助于避免命名冲突并加强局部性。在下一篇文章中,我们将探讨 Protocol Buffers 的高级概念。
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。对于这个值在转化时,不同语言的客户端处理方式会有所不同
感兴趣的小伙伴可以关注公众号:独立团丶
2024-11-28 23:11
2024-11-28 21:42
2024-11-28 21:30
2024-11-28 21:26
2024-11-28 21:26
2024-11-28 21:11