美文网首页
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编码规范和注意点

    (1)定义package 属性的时候,同时也要定义java_package属性 虽然说不定义java_packag...

  • Protobuf编码原理

    目标 本文主要介绍protobuf的编码方式,包括varint编码。分析一下protobuf兼顾数据压缩和高性能的...

  • 2017.12.11 CSS编码规范、APPCan常用、Ado.

    第一组:杨昊 CSS编码规范 好久没出现,今天来分享一些平常不会注意的小细节—CSS编码规范(基础): 编码规范...

  • 前端开发文档规范

    HTML 编码规范 请查看HTML编码规范 CSS 编码规范 请查看CSS编码规范 JavaScript 编码规范...

  • 深入 ProtoBuf - 序列化源码解析

    在上一篇 深入 ProtoBuf - 编码 中,我们详细解析了 ProtoBuf 的编码原理。 有了这个知识储备,...

  • Objective-C 编码规范

    目录 编码规范Chinamobo 编码规范补充代码规范注释前缀引入其他文件类中属性定义空行和空格 编码规范 Chi...

  • Go protobuf

    使用protobuf实现节点间通信、编码报文以提高传输效率 protobuf全程Protocol Buffers,...

  • 编码注意点

    1.日志可读性好,容易定位问题 2.接口错误码统一,自解释,根据错误码,一步定位到原因 3.接口 需要做强校验,统...

  • 编码规范(一)越是建议的编码规范越会令团队纠结

    所属文章系列及序号:寻找尘封的银弹:编码规范(一) 我见过很多编码规范,例如C++编码规范、Java编码规范、C+...

  • 前端开发规范(实验室版)

    前端编码规范—— HTML 篇 前端编码规范—— CSS 篇 前端编码规范—— JavaScript 篇 这几天和...

网友评论

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

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