关于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

你可能感兴趣的:(关于protobuf的笔记)