ProtoBuf
5. proto3语法详解
5.5 oneof类型
如果消息中有很多可选字段,但是将来只会有一个字段被设置,那么就可以利用oneof类型加强这一行为,也能有节约内存的效果。
我们定义了一个名为 other_contact 的 oneof 字段,其中包含两个可选字段:qq 和 weixin。这两个字段只能有一个会被设置。
oneof other_contact
{
// 其他联系⽅式:多选⼀
string qq = 1;
string weixin = 2;
}
同时也要注意:
可选字段的编号不可与非可选字段编号相同,以防冲突。
oneof 中不能使用 repeated 字段。
未来设置 oneof 字段值时,若设置多个,仅保留最后一次设置的成员,之前设置的会自动清除。
我们向我们的通讯录中添加oneof类型作为一种联系方式选择:
syntax = "proto3";
package contacts;
import "google/protobuf/any.proto"; // 引⼊ any.proto ⽂件
// 地址
message Address
{
string home_address = 1; // 家庭地址
string unit_address = 2; // 单位地址
}
// 联系⼈
message PeopleInfo
{
string name = 1; // 姓名
int32 age = 2; // 年龄
message Phone
{
string number = 1; // 电话号码
enum PhoneType
{
MP = 0; // 移动电话
TEL = 1; // 固定电话
}
PhoneType type = 2; // 类型
}
repeated Phone phone = 3; // 电话
google.protobuf.Any data = 4;
oneof other_contact
{
// 其他联系⽅式:多选⼀
string qq = 5;
string weixin = 6;
}
}
// 通讯录
message Contacts
{
repeated PeopleInfo contacts = 1;
}
protoc编译文件:
protoc --cpp_out=. contacts.proto
查看contacts.pb.h文件,这就是自动生成的有关oneo的函数:
判断类:
_internal_has_qq
:判断是否设置了 qq 字段。
has_qq
:通过调用 _internal_has_qq 获取是否设置了 qq 字段的信息。
设置类:
set_has_qq
:设置 _oneof_case _ [0] 为 kQq 。
set_qq
:在未设置 qq 时进行清理和初始化操作,然后设置 qq 的值。
_internal_set_qq
:设置 qq 的值。
set_allocated_qq
:根据传入的 qq 指针进行相应的设置和清理操作。
清除类:
clear_qq
:在 _internal_has_qq 为真时,销毁 qq 字段并清除相关设置。
获取类:
qq
:获取 qq 字段的值。
mutable_qq
:获取可修改的 qq 字段。
_internal_qq
:在设置了 qq 时获取其值,否则返回空字符串。
_internal_mutable_qq
:在未设置 qq 时进行清理和初始化,然后返回可修改的 qq 字段。
release_qq
:在设置了 qq 时释放并清除相关设置,未设置时返回空指针。
更新 write.cc :
#include <iostream>
#include <fstream>
#include "contacts.pb.h"
using namespace std;
using namespace contacts;
/**
* 新增联系⼈
*/
void AddPeopleInfo(PeopleInfo *people_info_ptr)
{
cout << "-------------新增联系⼈-------------" << endl;
cout << "请输⼊联系⼈姓名: ";
string name;
getline(cin, name);
people_info_ptr->set_name(name);
cout << "请输⼊联系⼈年龄: ";
int age;
cin >> age;
people_info_ptr->set_age(age);
cin.ignore(256, '\n');
for (int i = 1;; i++)
{
cout << "请输⼊联系⼈电话" << i << "(只输⼊回⻋完成电话新增): ";
string number;
getline(cin, number);
if (number.empty())
{
break;
}
PeopleInfo_Phone *phone = people_info_ptr->add_phone();
phone->set_number(number);
cout << "选择此电话类型 (1、移动电话 2、固定电话) : ";
int type;
cin >> type;
cin.ignore(256, '\n');
switch (type)
{
case 1:
phone -> set_type(PeopleInfo_Phone_PhoneType::PeopleInfo_Phone_PhoneType_MP);
break;
case 2:
phone -> set_type(PeopleInfo_Phone_PhoneType::PeopleInfo_Phone_PhoneType_TEL);
break;
default:
cout << "⾮法选择,使⽤默认值!" << endl;
break;
}
}
Address address;
cout << "请输⼊联系⼈家庭地址: ";
string home_address;
getline(cin, home_address);
address.set_home_address(home_address);
cout << "请输⼊联系⼈单位地址: ";
string unit_address;
getline(cin, unit_address);
address.set_unit_address(unit_address);
google::protobuf::Any *data = people_info_ptr->mutable_data();
data->PackFrom(address);
cout << "选择添加⼀个其他联系⽅式 (1、qq号 2、微信号) : ";
int other_contact;
cin >> other_contact;
cin.ignore(256, '\n');
if (1 == other_contact)
{
cout << "请输⼊qq号: ";
string qq;
getline(cin, qq);
people_info_ptr->set_qq(qq);
}
else if