protobuf java编码基础

Protobuf java基础

本文档为java编程人员使用protocol buffer提供了一个基本的介绍，通过一个简单的例程进行介绍。通过本文，你可以了解到如下信息：

1、在一个.proto文件中定义一个信息格式.

2、使用protoc命令进行编译,生成java代码.

3、使用Java protocol buffer API进行读写操作.

l  定义proto文件

以一个地址薄为例,从建立一个.proto文件开始,为需要序列化的数据接口加入一个message属性,在message里面,为每一个字段指定名称和类型,如下所示：

package tutorial;   option java_package = "com.example.tutorial"; option java_outer_classname = "AddressBookProtos";   message Person {   required string name = 1;   required int32 id = 2;   optional string email = 3;     enum PhoneType {     MOBILE = 0;     HOME = 1;     WORK = 2;   }     message PhoneNumber {     required string number = 1;     optional PhoneType type = 2 [default = HOME];   }     repeated PhoneNumber phone = 4; }   message AddressBook {   repeated Person person = 1; }

正如你所见, c++和Java中message定义的语法类似,下面我们来看看每个部分的意义:

     为了避免命名冲突，.proto文件以包声明开始，在java中除了特别指定一个java_package属性，否则包名一般为Java的包。正像上面的例子，虽然提供了java_package属性，你通常还是应该定义package属性以避免在ProtocolBuffers中命名冲突。包声明以后，有两个Java属性：java_package和java_outer_classname。java_package表示生成的Java代码的包，如果没有指定，编译器会根据package属性确定包名。java_outer_classname属性定义生成文件的类名。如果没有指定，会根据文件名进行转换，如："my_proto.proto"缺省会使用MyProto作为外部类名。

 接下来是定义message属性，一个message是包含了各种类型字段的聚集。有很多标准的变量类型可以使用，包括:bool,int32,float,double和string。你也可以使用其他的message作为字段类型。正像例子中的Person包含了PhoneNumber，而AddressBook包含了Persion。甚至可以在message内部定义message，例如：PhoneNumber就是在Persion里面定义的。你还可以定义enum类型，正像指定电话号码类型的MOBILE、HOME、WORK。

其中“＝1”，“＝2”表示每个元素的标识号，它会用在二进制编码中对域的标识。标识号1－15由于使用时会比那些高的标识号少一个字节，从最优化角度考虑，可以将其使用在一些较常用的或repeated元素上，对于16以上的则使用在不常用的或optional的元素上。对于repeated的每个元素都需要重复编码该标识号，所以repeated的域进行优化来说是最显示的。

每个字段必须提供一个修饰词：

Ø  required：表示字段必须提供，不能为空。否则message会被认为是未初始化的，试图build未初始化的message会抛出RuntimeException。解析未初始化的message会抛出IOException。除此之外，一个required字段与optional字段完全相同。

Ø  optional：可选字段，可以设置也可以不设置。如果没有设置，会设置一个缺省值。可以指定一个缺省值，正像电话号码的type字段。否则，使用系统的缺省值：数字类型缺省为0；字符类型缺省为空串；逻辑类型缺省为false；对于嵌入的message，缺省值通常是message的实例或原型。

Ø  repeated：字段可以被重复(包括0)，可等同于动态数组或列表。其中存储的值列表的顺序是被保留的。

Required修饰的字段是永久性的，在使用该修饰符时一定要特别小心。如果在以后想要修改required域为optional域时会出现问题。对于访问旧接口的用户来说没有该字段时，将会认为是不合法的访问，将会被拒绝或丢弃。其中google的一些工程师给出的建议是如果不是必须，就尽量少用required修饰符。

l  编译Protocol Buffers文件

既然现在已经有了.proto文件，接下来就需要利用编译器protoc对.proto文件进行编译，生成具体的java类。就可以读