通信协议之Protocol buffer(Java篇)

之前一直习惯用json进行数据的传输，觉得很方便。来到新公司后发现同事们用的更多的的协议都不是json，而是Protocol buffer。这个东西之前没有听说过，不明白同事们为什么放弃好好的json不用，用这个。后来了解到经常是设备与设备之间进行通信，而不是设备与服务器做通信。很多设备是linux下c语言做核心服务，c来解析json比较麻烦。于是决定花些时间来学习这个陌生的协议。

简介

Protocol Buffers(也称protobuf)是Google公司出口的一种独立于开发语言，独立于平台的可扩展的结构化数据序列机制。通俗点来讲它跟xml和json是一类。是一种数据交互格式协议。

网上有很多它的介绍，主要优点是它是基于二进制的，所以比起结构化的xml协议来说，它的体积很少，数据在传输过程中会更快。另外它也支持c++、java、python、php、javascript等主流开发语言。

更多信息，你可以在这个它的官方网站查阅相关的资料

Protocol编译安装

protocol的编译器是C语言编写的，如果你正在使用c++开发，请根据c++安装引导进行安装。

对于不是c++语言的开发者而言，最简单的方式就是从下面的网站下载一个预编译的二进制文件。
https://github.com/google/protobuf/releases

在上面的链接中，你可以按照对应的平台下载zip包：protoc-$VERSION-$PLATFORM.zip. 如protobuf-java-3.1.0.zip

如果你要寻找之前的版本，通过下面的maven库：
http://repo1.maven.org/maven2/com/google/protobuf/protoc/

因为我主要用java开发应用，所以这篇文章重点讲解protocol的java实现。 还有这是在windows上操作。

Protocol buffer的安装

1 通过Maven方式安装

如果你机器上还没有安装maven.请到下面的网站安装
http://maven.apache.org/
选择相应的包。我这里选择的是apache-maven-3.3.9-bin.zip.

添加maven到path

将下载后的bin目录添加到path中。

然后用mvn -version测试一下

C:\Users\xx-xxx>mvn -version
Apache Maven 3.3.9 (bb52d8502b132ec0a5a3f4c09453c07478323dc5; 2015-11-11T00:41:4
7+08:00)
Maven home: E:\xxxxxx\apache-maven-3.3.9-bin\apache-maven-3.3.9\bin\..

Java version: 1.7.0_09, vendor: Oracle Corporation
Java home: C:\Program Files\Java\jdk1.7.0_09\jre
Default locale: zh_CN, platform encoding: GBK
OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

说明安装成功

安装protoc

从https://github.com/google/protobuf/releases下载protoc，如protoc-3.1.0-win32.zip，然后解压然后添加到path.
在命令行中测试

protoc --version

正常情况应该打印版本信息，说明添加成功。

将protoc复制到protocol buffer解压的目录。

这一步很重要。
例如之前下载的protobuf-java-3.1.0.zip我将它解压在E盘
E:\xxxx\protobuf-java-3.1.0,那么E:\xxxx\protobuf-java-3.1.0\protobuf-3.1.0这个目录就当它是根目录。我用$ROOT表示。

将protoc.exe文件复制到$ROOT/src/目录下。

然后在命令行中定位到$ROOT/java/，
然后运行命令mvn package,
如果一切成功的话，就会在$ROOT/java/core/target/目录下生成protobuf-java-3.1.0.jar文件。

编译代码

在下载的protobuf-java-3.1.0.zip解压后，我们定义它的根目录为$ROOT。它下面有一个examples文件夹，里面有个adressbook.proto文件，.proto就是protocol buffer的文件格式后缀。
我们将之前生成的protobuf-java-3.1.0.jar复制到该目录下。然后执行下面的命令

protoc --java_out=. addressbook.proto

它就会自动生成com/example/tutorial/AddressBookProtos.java文件。

自此，protoc buffer就完全编译成功，并且能正常运行了。

接下来我讲解它的基本语法

语法

在Android开发中，json运用的很广泛，gson类可以直接将一个java类对象直接序列成json格式的字符串。
在protocol buffer中同样有类似功能的结构。
比如我要定义一个学生类，它包含学号、姓名、性别必要信息，也有兴趣爱好、特长等必要信息。
如果用java的话。大概如下面

class Student{
    int number;
    String name;
    int sex;
    String hobby;
    String skill;
}

那么如果用Protocol buffer来定义呢？

这里有一个关键字message。message是消息的意思，等同于java中的class关键字和c中的struct，代表一段数据的封装。

简单示例

首先我们得创建.proto文件。这里为Student.proto

syntax = "proto3";

message Student
{
    int32 number = 1;
    string name = 2;
    int32 sex = 3;
    string hobby = 4;
    string skill = 5;
}

syntax=”proto3”表示运用proto3的语法。而网上的教程大多还是proto2。
proto3提示required限制符不能起作用，默认的就是optional，表示任何域都是可选的。

那好，我们参加教程前面部分将.proto文件转换成.java文件。

protoc --java_out=.  Student.proto

结果在当前目录生成了StudentOuterClass.java文件。至于为什么是StudentOuterClass.java这是因为我们在Student.proto没有指定它编译后生成的文件名称，protoc程序默认生成了StudentOuterClass.java，其实这个名字我们可以自定义，文章后面的内容我会介绍。

序列化

在IDE中新建项目，然后添加StudentOuterClass.java文件，并且添加protobuf-java-3.1.0.jar。

然后编写如下代码：

Student.Builder buidler = Student.newBuilder();
        buidler.setName("Frank");
        buidler.setNumber(123456);
        buidler.setHobby("music");
        Student student = buidler.build();