【C++】protobuf的简单使用（通讯录例子）

于 2024-08-10 20:56:04 发布
阅读量378 收藏 9
点赞数 12
分类专栏： 网络编程 文章标签： c++ java android 开发语言 服务器 linux
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/tang20030306/article/details/141093438
版权

protobuf的简单使用（通讯录例子）

.proto文件的编写

  • syntax用于指定protobuf的语法；
  • package当.proto文件编译后再*.pb.h文件中会形成一个命名空间。
  • message+消息名称：当.proto文件编译后再*.pb.h文件中会形成一个类。

保留字段

  • 可以看到每一个属性后面会有一个数字编号，可以看成属性的唯一标识，用来在消息的二进制格式中标识属性，同一个message域里面不可以使用冲突。定义了就不能修改了，若是想删除，就要将编号添加进reserved保留字段，并且该字段不可继续使用。例如：
message PeopleInfo{
	//可以单个指定保留字段，也可指定一个范围的保留字段：
	// 13 to 20 包含13和20。
    reserved 10, 11, 13 to 20;
    // 也可指明字段名
    reserved "gender";

    string field1 = 10;
    string field2 = 11;
    string field3 = 15;
    string gender = 9;

    string name = 1;
    uint32 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 wechat = 6;
    }

    map<string, string> remark = 7;
}

  如上可以看到，定义了保留字段，编译后如下：
在这里插入图片描述
  表示保留字段不可继续使用。

字段唯一编号

  另外，字段唯一编号范围为：1 ~ 536870911（2^29-1)，其中19000 ~ 19999不可用。如果使用了就会告警。
  指定字段唯一编号时，对于使用频繁的字段，将其唯一编号设置为1 ~ 15， 因为1 ~ 15的字段编号只需要一个字节进行编码，16~2047以内的需要2个字节。

protobuf的类型

  .proto Type字段是.proto文件中的字段类型， C++ Type是.proto文件编译后形成的*.pb.h和 *.pb.c文件中的c++对应类型。
在这里插入图片描述
在这里插入图片描述

enum类型

  • enum类型可以定义在消息体内，也可以定义在消息体外。
  • 枚举的常量值在32整数范围内。
  • 0值常量必须存在，且要作为第一个元素。
    在这里插入图片描述
    在这里插入图片描述
  • 同级，也就是同一个作用域中，各个枚举类型中不能定义相同枚举名称：
    在这里插入图片描述

Any类型

   any类型可以理解为泛型类型，可以在any中存储任意数据类型，any类型也可以用repeated修饰。
   在安装protobuf时，include目录下包含了google定义好的.proto文件，在使用any类型时，需要引入any文件，使用import即可。如：
     import "google/protobuf/any.proto";
   定义any类型时，只需使用google.protobuf.Any 当做类型名来定义即可，具体的任意类型和any类型的绑定不在.proto文件中编码。
   例如：
   .proto文件中希望将Address类型转换成any类型：

message Address{
   string home_address = 1;
   string unit_address = 2;
}
message PeopleInfo{
	google.protobuf.Any data = 4;
}

  上面的代码为部分截取。
  在进行序列化的.cc文件中可以这样编写：

Address address;
cout << "请输入家庭地址：";
string home_address;
getline(cin, home_address);
cout << "请输入单位地址：";
string unit_address;
getline(cin, unit_address);

address.set_home_address(home_address);
address.set_unit_address(unit_address);

// 使用mutable_方法会开辟空间，并且返回一个any指针
// people_info_ptr是PeopleInfo的指针.
google::protobuf::Any *data = people_info_ptr->mutable_data();
PackFrom可以将任意类型转换为any类型。
data->PackFrom(address);
  • 使⽤ PackFrom() ⽅法可以将任意消息类型转为 Any 类型。
  • 使⽤ UnpackTo() ⽅法可以将 Any 类型转回之前设置的任意消息类型
  • 使⽤ Is() ⽅法可以⽤来判断存放的消息类型是否为 typename T。

oneof类型

  顾名思义，就是在众多类型中选择一个类型进行使用。
例如：

oneof other_contact{
        string qq = 5;
        string wechat = 6;
    }
  • oneof中类型的唯一编号，不能和other_contact所在的作用域的编号起冲突，要有唯一性。
  • oneof中不能使用repeated。
  • 在设置oneof中的值的时候，如果多次进行设置值，那么只会保留最后一次设置的值。
  • 获取当前设置了哪一个字段：使用_case方法。

  由于多次进行设置值，那么只会保留最后一次设置的值。这一特性，那么我们在设置oneof值的时候：

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(2 == other_contact)
    {
        cout << "请输入微信号：" ;
        string wechat;
        getline(cin, wechat);

        people_info_ptr->set_wechat(wechat);
    }
    else{
        cout << "非法选择，该选项设置失败。" << endl;
    }

  当我们在读取的时候：

switch(people.other_contact_case())
        {
            case PeopleInfo::OtherContactCase::kQq:
                cout << "qq号：" << people.qq() <<endl;
                break;
            case PeopleInfo::OtherContactCase::kWechat:
                cout << "微信号：" << people.wechat() << endl;
                break;
        }

map类型

 map<key_type, value_type> map_field = N;
  跟c++的map差不多，用于key_type和value_type的关系映射。

  • key_type是除了float和bytes类型以外的任意标量类型。value_type可以是任意类型。
  • map不可以用repeated修饰。
  • map存入的元素是无序的。
//write:
for(int i = 1; ; i++)
    {
        cout << "请输入备注" << i << "标题（只输入回车完成备注新增）: ";
        string remark_key;
        getline(cin, remark_key);
        if(remark_key.empty()) break;

        cout << "请输入备注" << i << "内容：";
        string remark_value;
        getline(cin, remark_value);
        people_info_ptr->mutable_remark()->insert({remark_key, remark_value});
    }

// read:
if(people.remark_size())
        {
            cout << "备注信息：" << endl;
        }
        for(auto it = people.remark().cbegin(); it != people.remark().cend(); ++it)
        {
            cout << "      " << it->first << ": " << it->second << endl;
        }

完整通讯录代码

.proto文件

syntax = "proto3";
package contacts;
import "google/protobuf/any.proto";

message Address{
    string home_address = 1;
    string unit_address = 2;
}

message PeopleInfo{
    string name = 1;
    uint32 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 wechat = 6;
    }

    map<string, string> remark = 7;
}


message Contacts{
    repeated PeopleInfo contacts = 1;
}

write文件

#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(2 == other_contact)
    {
        cout << "请输入微信号：" ;
        string wechat;
        getline(cin, wechat);

        people_info_ptr->set_wechat(wechat);
    }
    else{
        cout << "非法选择，该选项设置失败。" << endl;
    }


    for(int i = 1; ; i++)
    {
        cout << "请输入备注" << i << "标题（只输入回车完成备注新增）: ";
        string remark_key;
        getline(cin, remark_key);
        if(remark_key.empty()) break;

        cout << "请输入备注" << i << "内容：";
        string remark_value;
        getline(cin, remark_value);
        people_info_ptr->mutable_remark()->insert({remark_key, remark_value});
    }
    cout << "---------------添加联系人成功----------------" << endl;

}
int main()
{
    Contacts contacts;
    fstream input("./contacts.bin", ios::in | ios::binary);
    if(!input)
    {
        cerr << "contacts.bin file no found" << endl;
        return -1;
    }
    else if(!contacts.ParseFromIstream(&input))
    {
        cerr << "Failed to parse contacts" << endl;
        return -1;
    }

    AddPeopleInfo(contacts.add_contacts());

    fstream output("./contacts.bin", ios::out | ios::trunc | ios::binary);
    if(!contacts.SerializeToOstream(&output))
    {
        cerr << "Failed to write contacts." << endl;
        input.close();
        output.close();
        return -1;
    }

    input.close();
    output.close();
    return 0;
}

read文件

#include <iostream>
#include <fstream>
#include "contacts.pb.h"

using namespace std;
using namespace contacts;

void PrintContacts(const Contacts &contacts)
{
    for(int i = 0; i < contacts.contacts_size(); i++)
    {
        const PeopleInfo &people = contacts.contacts(i);

        cout << "-----------------联系人" << i+1 << "---------------------" << endl;
        cout << "姓名：" << people.name() << endl;
        cout << "年龄：" << people.age() << endl;
        int j = 0; 
        for(const PeopleInfo_Phone &phone : people.phone())
        {
            cout << "电话：" << j++ << phone.number() ;
            cout << "  (" << phone.PhoneType_Name(phone.type()) << ")" << endl;
        }
        if(people.has_data() && people.data().Is<Address>())
        {
            Address address;
            people.data().UnpackTo(&address);
            if(!address.home_address().empty())
            {
                cout << "家庭住址：" << address.home_address() << endl;
            }
            if(!address.unit_address().empty())
            {
                cout << "单位地址：" << address.unit_address() << endl;
            }
        }

        switch(people.other_contact_case())
        {
            case PeopleInfo::OtherContactCase::kQq:
                cout << "qq号：" << people.qq() <<endl;
                break;
            case PeopleInfo::OtherContactCase::kWechat:
                cout << "微信号：" << people.wechat() << endl;
                break;
        }

        if(people.remark_size())
        {
            cout << "备注信息：" << endl;
        }
        for(auto it = people.remark().cbegin(); it != people.remark().cend(); ++it)
        {
            cout << "      " << it->first << ": " << it->second << endl;
        }
    }
}
int main()
{
    Contacts contacts;
    fstream input("contacts.bin", ios::in | ios::binary);
    if(!contacts.ParseFromIstream(&input))
    {
        cerr << "Failed to parse contacts." << endl;
        return -1;
    }

    PrintContacts(contacts);

    input.close();
    google::protobuf::ShutdownProtobufLibrary();
    return 0;
}

运行结果

 ./write
在这里插入图片描述

 ./read
在这里插入图片描述
在这里插入图片描述

       新人创作不易，你的点赞和关注都是对我莫大的鼓励，再次感谢您的观看。

112233123hd
关注
  • 12
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
C++使用protobuf 作为网络消息协议
03-25
标题中的"C++使用protobuf作为网络消息协议"指出，我们将探讨如何在C++编程环境中利用Protocol Buffers（protobuf）这一高效的数据序列化工具来构建网络通信的消息协议。protobuf是由Google开发的一种语言中立、平台...
C++protobuf
05-14
在C++中，protobuf库提供了简单易用的API来进行这两个操作： ```cpp Person person; person.set_name("John Doe"); person.set_id(1234); person.set_email("john.doe@example.com"); std::string serialized_...
C/C++--ProtoBuf使用
weixin_66828150的博客
01-12 2073
对于使用了枚举类型的字段，包含设置和获取字段的方法，已经清空字段的方法clear_;以上三种序列化的方法没有本质区别，只是序列化之后输出的格式不同，可以提供不同场景使用，序列化的 API 函数均为const成员函数，因为序列化不会改变类对象的内容， 而是将序列化的结果保存到函数入参指定的地址中。上述的例子中，每个字段都有设置和获取的方法，getter 的名称与小写字段完全相同，setter 方法以 set_ 开头，每个字段都有一个clear_的方法，可以将字段设置为empty状态。编译该项目会出现异常。
ProtoBuf的学习和使用(C++)
南猿北者博客
11-13 3886
在单个.proto文件中可以定义多个message，同时proto3语法也支持嵌套1定义message，并且不限制嵌套深度;单个.proto文件中可以定义多个message支持嵌套定义message;只要保证同级字段之间不同名不同编号即可;导入其它.proto文件，语法引入的文件声明了package，使用其类型时需要用[命名空间消息类型]的格式;xxx();//获取字段(const 对象)set_xxx();//设置字段//清除字段。
ProtoBuf 语法（二）
qq_61635026的博客
05-30 940
系列文章。
protobuf 入门
Nick_Di的博客
04-10 2460
介绍了protobuf基本概念、优缺点、与protobuf在C++上的基本使用
ProtoBuf 语法（一）
qq_61635026的博客
05-30 2384
前面的文章介绍了 ProtoBuf 的基本概念，同时也展示了其基本使用方法，本文将详细的介绍 ProtoBuf 更多的字段以及语法。在单个.proto文件中可以定义多个消息体，且支持定义嵌套类型的消息（任意多层）。每个消息体中的字段编号可以重复。例如，更新文件，可以将phone// -------------------------- 嵌套写法 ------------------------- syntax = "proto3";
ProtoBuf的使用
终为nullptr
11-21 420
详解如何使用ProtoBuf实现序列化和反序列化
ProtoBuf学习和使用（二）：proto3语法详解【字段规则、消息类型的定义与使用】enum类型、Any类型、oneof类型、map类型、默认值、更新消息、选项option、通讯录——网络版、总结
m0_74343467的博客
03-25 2077
ProtoBuf学习和使用（二）：proto3语法详解【字段规则、消息类型的定义与使用】、enum类型【定义规则、定义时注意】 、Any类型、oneof类型、map类型、默认值、更新消息【更新规则、保留字段 reserved、未知字段、前后兼容性】、选项 option【选项分类、JAVA常用选项列举、设置自定义选项】、通讯录 4.0 实现——网络版、总结——序列化能力对比验证
【Protobuf速成指南】Message中如何定义“数组”？
罅隙的博客
06-07 6009
讲解Protobuf中repeated修饰字段使用特点
【ProtoBuf】ProtoBuf 快速上手
Elena's Blog
07-17 520
在。
C++Protobuf Release
05-15
2. **C++ 版本**: Protobuf 提供了C++ API，允许C++开发者在他们的项目中直接使用Protobuf进行数据序列化和反序列化操作。 3. **编译好的头文件和库**: 包含预编译的头文件和库文件意味着开发者无需自行编译...
Windows环境使用google protobuf实现简单的例子
10-14
标题中的“Windows环境使用google protobuf实现简单的例子”指的是在Windows操作系统下，利用Visual Studio (VS) 2010开发环境，结合Google的Protocol Buffers（protobuf）版本2.5.0进行简单应用的教程。protobuf是...
c++ protobuf 练习
01-08
c++ protobuf 练习安装proto buffer创建两个proto文件编译测试编译及运行结果 安装proto buffer 后续补上… 创建两个proto文件 stu.proto (单个字段模式) message stu { optional string name = 1; optional int32...
c++ error: ‘*’ does not name a type； did you mean ‘**’?
xiaozhi
08-08 186
c++ error: ‘*’ does not name a type； did you mean ‘**’?
STL中的迭代器失效（vector为例）
2302_80190394的博客
08-08 265
STL中的迭代器失效（vector为例）
使用vtkRenderer创建的显示点云的窗口如何刷新(QT/C++)
最新发布
qq_19319481的博客
08-09 191
使用vtkRenderer创建的显示点云的窗口如何刷新(QT/C++)
C++ - 函数重载
jiaowenjie的专栏
08-06 309
/打印的是第二个函数的地址。//打印的是第一个函数的地址。-> 重载函数在本质上是相互独立的不同函数。-> 函数返回值不能作为函数重载的依据。-> 重载函数的函数类型不同。**3.函数默认参数和函数重载****函数重载的注意事项：****4.函数重载的本质**
c++ protobuf 使用列子
04-19
非常感谢您的问题。关于 protobuf 的使用示例，您可以参考以下代码： 1. 安装 protobuf 在 Linux 系统中，您可以使用以下命令安装 protobuf： ``` apt-get install protobuf-compiler ``` 在 Windows 系统中，您可以访问 protobuf 的官方网站，下载并安装合适的版本。 2. 编写 .proto 文件 您需要编写一个 .proto 文件，定义您的数据结构。例如： ``` syntax = "proto3"; message Person { string name = 1; int32 age = 2; repeated string email = 3; } ``` 以上代码定义了一个 Person 类型，包含 name、age 和 email 三个字段。 3. 生成代码 使用 protobuf 编译器，将 .proto 文件编译成对应的代码： ``` protoc --cpp_out=. person.proto ``` 以上命令会在当前目录下生成 person.pb.h 和 person.pb.cc 两个文件。 4. 使用代码 在您的代码中，包含生成的 .h 文件，并创建一个 Person 对象： ``` #include "person.pb.h" Person person; person.set_name("John"); person.set_age(30); person.add_email("john@example.com"); ``` 以上代码创建了一个 Person 对象，将其 name、age 和 email 三个字段依次设置为 John、30 和 john@example.com。 希望以上内容对您有所帮助。如有其他问题，请随时提出。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

112233123hd

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值