其他分享
首页 > 其他分享> > protobuf

protobuf

作者:互联网

protobuf 简介

protobuf (protocol buffer) 是谷歌内部的混合语言数据标准。通过将结构化的数据进行序列化(串行化),用于通讯协议、数据存储等领域的语言无关、平台无关、可扩展的序列化结构数据格式。

序列化:将数据结构或对象转换成二进制串的过程。反序列化:将在序列化过程中所产生的二进制串转换成数据结构或对象的过程。

message 介绍

messageprotobuf中定义一个消息类型是通过关键字message字段指定的,这个关键字类似于C++/Java中的class关键字。使用protobuf编译器将proto编译成C++代码之后,每个message都会生成一个名字与之对应的C++类,该类公开继承自google::protobuf::Message

message 消息定义

创建tutorial.person.proto文件,文件内容如下:

// FileName: tutorial.person.proto 
// 通常文件名建议命名格式为 包名.消息名.proto 

// 表示正在使用proto2命令
syntax = "proto2"; 

//包声明,tutorial 也可以声明为二级类型。
//例如a.b,表示a类别下b子类别
package tutorial; 

//编译器将生成一个名为person的类
//类的字段信息包括姓名name,编号id,邮箱email,
//以及电话号码phones
message Person { 
  required string name = 1;  // (位置1)
  required int32 id = 2;  
  optional string email = 3;  // (位置2)

  enum PhoneType {  //电话类型枚举值 
    MOBILE = 0;  //手机号  
    HOME = 1;    //家庭联系电话
    WORK = 2;    //工作联系电话
  } 
  
  //电话号码phone消息体
  //组成包括号码number、电话类型 type
  message PhoneNumber {
    required string number = 1;    
    optional PhoneType type = 2 [default = HOME]; // (位置3)
  }  
  
  repeated PhoneNumber phones = 4; // (位置4)
} 


// 通讯录消息体,包括一个Person类的people
message AddressBook { 
  repeated Person people = 1; 
}

包声明

proto 文件以package声明开头,这有助于防止不同项目之间命名冲突。在C++中,以package声明的文件内容生成的类将放在与包名匹配的namespace中,上面的.proto文件中所有的声明都属于tutorial

字段规则

许多标准的简单数据类型都可以用作message字段类型,包括bool,int32,float,doublestring。还可以使用其他message类型作为字段类型在消息体中添加更多结构。在上面的示例中,Person包含PhoneNumber message, 而AddressBook包含Person message。甚至可以定义嵌套在其他message中的message类型。例如,上面的PhoneNumber定义在Person

函数方法

message关键字声明的的消息体,允许你检查、操作、读、或写整个消息,包括解析二进制字符串,以及序列化二进制字符串。除此之外,也定义了下列方法:

Person:缺省的构造函数。

~Person():缺省的析构函数。

Person(const Person& other):拷贝构造函数。

Person& operator=(const Person& other):
赋值 (Assignment )操作符。

const UnknownFieldSet& unknown_fields() const:
返回当解析信息时遇到的未知字段的集合。

UnknownFieldSet* mutable_unknown_fields():
返回当前解析信息时遇到的未知字段的集合的一个mutale指针。

编译proto文件

可以执行以下protoc命令对.proto文件进行编译,生成对应的c文件。Linux系统通过 help protoc 查看protoc命令的使用详解。

protoc -I=$SRC_DIR 
--cpp_out=$DST_DIR  xxx.proto
  • $SRC_DIR:proto 所在的源目录
  • --cpp_out 生成C++代码
  • $DST_DIR 生成代码的目标目录
  • xxx.proto:要针对哪个proto文件生成接口,例如 tutorial.person.proto

编译完成后,将生成2个文件 tutorial.pb.htutorial.pb.c 其中tutorial表示包名,pb是protobuf的缩写。

此外,protocol buffer 编译器为.proto文件中定义的消息的每个字段生成一套存取器方法

对于 message Person 中的 required int32 id = 2,编译器将生成下列存取器方法:

bool has_id() const: 用于判断字段id是否存在。如果字段被设置,返回true。

int32 id() const: 返回字段id的当前值,如果字段没有被设置,返回缺省值。

void set_id(int32 value) : 设置字段id的值。调用此方法后,has_id() 将返回true以及id() 将返回value

void clear_id():清除字段的值。调用此方法后,has_id()将返回false 以及id()将返回缺省值。

当然,对于其他类型的字段,编译器也会生成不同的存取方法,这里就不一一列举了。

使用message

//获取person实例:

tutorial::AddressBook addressBook;
Person *person = addressBook.add_people(); 

//写入一个message:

person->set_id(id);
getline(cin,*person->mutable_name());

//读取一个message: 

person.id();
person.name();
person.email(); 

protobuf的优点

性能方面

使用方面

使用范围

原文链接:https://juejin.cn/post/7029961388411846664

标签:protobuf,proto,Person,person,message,序列化,id
来源: https://www.cnblogs.com/sqdtss/p/16374843.html