protobuf实践+生成C++代码的解析

最新推荐文章于 2024-07-06 16:00:29 发布

Danica~

最新推荐文章于 2024-07-06 16:00:29 发布

阅读量759

点赞数 24

分类专栏： RPC分布式通信框架文章标签：网络 rpc

本文链接：https://blog.csdn.net/m0_62689947/article/details/139912585

版权

RPC分布式通信框架专栏收录该内容

14 篇文章 1 订阅

订阅专栏

1.实践1（简单使用）

2.实践2（存储列表类数据）

3.实践3（定义RPC方法）

4.解析protobuf的message类

5.解析protobuf的service类

6.Rpcchannel是什么呢？

1.实践1（简单使用）

下图是我的项目代码工程。我们在test创建protobuf文件夹。然后在protobuf文件下创建main.cc和test.proto进行我们的实践。

我们先在test.proto定义消息类型（message)
注意：里面的类型都是谷歌protobuf定义的类型，和C++的类型相似
我们用bytes定义字符串类型，多字节存储，处理的是字节，省时省消耗
如果写成string，还要进行多字节的转码，把字符转成字节存储。
因为protobuf的二进制存储的

syntax = "proto3";//声明了protobuf的版本

package fixbug;//声明了代码所在的包（对于C++来说是namespace）

//定义登录请求消息类型   name   pwd
message LoginRequest
{
    string name = 1;
    string pwd = 2;
}

//定义登录响应消息类型
message LoginResponse
{
    int32 errcode = 1;
    string errmsg = 2;
    bool success = 3;
}

优化后代码：

syntax = "proto3";//声明了protobuf的版本

package fixbug;//声明了代码所在的包（对于C++来说是namespace）

message ResultCode//封装一下失败类，减少代码重复量
{
    int32 errcode = 1;//错误码
    bytes errmsg = 2;//错误消息
}
//数据（单个数据） 列表（数组） 映射表（map）
//定义登录请求消息类型   name   pwd
message LoginRequest
{
    bytes name = 1;
    bytes pwd = 2;
}

//定义登录响应消息类型
message LoginResponse
{
    ResultCode result=1;
    bool success = 2;
}

我们配置完test.proto之后，打开终端，进入到protobuf中
输入命令：protoc test.proto --cpp.out=./
生成了teat.pb.cc和test.pb.h两个文件,在当前目录

温馨提示：我们写完文件退出保存后再去编译运行它！
可以看到我们之前定义的LoginRequest是一个class类！
我们定义的name，pwd相当于就是LoginRequest类的成员变量，也有相应的成员方法！

接下来我们打开main.cc，编码测试protobuf!

#include "test.pb.h"
#include <iostream>
#include <string>
using namespace fixbug;

int main()
{
    //封装了login请求对象的数据
    LoginRequest reg;
    reg.set_name("zhang san");
    reg.set_pwd("123456");

    //对象数据序列化 =》char*
    std::string send_str;
    if(reg.SerializeToString(&send_str))
    {
        std::cout<<send_str.c_str()<<std::endl;
    }

    //从send_str反序列化一个login请求对象
    LoginRequest reqB;
    if(reqB.ParseFromString(send_str))
    {
        std::cout<<reqB.name()<<std::endl;
        std::cout<<reqB.pwd()<<std::endl;
    }

    return 0;
}

我们保存文件，打开终端，输入以下命令

因为我们的protobuf是生成动态库，所以要加上-lprotobuf
生成a.out文件

序列化成
zhang san123456
反序列化成
zhang san
123456

2.实践2（存储列表类数据）

我们在存储数据的时候，有3种形式：
数据（单个数据）列表（数组）映射表（map）

以获取好友列表为例，我们先在test.proto定义消息类型

syntax = "proto3";//声明了protobuf的版本

package fixbug;//声明了代码所在的包（对于C++来说是namespace）

message ResultCode//封装一下失败类，减少代码重复量
{
    int32 errcode = 1;//错误码
    bytes errmsg = 2;//错误消息
}
//数据（单个数据） 列表（数组） 映射表（map）
//定义登录请求消息类型   name   pwd
message LoginRequest
{
    bytes name = 1;
    bytes pwd = 2;
}

//定义登录响应消息类型
message LoginResponse
{
    ResultCode result=1;
    bool success = 2;
}

//定义获取好友列表的请求
message GetFriendListsRequest
{
    uint32 userid=1;
}

message User
{
    bytes name=1;
    uint32 age=2;
    enum Sex
    {
        MAN=0;
        WOMAN=1;
    }
    Sex sex=3;
}
//定义获取好友列表的消息响应
message GetFriendListsResponse
{
    ResultCode result = 1;
    repeated User friend_list = 2;//定义了一个列表类型（列表存储，存储多个好友信息）

}

保存，打开终端进入到protobuf，输入命令
protoc test.proto --cpp_out=./

接下来我们打开main.cc

#include "test.pb.h"
#include <iostream>
#include <string>
using namespace fixbug;

int main()
{
    // LoginResponse rsp;
    // ResultCode *rc=rsp.mutable_result();//获取指针
    // rc->set_errcode(1);
    // rc->set_errmsg("登录处理失败了");

    GetFriendListsResponse rsp;
    ResultCode *rc=rsp.mutable_result();
    rc->set_errcode(0);

    User *user1=rsp.add_friend_list();
    user1->set_name("zhang san");
    user1->set_age(20);
    user1->set_sex(User::MAN);

    std::cout<<rsp.friend_list_size()<<std::endl;

    return 0;
}

输出的是好友的数量。

3.实践3（定义RPC方法）

在protobuf里面怎么定义描述rpc方法的类型？
传输RPC方法名字和所调用方法的参数

protobuf本身没有提供rpc通信功能。
我们是要它做RPC方法调用的序列化和反序列化！
在test.proto配置如下

rpc Login相当于是定义一个login的rpc方法，login是rpc方法的名字，protobuf不支持rpc通信功能，只支持对于rpc方法的描述，通过这个描述，它就可以去做rpc请求的携带的参数的序列化和反序列化，login的小括号就存储实参的protobuf的类型表示，returns就是表示：这个rpc方法login()执行以后返回的protobuf打包的类型。

test.proto全套代码：
message描述的都是class类，定义option，表示生成service服务类和rpc方法描述，否则默认不生成。

syntax = "proto3";//声明了protobuf的版本

package fixbug;//声明了代码所在的包（对于C++来说是namespace）

//定义下面的选项，表示生成service服务类和rpc方法描述，默认不生成
option cc_generic_services=true;

message ResultCode//封装一下失败类，减少代码重复量
{
    int32 errcode = 1;//错误码
    bytes errmsg = 2;//错误消息
}
//数据（单个数据） 列表（数组） 映射表（map）
//定义登录请求消息类型   name   pwd
message LoginRequest
{
    bytes name = 1;
    bytes pwd = 2;
    //map<int32,string> test = 3;
}

//定义登录响应消息类型
message LoginResponse
{
    ResultCode result=1;
    bool success = 2;
}

//定义获取好友列表的请求
message GetFriendListsRequest
{
    uint32 userid=1;
}

message User
{
    bytes name=1;
    uint32 age=2;
    enum Sex
    {
        MAN=0;
        WOMAN=1;
    }
    Sex sex=3;
}
//定义获取好友列表的消息响应
message GetFriendListsResponse
{
    ResultCode result = 1;
    repeated User friend_list = 2;//定义了一个列表类型（列表存储，存储多个好友信息）
}

//在protobuf里面怎么定义描述rpc方法的类型  - service
service UserServiceRpc
{
    rpc Login(LoginRequest) returns(LoginResponse);
    rpc GetFriendLists(GetFriendListsRequest) returns(GetFriendListsResponse);
}

保存，编译
我们进入生成的test.pb.h看到，服务service生成了UserServiceRpc类和UserServiceRpc_stub类（桩，代理类）