[C++知识库] protobuf c++编程笔记

开发: C++知识库 Java知识库 JavaScript Python PHP知识库人工智能区块链大数据移动开发嵌入式开发工具数据结构与算法开发测试游戏开发网络协议系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑笔记本显卡显示器固态硬盘硬盘耳机手机 iphone vivo oppo 小米华为单反装机图拉丁

-> C++知识库 -> protobuf c++编程笔记 -> 正文阅读

[C++知识库]protobuf c++编程笔记

文章目录

字段内容的定义

//文件名：addressbook.proto

syntax = "proto2";//proto版本
//.proto文件新增一个可选的package声明符，用来防止不同的消息类型有命名冲突。
//包的声明符会根据使用语言的不同影响生成的代码。对于C++，产生的类会被包装在C++的命名空间中。
package tutorial;package声明符

message Person {
  required string name = 1;//姓名，= 1 二进制编码中使用的唯一 “标记”
  required int32 id = 2;//ID
  optional string email = 3;//email

  enum PhoneType {//枚举消息类型
    MOBILE = 0;//proto3版本中，首成员必须为0，成员不应有相同的值
    HOME = 1;
    WORK = 2;
  }
//
  message PhoneNumber {
    required string number = 1;
    optional PhoneType type = 2 [default = HOME];
  }

  repeated PhoneNumber phones = 4;//phones为数组
}

message AddressBook {
  repeated Person people = 1;
}

修饰符

required 必须提供该字段的值，否则消息会被认为是”未初始化的“
optional
表示属性值为可选项，不指定使用默认值。int和char数据类型默认为0，string默认为空，bool默认为false,嵌套message默认为构造，枚举为第一个
repeated 表示该属性为重复字段，可看走是动态数组，类似于c++中的vector

如果为optional属性，发送端没有包含该属性，则接收端在解析式采用默认值。对于默认值，如果已设置默认值，则采用默认值，如果未设置，则类型特定的默认值为使用，例如string的默认值为”“。

字段类型

package
相当于namespace
message
相当于clas
name
相当于属性值

引用方式

类成员函数变量
package::message.方法()
标准meaasge方法
1.bool IsInitialized() const;: 检查是否已设置所有必填 required 字段
2.string DebugString() const;: 返回 message 的人类可读表达，对调试特别有用
3.void CopyFrom(const Person& from);用给定的 message 的值覆盖 message
4.void Clear();: 将所有元素清除回 empty 状态

不同字段的方法

1)optional修饰的基本类型：

set_属性名(val) ：初始化修改属性值；
属性名()：获取属性值，只读模式，返回类型是::google::protobuf::int64；

2）optional修饰的对象类型：

属性名()：返回只读的属性类型对象的引用，属性类型是指pb中定义的对象；
mutable_属性名()：返回可修改的属性类型对象的指针，属性类型是指pb中定义的对象；
set_属性名():初始化设置字段值

3）repeated修饰的基本类型：

add_属性名(val)：向属性集合中添加元素；
属性名_size()：获取集合大小；
属性名(i)：返回集合中某一个元素，返回类型::google::protobuf::int64；
属性名()：返回只读的整个集合的引用，返回的集合类型是const ::google::protobuf::RepeatedField< ::google::protobuf::int64 >&，可以使用iterator来迭代遍历，可用于修改；
mutable_属性()：返回可修改的整个集合的指针，返回的集合类型是::google::protobuf::RepeatedField< ::google::protobuf::int64 >*，可以使用iterator来迭代遍历，可用于修改；
set_属性名(int,x):设置repeated中元素的值

4）repeated修饰的对象类型：

add_属性名()：返回可修改的属性类型对象的指针（集合中的一个元素），属性类型是指pb中定义的对象；
属性名_size()：获取集合大小；
属性名(i)：返回集合中某一个元素，返回的是只读的属性类型对象的引用，属性类型是指pb中定义的对象；
mutable_属性名(i)：返回集合中某一个元素，返回的是可修改的属性类型对象的指针，属性类型是指pb中定义的对象；
属性名()：返回只读的整个集合的引用，集合类型是const ::google::protobuf::RepeatedPtrField< pb定义的对象>& XXX const;，可以使用iterator来迭代遍历；
mutable_属性名()：返回可修改的整个集合的指针，集合类型是::google::protobuf::RepeatedPtrField< pb定义的对象>*，可以使用iterator来迭代遍历；