【C++】protocol buffers-C++-IT72.COM

【C++】protocol buffers

Home / C++ 百晓生 2021-12-22 3209

protocol buffers 是一种语言无关、平台无关、可扩展的序列化结构数据的方法，它可用于（数据）通信协议、数据存储等。

Protocol Buffers 是一种灵活，高效，自动化机制的结构数据序列化方法－可类比 XML，但是比 XML 更小（3 ~ 10倍）、更快（20 ~ 100倍）、更为简单。

你可以定义数据的结构，然后使用特殊生成的源代码轻松的在各种数据流中使用各种语言进行编写和读取结构数据。你甚至可以更新数据结构，而不破坏由旧数据结构编译的已部署程序。

1.先来定义一个

本消息将以客户端请求登录和服务端返回为列

syntax = "proto3";
package pt;
option optimize_for = LITE_RUNTIME;
message req_login
{
    string username = 1;
    string password = 2;
}
message obj_user_info
{
    string nickname = 1;    　　//昵称
    string icon        = 2;    //头像
    int64  coin        = 3;    //金币
    string location    = 4;    //所属地
}
//游戏数据统计
message obj_user_game_record
{
    string time = 1;
    int32 kill  = 2;        //击杀数
    int32 dead  = 3;        //死亡数
    int32 assist= 4;        //助攻数
}
message rsp_login
{
    enum RET {
        SUCCESS         = 0;
        ACCOUNT_NULL    = 1;    //账号不存在
        ACCOUNT_LOCK    = 2;    //账号锁定
        PASSWORD_ERROR  = 3;    //密码错误
        ERROR           = 10;
    }
    int32 ret = 1;
    obj_user_info user_info = 2;
    repeated obj_user_game_record record = 3;
}

2.生成目标语言代码

下面的命令帮助我们将game.proto文件中定义的Protocol Buffer格式的消息编译成C++代码文件。

//SRC_DIR   .proto文件存放目录
//--cpp_out  指示编译器生成C++代码,DST_DIR为生成文件存放目录
//game.proto 待编译的协议文件
protoc -I=$SRC_DIR --cpp_out=$DST_DIR $SRC_DIR/game.proto

由于我们在game.proto文件中定义选项optimize_for=LITE_RUNTIME，因此由该文件内生成的所有C++类的父类均为::google::protobuf::MessageLite，而非::google::protobuf::Message。MessageLite类是Message的父类，MessageLite中缺少对反射的支持，而此类功能均在Message类中提供了具体的实现。

对于我们的项目而言，整个系统相对比较封闭，不会和外部程序进行交互，与此同时，我们的客户端部分又是运行在Android平台，有鉴于此，我们考虑使用LITE版本的Protocol Buffer。这样不仅可以得到更高编码效率，而且生成代码编译后所占用的资源也会更少，至于反射所能带来的灵活性和极易扩展性，对于该项目而言完全可以忽略。

3.protobuf自动生成的API

class rsp_login : public ::google::protobuf::MessageLite
{
public:
  //每一个message类都包含以下方法供你检测或操作
  void CopyFrom(const rsp_login& from);
  void MergeFrom(const rsp_login& from);
  void Clear();                              //清除所有字段内容,并置为空状态
  bool IsInitialized() const;                //检测所有required 是否初始化  int ByteSize() const;                      //类所占字节数
  
  //整形变量只提供获取、修改、清除
  void clear_ret();
  ::google::protobuf::int32 ret() const;
  void set_ret(::google::protobuf::int32 value);
  //自定义类类型user_info
  bool has_user_info() const;
  void clear_user_info();
  const ::pt::obj_user_info& user_info() const;
  //自定义类型,并没提供set方法,而是通过mutable_接口返回user_info的指针,可根据此指针进行赋值操作
  ::pt::obj_user_info* mutable_user_info();
  //返回user_info字段指针,将所有权移交给此指针,并将user_info字段置为empty状态
  ::pt::obj_user_info* release_user_info();
  //使用set_allocated要小心,传入的参数需要显示allocate,设置后函数内部维护此指针
  void set_allocated_user_info(::pt::obj_user_info* user_info);
  //record为repeated的类数组类型
  int record_size() const;
  void clear_record();
  //根据id索引,返回记录的引用,const不可修改内容
  const ::pt::obj_user_game_record& record(int index) const;
  //根据id索引,返回记录的指针,以供查看、修改
  ::pt::obj_user_game_record* mutable_record(int index);
  //repeated类型提供add接口增加一条记录,并返回此记录的指针,以便对其赋值
  ::pt::obj_user_game_record* add_record();
  //提供mutable接口,并返回record字段的容器指针,可根据此指针遍历、修改
  ::google::protobuf::RepeatedPtrField< ::pt::obj_user_game_record >* mutable_record();
  //返回record字段的容器引用,const不可修改内容
  const ::google::protobuf::RepeatedPtrField< ::pt::obj_user_game_record >& record() const;
}

4.protobuf读和写

#include <iostream>
#include <string>
#include "game.pb.h"
int main()
{
    pt::rsp_login rsp{};
    rsp.set_ret(pt::rsp_login_RET_SUCCESS);
    auto user_info = rsp.mutable_user_info();
    user_info->set_nickname("dsw");
    user_info->set_icon("345DS55GF34D774S");
    user_info->set_coin(2000);
    user_info->set_location("zh");
    for (int i = 0; i < 5; i++) {
        auto record = rsp.add_record();
        record->set_time("2017/4/13 12:22:11");
        record->set_kill(i * 4);
        record->set_dead(i * 2);
        record->set_assist(i * 5);
    }
    std::string buff{};
    rsp.SerializeToString(&buff);
    //------------------解析----------------------
    pt::rsp_login rsp2{};
    if (!rsp2.ParseFromString(buff)) {
        std::cout << "parse error\n";
    }
    
    auto temp_user_info = rsp2.user_info();
    std::cout << "nickname:" << temp_user_info.nickname() << std::endl;
    std::cout << "coin:" << temp_user_info.coin() << std::endl;
    for (int m = 0; m < rsp2.record_size(); m++) {
        auto temp_record = rsp2.record(m);
        std::cout << "time:" << temp_record.time() << " kill:" << temp_record.kill() << " dead:" << temp_record.dead() << " assist:" << temp_record.assist() << std::endl;
    }
}

输出如下：

nickname:dsw
coin:2000
time:2017/4/13 12:22:11 kill:0 dead:0 assist:0
time:2017/4/13 12:22:11 kill:4 dead:2 assist:5
time:2017/4/13 12:22:11 kill:8 dead:4 assist:10
time:2017/4/13 12:22:11 kill:12 dead:6 assist:15
time:2017/4/13 12:22:11 kill:16 dead:8 assist:20

4.扩展protoobuf

在你发布了使用Protocol-Buffers的代码之后, 你必定会想"改进"message的定义. 如果你想让你的新message向后兼容, 并且旧的message能够向前兼容。你一定希望如此,那么你在新的Person 中就要遵守其他的一些规则了:

　　(1).对已存在的任何字段, 你都不能更改其标识tag号。

　　(2).你绝对不能添加或删除任何required的字段。

　　(3).你可以添加新的optional或repeated的字段, 但是你必须使用新的标识tag号(此message中从未使用过的标识号,甚至连已经被删除过标识号也不行)。

　　(4).有一些例外情况, 但是它们很少使用。

　　如果你遵守这些规则, 老代码将能很好地解析新的消息, 并忽略掉任何新的字段. 对老代码来说, 已经被删除的optional字段将被赋予默认值. 已被删除的repeated字段将是空的. 新的代码也能够透明地读取旧的消息. 但是请牢记心中: 新的optional字段将不会出现在旧的消息中, 如果没有为一个optional项指定默认值, 那么就会使用与特定类型相关的默认值: 对string(null)、boolean(false)、数值类型(0)。

还要注意: 如果你添加了一个新的repeated字段, 你的新代码将无法告诉你它是否被留空了(被新代码), 或者是否从未被置值(被旧代码), 这是因为它没有has_标志.

转自cnblogs-DswCnblog

本文链接:https://www.it72.com/12708.htm