Protocol Buffers(protobuf)是Google提供的一个开源序列化框架,类似XML,JSON,其最大的特点是基于二进制,比传统的XML表示同样一段内容要短小得多。虽然是二进制数据格式,但并没有因此变得复杂,开发人员通过按照一定的语法定义结构化的消息格式,然后送给命令行工具,工具将自动生成相关的类,可以支持c++、java、python等语言环境。通过将这些类包含在项目中,可以很轻松的调用相关方法来完成业务消息的序列化与反序列化工作。
下面将说明如何在windows下VC++使用protobuf
一、前期准备
1、下载protobuf源代码,有两种方式选择:
http://code.google.com/p/protobuf/downloads/list
二、编译protobuf
1、进入vsprojects目录,执行extract_includes.bat 提取项目头文件 (双击即可)
这时候当前目录会生成include目录
2、打开项目文件protobuf.sln,编译libprotobuf 和 libprotoc 和 libprotobuf-lite 和protoc(分别在解决方案资源管理其中,右击->重新生成)
这时候编译目录会生成libprotobuf.lib libprotov.lib libprotobuf-lite.lib 和 protoc.exe
注意了,debug编译后的文件用于debug项目,release编译后的文件用于release项目,否则会出错。
三、在项目中使用protobuf
1.将protoc.exe添加到windows的PATH变量中,(方便的也可直接放到C:\windows目录下)
在E盘下创建工程protobufTest E:\protobufTest
书写 .proto 文件
首先我们需要编写一个 proto 文件,定义我们程序中需要处理的结构化数据,在 protobuf 的术语中,结构化数据被称为 Message。proto 文件非常类似 java 或者 C 语言的数据定义。代码清单 1 显示了例子应用中的 proto 文件内容。
清单 1. proto 文件
package lm; message helloworld { required int32 id = 1; // ID required string str = 2; // str optional int32 opt = 3; //optional field }
一个比较好的习惯是认真对待 proto 文件的文件名。比如将命名规则定于如下:
lm.helloworld.proto
编译 .proto 文件(在vs2010命令行工具中)
写好 proto 文件之后就可以用 Protobuf 编译器将该文件编译成目标语言了。本例中我们将使用 C++。
通过命令行进入目录C:\Windows
执行以下命令
protoc -I=E:\protobufTest --cpp_out=E:\protobufTest E:\protobufTest\lm.helloworld.proto
命令将生成两个文件:
lm.helloworld.pb.h , 定义了 C++ 类的头文件
lm.helloworld.pb.cc , C++ 类的实现文件
上面两个文件就是通过google protobuffer编译器产生你想要的protocol结构
2.配置protobuf的头文件目录和库的目录,添加相应的库
3.编译完成。