syntax
第一个非注释的语句必须是syntax ,它表示使用什么版本的语法,如果没有使用默认是proto2版本语法
Message
Message含义
Mesage就像c++的一个类,其列(field)变量就像它的成员,当列变量是整形(内置类型)时,它就像有个相应变量名的函数,当列变量是Message类型时,它就像有个成员变量,这个成员变量也是一个类。
Message语法
message Foo{
关键字 类型 变量名 = field_number;
enum Color{
BLACK=0;
RED=1;
}
oneof test_oneof{
类型 变量名 = field_number;
}
map<KeyType,ValueType> object \
= field_number;
required关键字
在使用protobuf编译器生成的文件中,必须去设置这个值
optional关键字
这个在使用这个关键字的时候,可以设置一次或者不设置它的值,不能设置多次。
对于optional 关键字,它还有一个独特的功能就是设置默认值
message Foo{
optional string name = 1[default = "YuTian"];
}
repeated关键字
这个关键字表示可以设置多个值,它的使用就像数组一样,大家可以试试看看生成代码的接口。还有一点就是对于这个接口大家使用的时候,对于标量类型的时候,其后面应该加上[packed=true]来增加其编码性能
repeated int32 samples = 4 [packed=true];
reserved Values用法
当我们使用枚举类型在protobuf中的时候,发现以前的设计不合理我们可能会屏蔽或者删除掉标识符或者变量,这个时候可能会发生一些bug。
old.proto
message Car{
optional int32 far = 1 [default = 2];
}
now.proto
message Car{
// optional int32 far =1 [default = 2];
}
future.proto
message Car {
optional int32 far = 1 [default = 10];
}
正确姿势
message Car {
reserved "far";
reserved 1,2,3 to10 ;
}
使用reserved 修饰后未来在使用这个标识符就会编译报错,所以它的语义表示被保留的我们不能随意使用
field_number
field_number是用Varint编码的,所以它的值越大越占用编码,最小为1,最大为2^29 - 1 ,其中19000 - 19999 是不能定义的,因为这个是保留给编译器的
Message可定义的类型
标量
枚举
1.它的成员必须是 int32位,它是采用Varint编码的,所以负数很浪费空间。
2.第二个它可以在一个Message内定义,在另一个message内使用,方法是Message.enum
3.它支持不同的常量赋同一个值,但是前提是设置了allow_alias选项
enum EnumAllowingAlias {
option allow_alias = true;
UNKNOWN = 0;
STARTED