Protobuf使用手册范本.doc

《Protobuf使用手册范本.doc》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、Protobuf使用手册第1章定义.proto文件首先我们需要编写一个proto文件，定义我们程序中需要处理的结构化数据，在protobuf的术语中，结构化数据被称为Message。proto文件非常类似java或者C语言的数据定义，可以使用C或C++风格的注释。下面是一个proto文件的例子。packagetutorial;optionjava_package=".example.tutorial";optionjava_outer_classname="AddressBookProtos";messageP

2、erson{requiredstringname=1;requiredint32id=2;//UniqueIDnumberforthisperson.optionalstringemail=3;enumPhoneType{MOBILE=0;HOME=1;WORK=2;}messagePhoneNumber{requiredstringnumber=1;optionalPhoneTypetype=2[default=HOME];}repeatedPhoneNumberphone=4;}//Ouraddressbo

3、okfileisjustoneofthese.messageAddressBook{repeatedPersonperson=1;}一个proto文件主要包含package定义、message定义和属性定义三个部分，还有一些可选项。1.1定义packagePackage在c++中对应namespace。对于Java，包声明符会变为java的一个包，除非在.proto文件中提供了一个明确有java_package。1.2定义messageMessage在C++中对应class。Message中定义的全部属性在cl

4、ass中全部为private的。Message的嵌套使用可以嵌套定义，也可以采用先定义再使用的方式。Message的定义末尾可以采用java方式在不加“;”，也可以采用C++定义方式在末尾加上“;”，这两种方式都兼容，建议采用java定义方式。向.proto文件添加注释，可以使用C/C++/java风格的双斜杠（//） 语法格式。1.3定义属性属性定义分为四部分：标注+类型+属性名+属性顺序号+[默认值]，其示意如下所示。标注类型属性名属性顺序号[默认值]requiredstringname=1[default

5、=””];其中属性名与C++和java语言类似，不再解释；下面分别对标注、类型和属性顺序号加以详细介绍。其中包名和消息名以及其中变量名均采用java的命名规则——驼峰式命名法，驼峰式命名法规则见附件1。1.3.1标注标注包括“required”、“optional”、“repeated”三种，其中required表示该属性为必选属性，否则对应的message“未初始化”，debug模式下导致断言，release模式下解析失败；optional表示该属性为可选属性，不指定，使用默认值（int或者char数据类型默

6、认为0,string默认为空，bool默认为false，嵌套message默认为构造，枚举则为第一个）repeated表示该属性为重复字段，可看作是动态数组，类似于C++中的vector。如果为optional属性，发送端没有包含该属性，则接收端在解析式采用默认值。对于默认值，如果已设置默认值，则采用默认值，如果未设置，则类型特定的默认值为使用，例如string的默认值为””。1.1.1类型Protobuf的属性基本包含了c++需要的所有基本属性类型。protobuf属性C++属性java属性备注doubled

7、oubledouble固定8个字节floatfloatfloat固定4个字节int32int32int32使用变长编码，对于负数编码效率较低，如果经常使用负数，建议使用sint32int64int64int64使用变长编码，对于负数编码效率较低，如果经常使用负数，建议使用sint64uint32uint32int使用变长编码uint64uint64long使用变长编码sint32int32int采用zigzag压缩，对负数编码效率比int32高sint64int64long采用zigzag压缩，对负数编码效率比

8、int64高fixed32uint32int总是4字节，如果数据>2^28，编码效率高于unit32fixed64uint64long总是8字节，如果数据>2^56，编码效率高于unit32sfixed32int32int总是4字节sfixed64int64long总是8字节boolboolbooleanstringstringString一个字符串必须是utf-8编码或者7-bit的