文档介绍：Protobuf使用手册
文件
首先我们需要编写一个 proto 文件,定义我们程序中需要处理的结构化数据,在 protobuf 的术语中,结构化数据被称为 Message。proto 文件非常类似 java 或者 C 语言的数据定义,可以使用C或C++风格的注释。下面是一个proto文件的例子。
package tutorial;
option java_package = "";
option java_outer_classname = "AddressBookProtos";
message Person {
required string name = 1;
required int32 id = 2; // Unique ID number for this person.
optional string email = 3;
enum ype {
MOBILE = 0;
HOME = 1;
WORK = 2;
}
message PhoneNumber {
required string number = 1;
optional ype type = 2 [default = HOME];
}
repeated PhoneNumber phone = 4;
}
// Our address book file is just one of these.
message AddressBook {
repeated Person person = 1;
}
一个proto文件主要包含package定义、message定义和属性定义三个部分,还有一些可选项。
定义package
Package在c++中对应namespace。
对于Java,包声明符会变为java的一个包,。
定义message
Message在C++中对应class。Message中定义的全部属性在class中全部为private的。
Message的嵌套使用可以嵌套定义,也可以采用先定义再使用的方式。
Message的定义末尾可以采用java方式在不加“;”,也可以采用C++定义方式在末尾加上“;”,这两种方式都兼容,建议采用java定义方式。
,可以使用C/C++/java风格的双斜杠(//) 语法格式。
定义属性
属性定义分为四部分:标注+类型+属性名+属性顺序号+[默认值],其示意如下所示。
标注
类型
属性名
属性顺序号
[默认值]
required
string
name
= 1
[default=””];
其中属性名与C++和java语言类似,不再解释;下面分别对标注、类型和属性顺序号加以详细介绍。
其中包名和消息名以及其中变量名均采用java的命名规则——驼峰式命名法,驼峰式命名法规则见附件1。
标注
标注包括“required”、“optional”、“repeated”三种,其中
required表示该属性为必选属性,否则对应的message“未初始化”,debug模式下导致断言,release模式下解析失败;
optional表示该属性为可选属性,不指定,使用默认值(int或者char数据类型默认为
0,string默认为空,bool默认为false,嵌套message默认为构造,枚举则为第一个)
repeated表示该属性为重复字段,可看作是动态数组,类似于C++中的vector。
如果为optional属性,发送端没有包含该属性,则接收端在解析式采用默认值。对于默认值,如果已设置默认值,则采用默认值,如果未设置,则类型特定的默认值为使用,例如string的默认值为””。
类型
Protobuf的属性基本包含了c++需要的所有基本属性类型。
protobuf属性
C++属性
java属性
备注
double
double
double
固定8个字节
float
float
float
固定4个字节
int32
int32
int32
使用变长编码,对于负数编码效率较低,如果经常使用负数,建议使用sint32
int64
int64
int64
使用变长编码,对于负数编码效率较低,如果经常使用负数,建议使用sint64
uint32
uint32
int
使用变长编码
uint64
uint64
long
使用变长编码
sint32
int32
int
采用zigzag压缩,对负数编码效率比int