protocol buffer 是 google 的一种数据交换的格式,它独立于语言,独立于平台。google 提供了三种语言的实现:java、c++ 和 python,每一种实现都包含了相应语言的编译器以及库文件。因为它是一种二进制的格式,比使用 xml 进行数据交换快许多。能够把它用于分布式应用之间的数据通讯或者异构环境下的数据交换。本文经过一个简单的示例介绍 protocol buffer。
在开始以前须要下载 protocol buffer 的编译器和相应类库。下载地址为:http://code.google.com/p/protobuf/downloads/list 。当前版本为 2.3.0,下载一下两个压缩包:protoc-2.3.0-win32.zip 和 protobuf-2.3.0.zip,前者是 protocol buffer 编译器,后者包含了三种语言的开发包。
首先解压 protoc-2.3.0-win32.zip,把 protoc.exe 文件放到 path 路径中,最简单的就是把这个文件复制到 c:\windows 目录中。
解压 protobuf-2.3.0.zip 文件,假设解压后的目录为 proto_home。因为此开发包中只包含了源文件,没有包含打包后的 jar 文件,因此须要本身手动编译。下面一步一步来编译 protocol buffer 的 java 实现,因为 protocol buffer 使用 maven 做为编译工具,因此必须先下载安装 maven,maven 能够从 http://maven.apache.org 上下载。安装 maven 很是简单,只要解压并把 bin 目录添加到 path 中便可。安装好 maven 后,测试一下 maven 是否安装成功,打开命令行窗口,运行命令 mvn -version,当看到一下输出后,说明 maven 安装成功。
在编译以前还需把 protocol buffer 的编译器复制一份到把 protocol buffer 的编译器复制一份到目录 proto_home\src\ 中,因为在 maven 脚本中调用了这个文件。下面在命令行窗口中把当前工做目录定位到proto_home\java 中,运行命令 mvn package。编译完成后会在 taget 目录中生成一个 jar 文件 protobuf-java-2.3.0.jar。
protocol buffer 的编译器和基于 java 的类库已经准备好了,下面能够使用 protocol buffer 写一个简单的示例。本文中就直接使用 protocol buffer 自己自带的一些示例,这个示例在 proto_home\examples 目录中。这个示例会用到这个目录中的 addressbook.proto、AddPerson.java 和 ListPerson.java 文件。下面一步一步来运行这些示例。
首先把前面编译生成的 protobuf-java-2.3.0.jar 复制到 proto_home\examples 目录中,便于引用。
使用 protocol buffer 编译器编译 addressbook.proto 文件。打开命令行窗口,并定位到 proto_home\examples 目录中,运行命令 protoc --java_out=. addressbook.proto,执行这个命令后会在当前目录下生成一个java类 com.example.tutorial.AddressBookProtos.java。
生成了 java 类以后就是编译并运行这个示例,在命令行中执行命令 javac -d . -classpath .;protobuf-java-2.3.0.jar AddPerson.java ListPeople.java com\example\tutorial\AddressBookProtos.java。
下面运行 AddPerson,在命令中执行命令 java -cp .;protobuf-java-2.3.0.jar AddPerson addr.dat,按照提示输入相应的信息,以下图所示
运行这个程序会在当前目录中建立一个数据文件 addr.dat 保存 protocol buffer 生成的数据。运行程序 ListPeople 则能够读取 addr.dat 文件中的数据。
java -cp .;protobuf-java-2.3.0.jar ListPeople addr.dat