google--Protobuffer 编译器 总结分析
简介
protobuffer是一种灵活,高效,自动化的机制,用于序列化结构化数据。想想XML,但更小,更快,更简单
对比XML
对于序列化结构化数据,protobuffer比XML具有许多优点。protobuffer:
更简单
3到10倍
20到100倍
生成更易于以编程方式使用的数据访问列
特点
google protobuf是跨语言的,并且自带了一个编译器(protoc),只需要用它进行编译,可以编译成Java、python、C++、C#、Go等代码,然后就可以直接使用,不需要再写其他代码,自带有解析的代码。
使用流程
1 在.proto文件中定义消息格式
2 用protobuf编译器编译.proto文件
3 用C++ 对应的protobuf API来写或者读消息
( 说明:.proto文件是protobuf一个重要的文件,它定义了需要序列化数据的结构。)
消息结构和数据类型
proto 实际上是一个 key-value结构的类型,编码的时候,key 和 value 是连在一起写入二进制数据的。解码的时候解析器必须能跳过不认识的字段,这样当同一个Proto 结构加入新的字段时,才能保证旧协议的兼容。
proto 给每一个数据类型都定义了一个 wire_type, 不同的 wire_type 采用不同的编码方式。
说明:发现简书这里不好写代码的,直接在我CSDN中截图了,希望大家理解
key 实际上是由两个值组成的,每个字段的编号 (field_number) + 该字段的数据类型 (wire_type)。
详细解说
1)定义一个 Message 类型
假设要定义一个搜索请求的 message 格式,其中每个搜索请求都有一个查询字符串,你感兴趣的特定结果页数(第几页)以及每页的结果数。
message SearchRequest
{
requiredstringquery =1;// 查询字符串
optional int32 page_number =2;// 第几页
optional int32 result_per_page =3;// 每页的结果数
}
SearchRequest message 定义指定了三个字段(名称/值对),每个字段对应着要包含在 message 中的数据,每个字段都有一个名称和类型。
上面的示例中,所有字段都是 标量类型:两个整数(page_number 和 result_per_page)和一个字符串(query)。(还可以为字段指定复合类型,包括枚举 和其它的 message 类型。)
建议每个 .proto 文件包含尽可能少的 message 类型。
分配字段编号
message 定义中的每个字段都有唯一编号。这些数字以 message 二进制格式标识你的字段,并且一旦你的 message 被使用,这些编号就无法再更改。
请注意,1 到 15 范围内的字段编号需要一个字节进行编码,编码结果将同时包含编号和类型。16 到 2047 范围内的字段编号占用两个字节。因此,你应该为非常频繁出现的 message 元素保留字段编号 1 到 15。请记住为将来可能添加的常用元素预留出一些空间。
字段编号范围:以指定的最小字段数为1,最大字段数为536,870,911。
(你也不能使用 19000 到 19999 范围内的数字,因为它们是为 Protocol Buffers 的实现保留的 - 如果你使用这些保留数字之一,编译器会报错你的 .proto)
指定字段规则
指定的 message 字段可以是下面几种情况之一:
required: 格式良好的 message必须包含该字段一次。
optional: 格式良好的 message 可以包含该字段零次或一次(不超过一次)。
repeated: 该字段可以在格式良好的消息中重复任意多次(包括零)。其中重复值的顺序会被保留。
新代码应使用特殊选项[packed = true] 来获得更高效的编码,如:
repeated int32 samples =4[packed=true];
.proto 文件将生成什么?
在 .proto 上运行 protocol buffer 编译器时,编译器将会生成所需语言的代码,这些代码可以操作文件中描述的message 类型,包括获取和设置字段值、将 message 序列化为输出流、以及从输入流中解析出 message。
对于 C++,编译器从每个 .proto 生成一个 .h 和 .cc 文件,其中包含文件中描述的每种 message 类型对应的类。
标量值类型
定义 protocol 格式
需要从 .proto 文件开始,.proto 文件中的定义很:为要序列化的每个数据结构添加 message 定义,然后为 message 中的每个字段指定名称和类型。下面就是定义相关 message 的 .proto 文件:
required:必须提供该字段的值,否则该消息将被视为“未初始化”。如果是在调试模式下编译 libprotobuf,则序列化一个未初始化的 message 将将导致断言失败。在优化的构建中,将跳过检查并始终写入消息。
optional: 可以设置也可以不设置该字段。如果未设置可选字段值,则使用默认值。对于简单类型,你可以指定自己的默认值,就像我们在示例中为电话号码类型所做的那样。否则,使用系统默认值:数字类型为 0,字符串为空字符串,bools 为 false。对于嵌入 message,默认值始终是消息的 “默认实例” 或 “原型”,其中没有设置任何字段。。
repeated: 该字段可以重复任意次数(包括零次)。重复值的顺序将保留在 protocol buffer 中。可以将 repeated 字段视为动态大小的数组。
标准 Message 方法
每个 message 类还包含许多其他方法,可用于检查或操作整个 message,包括:
解析和序列化
每个 protocol buffer 类都有使用 protocol buffer 二进制格式 读写所选类型 message 的方法。包括:
希望对你有帮助。