protobuf入门教程(五):枚举(enum)、包(package)

枚举(enum)

消息格式

当需要定义一个消息类型的时候,可能想为一个字段指定某“预定义值序列”中的一个值,这时候可以通过枚举实现。

syntax = "proto3";//指定版本信息,不指定会报错

message Person //message为关键字,作用为定义一种消息类型
{
    string name = 1;    //姓名
    int32 id = 2;       //id
    string email = 3; //邮件

    enum PhoneType //枚举消息类型
    {
        MOBILE = 0; //proto3版本中,首成员必须为0,成员不应有相同的值
        HOME = 1;
        WORK = 2;
    }

    message PhoneNumber
    {
        string number = 1;
        PhoneType type = 2;
    }

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

message AddressBook
{
    repeated Person people = 1;
}

测试程序

void set_addressbook()
{
    AddressBook obj;

    Person *p1 = obj.add_people(); //新增加一个Person
    p1->set_name("mike");
    p1->set_id(1);
    p1->set_email("mike@qq.com");

    Person::PhoneNumber *phone1 = p1->add_phones(); //增加一个phone
    phone1->set_number("110");
    phone1->set_type(Person::MOBILE);

    Person::PhoneNumber *phone2 = p1->add_phones(); //增加一个phone
    phone2->set_number("120");
    phone2->set_type(Person::HOME);

    fstream output("pb.xxx", ios::out | ios::trunc | ios::binary);

    bool flag = obj.SerializeToOstream(&output);//序列化
    if (!flag)
    {
        cerr << "Failed to write file." << endl;
        return;
    }

    output.close();//关闭文件
}

void get_addressbook()
{
    AddressBook obj;
    fstream input("./pb.xxx", ios::in | ios::binary);
    obj.ParseFromIstream(&input);  //反序列化
    input.close(); //关闭文件

    for (int i = 0; i < obj.people_size(); i++)
    {
        const Person& person = obj.people(i);//取第i个people
        cout << "第" << i + 1 << "个信息\n";
        cout << "name = " << person.name() << endl;
        cout << "id = " << person.id() << endl;
        cout << "email = " << person.email() << endl;

        for (int j = 0; j < person.phones_size(); j++)
        {
            const Person::PhoneNumber& phone_number = person.phones(j);

            switch (phone_number.type())
            {
            case Person::MOBILE:
                cout << "  Mobile phone #: ";
                break;
            case Person::HOME:
                cout << "  Home phone #: ";
                break;
            case Person::WORK:
                cout << "  Work phone #: ";
                break;
            }

            cout << phone_number.number() << endl;
        }
        cout << endl;
    }
}

包(package)

消息格式

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

syntax = "proto3";//指定版本信息,不指定会报错

package tutorial; //package声明符

message Person //message为关键字,作用为定义一种消息类型
{
    string name = 1;    //姓名
    int32 id = 2;       //id
    string email = 3; //邮件

    enum PhoneType //枚举消息类型
    {
        MOBILE = 0; //proto3版本中,首成员必须为0,成员不应有相同的值
        HOME = 1;
        WORK = 2;
    }

    message PhoneNumber
    {
        string number = 1;
        PhoneType type = 2;
    }

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

message AddressBook
{
    repeated Person people = 1;
}

测试程序

void set_addressbook()
{
    tutorial::AddressBook obj;

    tutorial::Person *p1 = obj.add_people(); //新增加一个Person
    p1->set_name("mike");
    p1->set_id(1);
    p1->set_email("mike@qq.com");

    tutorial::Person::PhoneNumber *phone1 = p1->add_phones(); //增加一个phone
    phone1->set_number("110");
    phone1->set_type(tutorial::Person::MOBILE);

    tutorial::Person::PhoneNumber *phone2 = p1->add_phones(); //增加一个phone
    phone2->set_number("120");
    phone2->set_type(tutorial::Person::HOME);

    fstream output("pb.xxx", ios::out | ios::trunc | ios::binary);

    bool flag = obj.SerializeToOstream(&output);//序列化
    if (!flag)
    {
        cerr << "Failed to write file." << endl;
        return;
    }

    output.close();//关闭文件
}

void get_addressbook()
{
    tutorial::AddressBook obj;
    fstream input("./pb.xxx", ios::in | ios::binary);
    obj.ParseFromIstream(&input);  //反序列化
    input.close(); //关闭文件

    for (int i = 0; i < obj.people_size(); i++)
    {
        const tutorial::Person& person = obj.people(i);//取第i个people
        cout << "第" << i + 1 << "个信息\n";
        cout << "name = " << person.name() << endl;
        cout << "id = " << person.id() << endl;
        cout << "email = " << person.email() << endl;

        for (int j = 0; j < person.phones_size(); j++)
        {
            const tutorial::Person::PhoneNumber& phone_number = person.phones(j);

            switch (phone_number.type())
            {
            case tutorial::Person::MOBILE:
                cout << "  Mobile phone #: ";
                break;
            case tutorial::Person::HOME:
                cout << "  Home phone #: ";
                break;
            case tutorial::Person::WORK:
                cout << "  Work phone #: ";
                break;
            }

            cout << phone_number.number() << endl;
        }
        cout << endl;
    }
}

本教程源代码下载地址:http://download.csdn.net/detail/tennysonsky/9884335

### Protocol Buffers (Protobuf) 概述 Protocol Buffers 是一种高效的结构化数据序列化协议,由 Google 开发并开源。它可用于多种编程语言之间的高效通信,在性能上优于 XML 和 JSON 等传统格式[^2]。 #### 主要特点 - **跨平台支持**:适用于 C++、Java、Python、Go等多种主流开发环境。 - **高性能**:相较于其他序列化方案具有更快的速度和更小的数据体积。 - **向后兼容性好**:可以在不破坏现有客户端的情况下扩展消息字段。 ### 安装与配置 为了能够在 Go 项目中应用 Protobuf 进行数据交换,需完成如下准备工作: - 下载并安装 `protoc` 编译器及其对应的 golang 插件[^1]。 ```bash go install google.golang.org/protobuf/cmd/protoc-gen-go@latest ``` 这一步骤使得开发者能够通过 `.proto` 文件生成目标语言的具体实现代码,从而简化了不同系统间复杂对象模型的一致性和维护工作[^3]。 ### 创建 Proto 文件 编写 `.proto` 文件来定义所需的消息类型。下面是一个简单的例子展示了如何创建登录请求的 proto 文件[^4]: ```protobuf syntax = "proto3"; package IM.Login; import "IM.BaseDefine.proto"; option optimize_for = LITE_RUNTIME; message IMLoginReq { string user_name = 1; string password = 2; IM.BaseDefine.UserStatType online_status = 3; IM.BaseDefine.ClientType client_type = 4; string client_version = 5; } ``` 此文件不仅限定了各个属性的名字和编号,还指明了其所属名以及引入外部依赖项的方式。 ### 序列化与反序列化操作 一旦拥有了上述准备好的 `.proto` 文件之后,便可以利用编译工具将其转化为具体语言版本下的类库供程序调用了。对于 Go 来说,则会得到一组用于构建、读取二进制流的方法集合,进而实现了对任意实例状态的有效保存和恢复机制。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值