《protobuf入门》由会员分享，可在线阅读，更多相关《protobuf入门（16页珍藏版）》请在金锄头文库上搜索。
1、1. 前言这篇入门教程是基于Java语言的，这篇文章我们将会：1. 创建一个.proto文件，在其内定义一些PB message2. 使用PB编译器3. 使用PB Java API 读写数据这篇文章仅是入门手册，如果想深入学习及了解，可以参看：Protocol Buffer Language Guide,Java API Reference,Java Generated Code Guide, 以及Encoding Reference。2. 为什么使用Protocol Buffers接下来用“通讯簿”这样一个非常简单的应用来举例。该应用能够写入并读取“联系人”信息，每个联系人由name，ID，
2、email address以及contact photo number组成。这些信息的最终存储在文件中。如何序列化并检索这样的结构化数据呢？有以下解决方案：1. 使用Java序列化(Java Serialization)。这是最直接的解决方式，因为该方式是内置于Java语言的，但是，这种方式有许多问题(Effective Java 对此有详细介绍)，而且当有其他应用程序(比如C+ 程序及Python程序书写的应用)与之共享数据的时候，这种方式就不能工作了。2. 将数据项编码成一种特殊的字符串。例如将四个整数编码成“12:3:-23:67”。这种方法简单且灵活，但是却需要编写独立的，只需要用一次
3、的编码和解码代码，并且解析过程需要一些运行成本。这种方式对于简单的数据结构非常有效。3. 将数据序列化为XML。这种方式非常诱人，因为易于阅读(某种程度上)并且有不同语言的多种解析库。在需要与其他应用或者项目共享数据的时候，这是一种非常有效的方式。但是，XML是出了名的耗空间，在编码解码上会有很大的性能损耗。而且呢，操作XML DOM数非常的复杂，远不如操作类中的字段简单。Protocol Buffers可以灵活，高效且自动化的解决该问题，只需要：1. 创建一个.proto 文件，描述希望数据存储结构2. 使用PB compiler 创建一个类，该类可以高效的，以二进制方式自动编码和解析PB数
4、据该生成类提供组成PB数据字段的getter和setter方法，甚至考虑了如何高效的读写PB数据。更厉害的是，PB友好的支持字段拓展，拓展后的代码，依然能够正确的读取原来格式编码的数据。3. 定义协议格式首先需要创建一个.proto文件。非常简单，每一个需要序列化的数据结构，编码一个PB message，然后为message中的字段指明一个名字和类型即可。该“通讯簿”的.proto 文件addressbook.proto定义如下：package tutorial;option java_package = com.example.tutorial;option java_outer_class
5、name = 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 Addres
6、sBook repeated Person person = 1;可以看到，语法非常类似Java或者C+，接下来，我们一条一条来过一遍每句话的含义： .proto文件以一个package声明开始。该声明有助于避免不同项目建设的命名冲突。Java版的PB，在没有指明java_package的情况下，生成的类默认的package即为此package。这里我们生命的java_package，所以最终生成的类会位于com.example.tutorial package下。这里需要强调一下，即使指明了java_package，我们建议依旧定义.proto文件的package。 在package声明之后
7、，紧接着是专门为java指定的两个选项：java_package 以及 java_outer_classname。java_package我们已经说过，不再赘述。java_outer_classname为生成类的名字，该类包含了所有在.proto中定义的类。如果该选项不显式指明的话，会按照驼峰规则，将.proto文件的名字作为该类名。例如“addressbook.proto”将会是“Addressbook”，“address_book.proto”即为“AddressBook” java指定选项后边，即为message定义。每个message是一个包含了一系列指明了类型的字段的集合。这里的字段
8、类型包含大多数的标准简单数据类型，包括bool，int32，float，double以及string。Message中也可以定义嵌套的message，例如“Person” message 包含“PhoneNumber” message。也可以将已定义的message作为新的数据类型，例如上例中，PhoneNumber类型在Person内部定义，但他是phone的type。在需要一个字段包含预先定义的一个列表的时候，也可以定义枚举类型，例如“PhoneType”。 我们注意到， 每一个message中的字段，都有“=1”，“=2”这样的标记，这可不是初始化赋值，该值是message中，该字段的唯
9、一标示符，在二进制编码时候会用到。数字115的表示需求少于一个字节，所以在编码的时候，有这样一个优化，你可以用115标记最常使用或者重复字段元素(repeated elements)。用16或者更大的数字来标记不太常用的可选元素。再重复字段中，每一个元素都需重复编码标签数字，所以，该优化对重复字段最佳(repeat fileds)。message的没一个字段，都要用如下的三个修饰符(modifier)来声明：1. required：必须赋值，不能为空，否则该条message会被认为是“uninitialized”。build一个“uninitialized” message会抛出一个Runti
10、meException异常，解析一条“uninitialized” message会抛出一条IOException异常。除此之外，“required”字段跟“optional”字段并无差别。2. optional：字段可以赋值，也可以不赋值。假如没有赋值的话，会被赋上默认值。对于简单类型，默认值可以自己设定，例如上例的PhoneNumber中的PhoneType字段。如果没有自行设定，会被赋上一个系统默认值，数字类型会被赋为0，String类型会被赋为空字符串，bool类型会被赋为false。对于内置的message，默认值为该message的默认实例或者原型，即其内所有字段均为设置。当获取没
11、有显式设置值的optional字段的值时，就会返回该字段的默认值。3. repeated：该字段可以重复任意次数，包括0次。重复数据的顺序将会保存在protocol buffer中，将这个字段想象成一个可以自动设置size的数组就可以了。Notice：应该格外小心定义Required字段。当因为某原因要把Required字段改为Optional字段是，会有问题，老版本读取器会认为消息中没有该字段不完整，可能会拒绝或者丢弃该字段(Google文档是这么说的，但是我试了一下，将required的改为optional的，再用原来required时候的解析代码去读，如果字段赋值的话，并不会出错，但是如
12、果字段未赋值，会报这样错误：Exception in thread “main” com.google.protobuf.InvalidProtocolBufferException: Message missing required fields:fieldname)。在设计时，尽量将这种验证放在应用程序端的完成。Google的一些工程师对此也很困惑，他们觉得，required类型坏处大于好处，应该尽量仅适用optional或者repeated的。但也并不是所有的人都这么想。如果想深入学习.proto文件书写，可以参考Protocol Buffer Language Guide。但是不要妄想
13、会有类似于类继承这样的机制，Protocol Buffers不做这个4. 编译Protocol Buffers定义好.proto文件后，接下来，就是使用该文件，运行PB的编译器protoc，编译.proto文件，生成相关类，可以使用这些类读写“通讯簿”没得message。接下来我们要做：1. 如果你还没有安装PB编译器，到这里现在安装：download the package2. 安装后，运行protoc，结束后会发现在项目com.example.tutorial package下，生成了AddressBookProtos.java文件：protoc -I=$SRC_DIR -java_out
14、=$DST_DIR $SRC_DIR/addressbook.proto#for exampleprotoc -I=G:workspaceprotobufmessage -java_out=G:workspaceprotobufsrcmainjava G:workspaceprotobufmessagesaddressbook.proto -I：指明应用程序的源码位置，假如不赋值，则有当前路径(说实话，该处我是直译了，并不明白是什么意思。我做了尝试，该值不能为空，如果为空，则提示赋了一个空文件夹，如果是当前路径，请用.代替，我用.代替，又提示不对。但是可以是任何一个路径，都运行正确，只要不为空
15、)； java_out：指明目的路径，即生成代码输出路径。因为我们这里是基于java来说的，所以这里是java_out，相对其他语言，设置为相对语言即可 最后一个参数即.proto文件Notice：此处运行完毕后，查看生成的代码，很有可能会出现一些类没有定义等错误，例如：com.google cannot be resolved to a type等。这是因为项目中缺少protocol buffers的相应library。在Protocol Buffers的源码包里，你会发现java/src/main/java，将这下边的文件拷贝到你的项目，大概可以解决问题。我只能说大概，因为当时我在弄得时候，也是刚学，各种出错，比较恶心。有一个简单的方法，呵呵，对于懒汉来说。创建一个maven的java项目，在pom.xml中，添加Protocol Buffers的依赖即可解决所有问题在pom.xml中添加如下依赖(注意版本)：com.google.protobufprotobuf-java2.5.05.Protocol Buffer Java API5.1 产生的类及
