【总结】Protocol Buffer上手 & 常用接口 – C++

Posted on Posted in 计算机2,333 views

    项目中需要接收protobuf格式的数据包,所以参考文章学习了下protobuf的基本使用,自己利用protobuf完成了解包和组包的程序,以下介绍下protobuf基本入门和接口。

1.简介

  Protocol Buffers是Google出品并开源的语言和平台均中立的数据序列化和反序列化工具,官方支持C++/Java和Python三大语言,另外有大量的第三方实现支持PHP、D语言和C#等众多语言,这些都可以从Google Protocol Buffers的官方网站上找到链接。

2.安装Protocol Buffers工具

  从http://code.google.com/p/protobuf/downloads/list上下载protobuf安装包,使用的是automake安装方式。安装成功后,将它的bin和lib目录分别加入到PATH和LD_LIBRARY_PATH环境变量,以方便直接调用。

./configure --prefix=my/protobuf-2.4.1 CFLAGS=-fPIC CXXFLAGS=-fPIC --with-pic=PIC

3.编写接口文件

  Protocol Buffers的接口文件以.proto为文件名的后缀,作用和语法都类似于Corba和MS COM的IDL,如果有这方面的基础,理解和使用起来会容易许多。x.proto文件的内容如下:

package x;
  message Person {
  required string name = 1;
  required int32 id = 2;
  optional string email = 3;
  }

4.编译接口文件

  调用protoc编译器进行编译:

protoc x.proto --cpp_out=./oo

  请注意需要指出输出文件,C++语言使用–cpp_out指出,其它语言可以查看帮助protoc –help,输出目录oo是必须事先创建好的,否则会报输出目录下存在。

  编译成功后,将在oo目录下生成供应用调用的文件x.pb.h和x.pb.cc,编译自己代码的时候应当将x.pb.cc包含进去。

5.编写测试程序

  测试程序x.cpp的内容如下:

  

#include “oo/x.pb.h”
int main()
{
  using namespace x;
  Person p;
  p.set_name(”tom”);
  p.set_id(88);
  p.set_email(”xx@xx.com”);
  std::string str;
  p.SerializeToString(&str); // 将对象序列化到字符串,除此外还可以序列化到fstream等
  printf(”%s\n”, str.c_str());
  Person x;
  x.ParseFromString(str); // 从字符串反序列化
  printf(”x.name=%s\n”, x.name().c_str()); // 这里的输出将是tom,说明反序列化正确
  return 0;
}

6.编译测试程序

g++ -g -o x x.cpp ./oo/x.pb.cc -I. -I/usr/local/protobuf/include -L/usr/local/protobuf/lib -lprotobuf -pthread

7.运行测试程序

./x
tomX  xx at xx.com

8、实用接口

    A、访问属性

object.xxx    // xxx 为 .proto 文件结构中定义的属性名

    B、属性赋值

object.set_xxx    // xxx 为 .proto 文件结构中定义的属性名

    C、属性嵌套,实例化

* obj1 = obj2.mutable_syscall_hangup_reqbody();    // obj1 为 obj2的成员
obj1->set_xxx

    D、判断是否实例化

object.IsInitialized();

    E、获取结构

# 反序列化后直接返回,不过要注意判断

    F、判断成员结构是否存在

obj2.has_obj1();            // obj1根据.proto 文件中定义来

    G、结构序列化后的大小

object.ByteSize()    // eg. uint32_t head_size = head.ByteSize();

    H、序列化&反序列化

object.SerializeToArray(buf,size)    //head.SerializeToArray(buffer_tmp_char_ptr, head_size); 
objecy.ParseFromArray(buf,size)      //head_.ParseFromArray(data_tmp_char_ptr, head_length_) ? 0
// 还有其他序列化反序列化函数,此处只以项目中使用到的举例

9、参考

 http://xcd.blog.techweb.com.cn/archives/173.html


转载标明出处:https://blog.evanxia.com/2016/06/692