美文网首页
Protobuf编码规范和注意点

Protobuf编码规范和注意点

作者: 邝健强 | 来源:发表于2017-09-15 20:46 被阅读0次

    (1)定义package 属性的时候,同时也要定义java_package属性

    虽然说不定义java_package属性也行,因为不定义java_package属性默认会根据package定义的属性放置包,但是一般不建议这么做,因为在protobuf中,package定义的是在protobuf跨语言级别的命名空间,也就是说它可以避免与非java语言命名的冲突。

    (2)分配的标号,一般使用1~15来标号常用或者重复的元素,用16以上的标号不常用元素。1~15的标号占一个字节,16以上的标号占更多字节(具体如下图)。重复的字段需要重新分配标号,所以重复字段是这种优化的候选者。

    (3)buider和message(详细的后面会说),提供一些公有方法:

    toString:提供一种更友好的展现消息内容

    mergeFrom(builder提供):可以和合并其他消息,singular标注的简单类型字段会覆盖,复合类型会被合并,repeated字段会连接起来。

    强制性:

    1.必须在第一行定义protobuf的版本,如:syntax="proto3"

    2.使用java_outer_classname定义的类名必须不能跟message所声明的名字一样(不一样不会报错,但是不生成代码)

    3.分配的标号不能重复,删除字段的标号不要重新使用

    一般遵循一下原则:

    (1)不改变现有字段的tag分配

    (2)添加新字段从未使用的tag中,不包括那些删除的tag

    4.删除字段的方式

    (1)删除字段

    (2)使用reserved关键字回收字段标号

    eg:reserved 2,15  或者  reserved "字段名1","字段名2"

    5.对于枚举值有几个地方要说明的

    (1)不要在轻易砸枚举值中声明allow_alias=true,一般用作兼容旧代码

    枚举allow_alias

    这种在同一个枚举值使用allow_alias=true为两个不同名枚举值声明相同标号,一般是兼用前端老代码的。

    (2)不能在相同命名空间中,两个不同的枚举类型声明相同名字的枚举。

    同一命名空间下,不同枚举类型使用相同名字标识


    相关文章

      网友评论

          本文标题:Protobuf编码规范和注意点

          本文链接:https://www.haomeiwen.com/subject/kdgcsxtx.html