protobuf 数据类型


数据格式

限定修饰符 数据类型 字段名字 = 字段编码值 [字段默认值]

基本规范

结构定义可以包含:message、service、enum
Message 命名采用驼峰命名方式,字段命名采用小写字母加下划线分隔方式
message LoginUser{
  required string user_name = 1;
}

enum 类型名采用驼峰命名方式,字段命名采用大写字母加下划线分隔方式
enum Foo {
  FIRST_VALUE = 1;
  SECOND_VALUE = 2;
}

service 与 rpc 方法名统一采用驼峰式命名, 目前未使用到.

限定修饰符

required/optional/repeated

required:表示是一个必须字段.

optional:表示是一个可选字段.

repeated:表示该字段可以包含 0~N 个元素, 相当于传递一个数组的值.

数据类型

可message嵌套,也可以message里面定义enum类型成员,还包括下图各种数据类型

字段名字

rotobuf建议字段的命名采用以下划线分割的驼峰式。例如 first_name 而不是firstName.

字段编码值

有了该值,通信双方才能互相识别对方的字段。当然相同的编码值,其限定修饰符和数据类型必须相同。

编码值的取值范围为 1~2^32(4294967296)。

其中 1~15的编码时间和空间效率都是最高的,编码值越大,其编码的时间和空间效率就越低(相对于1-15),当然一般情况下相邻的2个值编码效率的是相同的,除非2个值恰好实在4字节,12字节,20字节等的临界区。比如15和16.

1900~2000编码值为Google protobuf 系统内部保留值,建议不要在自己的项目中使用。

protobuf 还建议把经常要传递的值把其字段编码设置为1-15之间的值。

消息中的字段的编码值无需连续,只要是合法的,并且不能在同一个消息中有字段包含相同的编码值。

建议:项目投入运营以后涉及到版本升级时的新增消息字段全部使用optional或者repeated,尽量不实用required。如果使用了required,需要全网统一升级,如果使用optional或者repeated可以平滑升级。

字段默认值

可添加默认参数 , eg: required Foo type = 1 [default = FIRST_VALUE]


免责声明!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系本站邮箱yoyou2525@163.com删除。



 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM