protocol buffers(三)

这篇文章翻译自https://developers.google.com/protocol-buffers/

Oneof

如果一个Message拥有一堆字段,但同时只有一个字段会被赋值,可以通过Oneof功能来节省内存。
Oneof字段会将多个常规字段共享一块内存,同时只有一个字段会被赋值。赋值任意字段会清除其他已经赋值的字段。你可以通过case()或者WhichOneof()方法检查哪个字段被赋值,根据语言不通检查方法也不同。

使用 Oneof

在proto文件中通过Oneof关键字定义一个oneof类型,下面是test_oneof例子:

message SampleMessage {
  oneof test_oneof {
    string name = 4;
    SubMessage sub_message = 9;
  }
}

可以添加oneof字段,可以添加任意类型字段,但是不能使用repeated 。

Oneof 特征

  • 设置任意值会清除其他字段赋值的值。所以如果你赋值了多个字段,只有最后一个赋值的字段会有值。
SampleMessage message;
message.set_name("name");
CHECK(message.has_name());
message.mutable_sub_message();   // Will clear name field.
CHECK(!message.has_name());
  • oneof 不能使用repeated
  • 反射api对oneof类型好用。
  • 如果使用c++,请确保不要导致内存崩溃。下面的例子演示了内存崩溃,因为sub_message 已经被set_name()清除掉了。
SampleMessage message;
SubMessage* sub_message = message.mutable_sub_message();
message.set_name("name");      // Will delete sub_message
sub_message->set_...            // Crashes here
  • 在C++中,swap()方法会交换内存。下面的例子中msg2将拥有name而msg1将拥有sub_message
SampleMessage msg1;
msg1.set_name("name");
SampleMessage msg2;
msg2.mutable_sub_message();
msg1.swap(&msg2);
CHECK(msg1.has_sub_message());
CHECK(msg2.has_name());

向后兼容性问题

添加或者删除oneof中的字段要小心。如果检查oneof返回None/NOT_SET,它可能表示oneof没有被赋值,也可能表示赋值给了新增的字段。这里无法区分是哪种情况发生。

标签值重用问题

  • 移出或者移入一个字段到oneof,Message在序列化和反序列化之后可能会丢失信息。
  • 删除并重新添加字段到oneof,Message在序列化和反序列化之后可能会清除字段信息。
  • 拆分或者合并oneof,与上面两个问题类似。

Maps

如果你想创建一个Map在你的数据格式定义中,protocol提供一个简单的语法:

map<key_type, value_type> map_field = N;

key_type可以是数值类型或者字符串类型。enum不能作为key_type类型。value_type可以是除了map类型其他任意类型。
例如,定义一个Projects的Map,每个Project 对应一个string类型的键。你可以想下面那样定义:

map<string, Project> projects = 3;
  • Map字段不能是 repeated.
  • Map中值的排序是不一定的。

向后兼容性

map格式化后与下面是一致的,所以即使protocol buffer实现不支持map,一样可以获取数据。

message MapFieldEntry {
  key_type key = 1;
  value_type value = 2;
}

repeated MapFieldEntry map_field = N;

Packages

你可以添加一个可选的package,预防不同的proto文件中Message名称冲突。

package foo.bar;
message Open { ... }

你可以使用package指定Message字段类型

message Foo {
  ...
  foo.bar.Open open = 1;
  ...
}

不同语言对于package的不同处理:

  • 在c++中,生成的class会被放到namespace中,上面的例子,Open会在namespace foo::bar中。
  • 在java中,会按照java的package生成,除非你指定java_package在proto文件开头。
  • 在Python中,package会被忽略,因为python加载是根据系统文件目录来的。
  • 在go语言中,会按照go的package生成,除非你指定go_package在proto文件开头。

定义 Services

如果你想用你定义的Message完成一个RPC (Remote Procedure Call)访问,你可以定义一个RPC服务在proto文件中,protocol buffer编译器会根据你选择的语言生成对应的接口。例如,你想定义一个RPC方法,参数是SearchRequest,返回值是SearchResponse,proto文件中应如下定义:

service SearchService {
  rpc Search (SearchRequest) returns (SearchResponse);
}

使用protocol buffer的RPC系统,最直接的就是gRPC:Google开发的一个多语言,跨平台,开源的RPC系统。gRPC可以和protocol buffer很好的工作,你可以通过proto文件直接生成对应的RPC代码。
这里也有一些第三方实现的RPC使用Protocol Buffer,查看 third-party add-ons wiki page

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,752评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,100评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,244评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,099评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,210评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,307评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,346评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,133评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,546评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,849评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,019评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,702评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,331评论 3 319
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,030评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,260评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,871评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,898评论 2 351

推荐阅读更多精彩内容