文章目录
- 1.0版本
- 一、编写.proto文件
- 1.文件规范：
- 2.注释方式：
- 3.指定proto3语法：
- 4.package申明符
- 5.定义message
- 6.编写消息字段
- ①类型对照表
- ②唯一编号
- 二、编译.proto文件
- 1. 编译指令
- 2.源码分析
- 三、序列化和反序列化的使用
- 四、小结
1.0版本
本系列文章将通过对通讯录项目的不断完善，带大家由浅入深的学习Protobuf的使用。这是Contacts的第一个版本，在这篇文章中将带大家快速上手Protobuf
一、编写.proto文件
1.文件规范：
- 创建.proto文件时，文件命名应该使用全小写字母命名，多个字母之间用 _ 连接。例如：
lower_snake_case.proto。- 书写.proto文件代码时，应使用2个空格的缩进
2.注释方式：
使用 // 或者 /**/ 进行注释
3.指定proto3语法：
在文件首行中指定该proto文件所采用的语法
syntax = "proto3";
🎯[说明]:
ProtocolBuffers语言版本3，简称proto3，是.proto文件最新的语法版本。相较于proto2，语法更加简化，使用更加简单
4.package申明符
package xxx; // 可选
🎯[说明]:
声明的package在项目中应该具有唯一性，它的作用是避免我们定义的消息发生冲突。它就类似于C++的命名空间，实际上进过编译器编译后就会变成相同名字的 命名空间
5.定义message
消息（message）就是要定义的结构化对象，我们可以给这个结构化对象中定义其对应的消息字段。message经编译器编译后转变成对应的类（C++）
// message 格式
message MessageName{
}
// 消息类型命名规范：使用驼峰命名法，首字母大写
6.编写消息字段
消息字段的格式定义为：类型 字段名 = 唯一编号
• 字段名称命名规范：全小写字母，多个字母之间用 _ 连接。
• 字段类型分为：标量数据类型和特殊类型（包括枚举、其他消息类型等）。
• 字段唯一编号：用来标识字段，一旦开始使用就不能够再改变
①类型对照表
| .proto type | note | C++ type |
|---|---|---|
| double | double | |
| float | float | |
| int32 | 使用变长编码[1]。负数的编码效率较低⸺若字段可能为负值，应使用sint32代替。 | int32 |
| int64 | 使用变长编码[1]。负数的编码效率较低⸺若字段可能为负值，应使用sint64代替。 | int64 |
| uint32 | 使用变长编码[1] | uint32 |
| uint64 | 使用变长编码[1] | uint64 |
| sint32 | 使用变长编码[1]。符号整型。负值的编码效率高于常规的int32类型。 | int32 |
| sint64 | 使用变长编码[1]。符号整型。负值的编码效率高于常规的int64类型。 | int64 |
| fixed32 | 定长4字节。若值常大于2^28则会比uint32更高效 | uint32 |
| fixed64 | 定长8字节。若值常大于2^56则会比uint64更高效 | uint64 |
| sfixed32 | 定长4字节。 | int32 |
| sfixed64 | 定长8字节。 | int64 |
| bool | bool | |
| string | 包含UTF-8和ASCII编码的字符串，长度不能超过 2^32 | string |
| bytes | 可包含任意的字节序列但长度不能超过2^32 | string |
[1]变长编码是指：经过protobuf编码后，原本4字节或8字节的数可能会被变为其他字节数，可能会变得更长也可能会变得更短。
②唯一编号
唯一编号用于唯一的标识每一个字段，在解析和序列化的时候可以准确快速的定位到每个字段的位置和大小。
有两点需要特别说明：
- 编号的范围为
1 ~ 536,870,911(2^29-1)，其中19000~19999不可用。因为Protobuf协议的实现过程中对预留了这些编号- 范围为1 ~ 15的字段编号需要一个字节进行编码，16~2047内的数字需要两个字节进行编码。
- 编码后的字节不仅只包含了编号，还包含了字段类型。所以1~15要用来标记出现非常频繁的字段，要为将来有可能添加的、频繁出现的字段预留一些出来
到目前为止，我们通讯录可以写下这样的 contact.proto 文件
// 指定采用 proto3 语法
syntax = "proto3";
// 相当于命名空间
package contacts;
message PeopleInfo{
string name = 1; //不是赋值，而是指定唯一编号
int32 age = 2;
}
二、编译.proto文件
1. 编译指令
protoc [--proto_path=IMPORT_PATH] --cpp_out=DST_DIR file.proto
- protoc：编译工具
- –proto_path：指定 .proto 文件的检索路径，可以多次指定指定。不指定默认在当前文件夹下检索。可以简写为
-I.- –cpp_out：指定编译后的文件类型为C++
- DST_DIR：指定文件的生活生成路径
- file.proto：指定要编译的 .proto 文件（–proto_path 路径下的）
如果我们在 contact.proto 文件所在路径下，则可以使用下面的指令直接生成
protoc --cpp_out=. contact.proto
编译后自动为我们生成了 .cc 和 .h 文件。这也印证了我们前面所说的Protobuf使用特点：ProtoBuf是通过Protoc编辑器编译生成的头文件和源文件来使用的
2.源码分析
-
package contacts被转换成了相应的命名空间namespace contacts
-
message PeopleInfo被转换成class PeopleInfo
-
protobuf为message中每一个字段都提供了对应的处理方法。例如：
字段获取方法与字段名相同，设置方法则以set_开头
-
序列化和反序列化方法定义在
class PeopleInfo继承的基类MessageLite中// 部分方法如下 bool ParseFromString(ConstStringParam data); bool ParseFromArray(const void* data,int size); bool ParseFromIstream(std::istream* input); bool SerializeToString(std::string* output) const; bool SerializeToArray(void* data, int size) const; bool SerializeToOstream(std::ostream* output) const;🎯[说明]:
- Protobuf中所有序列化的结果都是二进制的字节序列形式，不像json会以文本的形式呈现。所以相对于xml和JSON来说，因为被编码成二进制，破解成本增大，ProtoBuf编码是相对安全的
- 上面的序列化非序列化方法没有本质的区别，只是输入输出的形式不同罢了
- 关于message完整的API介绍参见官方文档 API
三、序列化和反序列化的使用
#include <iostream>
#include <string>
#include "contact.pb.h"
using namespace std;
int main(){
string people_str;
{
contacts::PeopleInfo people;
people.set_age(20);
people.set_name("张三");
if(!people.SerializeToString(&people_str)){
cerr << "serialize failied" << endl;
}
cout << people_str << endl;
}
{
contacts::PeopleInfo people;
if(!people.ParseFromString(people_str)){
cerr << "parse failed" << endl;
}
cout << "反序列化的结果为:" << endl;
cout << "name: " << people.name() << endl;
cout << "age: " << people.age() << endl;
}
}
在编译链接的时候记得带上 -l 选项指定要链接的库
g++ -o main main.cc contact.pb.cc -std=c++11 -lprotobuf
四、小结
- 编写 .proto 文件的目的是为了定义结构体对象及其属性内容
- 编译 .proto 文件是为了生成一系列代码接口存放在 .cc 和 .h 文件中
- 我么的业务代码依赖生成的接口就可以轻松完成成员变量的获取、设置、序列化反序列化等工作，极大的减轻了程序员的负担
