关于protobuf的笔记

package tutorial;在Protocol Buffers命名空间和非Java语言中避免命名冲突

option java_package = "com.example.tutorial";包名,

option java_outer_classname = "AddressBookProtos";类名

一个message只是一系列具有类型的域的集合。许多标准的简单类型可以做为可用的域类型,包括bool, int32, float, double, 和string。enum

required:域的值必须被提供,否则message会被认为是“未初始化的”。试图创建一个未初始化的message将会抛出一个RuntimeException。转化一个未初始化的message将会抛出一个IOException。除了这些,required域的行为和optional域表现相同。

optional:该域可能被设置,也可能未被设置。如果一个optional域未被设置,默认的值将会被使用。对于简单类型来说,你可以指定你自己的默认值,就像我们在例子中对phone number类型所做的那样。否则,一个系统默认的值将被使用:数值类型是0,字符串类型是"",布尔类型是false。对于嵌入式的message来说,默认值总是这个message的没有任何域被设置过的“默认实例”或“原型”。调用访问器去获取一个optional或者required域的值,这些域如果没有被具体设置,那么总是返回域的默认值。

repeated:域将会被重复任意次数(包括0次)。重复的值的顺序将会被保存在protocol buffer中。可以把重复的域想成变长的数组。

每一个域都有简单的JavaBeans风格的getters和setters方法。如果一个域被设置了值,同样会有getters为每一个单独的域。最后,每一个域都有一个clear方法,用来将域设置回原来的空状态。

Repeated域有一些额外的方法--一个Count方法(用来速记列表的大小),getters和setters用来通过下标,get或者set一个具体的元素。一个add方法用来向列表中追加一个新元素。一个addAll方法用来追加整个容器中的元素到列表中。

isInitialized():检查是否所有的required域都已经被设置过。

toString():返回一个便于人眼阅读的message的展示,在debug的时候特别有用。

mergeFrom(Message other):(builder特有)合并other的内容到这个message中,如果是单数域则覆盖,如果是重复域则追加连接。

clear():(builder特有)清空所有的域,回到空值状态。

byte[] toByteArray();:序列化message并返回一个包含它原始字节的byte数组。

static Person parseFrom(byte[] data);:从给出的byte数组转化一个message。

void writeTo(OutputStream output);:序列化message,并将其写入一个OutputStream。

static Person parseFrom(InputStream input);:从一个InputStream中读取并转化一个message。

Protocol message类提供的一个关键特性是反射。你可以迭代一个message中的域,并且不用写任何与message中类型抵触的代码,来操作它们的值它们的值。一个非常有用的方法是使用反射来将protocol message转为或转自其它的编码方式,比如:XML或JSON。

你一定不能改变任何已存在的域的tag number。

你一定不能添加或删除任何required域。

你可以删除optional域或repeated域。

你可以添加新的optional域或repeated域,但是你必须使用新的tag number(比如:你在这个protocol buffer中从没使用过的tag number,甚至不能是已删除的域的tag number)。

(关于这些约定有一些例外的情况,但它们极少被用到。)

如果你遵守这些规则,旧的代码将会很好地读取新的message,并且轻易地忽略任何新的域。对于旧的代码来说,被删除的optional域将有它们的默认值,并且被删除的repeated域将会为空。新的代码将会透明地读取旧的message。然而,需要牢记的是新的optional域将不会在旧的message中出现,所以你将需要具体检查它们是否被has_设置,或者提供一个可靠的默认值在你的.proto文件中,即在tag number后面写[default = value]。如果一个optional元素未被具体指定,那么取而代之地,一个具体类型的默认值将被使用:对于string,默认值是空串。对于boolean,默认值是false。对于numeric类型,默认值是0。同样记得,如果你添加了一个新的repeated域,你的新代码将不能识别它是被置空(通过新的代码)还是从来没有被设置过(通过旧的代码)。因为,没有为它提供has_标记。

protoc.exe --java_out=E:\java PersonMsg.proto

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

推荐阅读更多精彩内容