C++ Protobuf

Protobuf

protobuf (protocol buffer) 是谷歌內部的混合語言數據標準。通過將結構化的數據進行序列化(串列化)，用於通訊協議、數據存儲等領域的語言無關、平臺無關、可擴展的序列化結構數據格式。

• 序列化： 將結構數據或者對象轉換成能夠用於存儲和傳輸的格式。

• 反序列化： 在其他的計算環境中，將序列化後的數據還原為數據結構和對象

下載安裝

sudo apt install autoconf automake libtool curl make g++ unzip
https://github.com/protocolbuffers/protobuf/releases/
cd protobuf
./autogen.sh
./configure
make
make check
sudo make install
sudo ldconfig

Proto3中的數據類型限定修飾符：

repeated 表示一個數組類型

protobuf中常用的數據類型：

• bool, 布爾類型
• double, 64位浮點數
• float, 32位浮點數
• int32, 32位整數
• int64, 64位整數
• uint64, 64位無符號整數
• sint32, 32位整數，處理負數效率更高
• sint64, 64位整數，處理負數效率更高
• string, 只能處理ASCII字元
• bytes, 用於處理多位元組的語言字元
• enum, 枚舉類型

預設值

解析消息時，如果編碼的消息不包含特定的單數元素，則已分析對象中的相應欄位將設置為該欄位的預設值。這些預設值是特定於類型的：

• 對於字元串，預設值為空字元串。
• 對於位元組，預設值為空位元組。
• 對於布爾值，預設值為 false。
• 對於數值類型，預設值為零。
• 對於枚舉，預設值是第一個定義的枚舉值，該值必須為 0。
• 對於消息欄位，未設置該欄位。它的確切值取決於語言。

舉個慄子

syntax = "proto3";	//預設proto2，這裡用proto3

package pt; //C++ 類似 namespace

enum EnMsgType{
  EnMsgTypeP = 0; //占位
  LOGIN_MSG = 1;  // 登錄消息
  LOGIN_MSG_ACK = 2; // 登錄響應消息
  LOGIN_OUT_MSG = 3; // 註銷消息
  REG_MSG = 4; // 註冊消息
  REG_MSG_ACK = 5; // 註冊響應消息
  ONE_CHAT_MSG = 6; // 聊天消息
  ADD_FRIEND_MSG = 7; // 添加好友消息
  CREATE_GROUP_MSG = 8; // 創建群組
  ADD_GROUP_MSG = 9; // 加入群組
  GROUP_CHAT_MSG = 10; // 群聊天
}

message MsgType{
  EnMsgType msgtype = 1;
}

enum ErrCode {
  SUCCESS = 0; //正確
  FAILURE = 1; //失敗
  ONLINE = 2;  //已線上
};

message FriendsInfo {
  int32 id = 1;
  string name = 2;
  string state = 3;
}

message UsersInfo{
  int32 id = 1;
  string name = 2;
  string state = 3;
  string role = 4;
}

message GroupsInfo{
  int32 id = 1;
  string groupname = 2;
  string groupdesc = 3;
  repeated UsersInfo users = 4;
}

message Login {
  MsgType msgid = 1;
  int32 id = 2;
  string pwd = 3;
}

message LoginRsp{
  MsgType msgid = 1;
  int32 id = 2;
  string name = 3;
  repeated string offlinemsg = 4;
  repeated FriendsInfo friends = 5;
  repeated GroupsInfo groups = 6;
  ErrCode errcode = 7;
  string errmsg = 8;
}

生成代碼

 protoc test.proto --cpp_out=./

#include <iostream>
#include "test.pb.h"

int main() {
    pt::Register reg;
    pt::MsgType* msg = reg.mutable_msgid();
    msg->set_msgtype(pt::EnMsgType::LOGIN_MSG);

    reg.set_name("cmf");
    reg.set_pwd("123456");
    std::string str;
    reg.SerializeToString(&str);	//序列化
    std::cout << str.c_str() << std::endl;

    pt::Register res;
    if (res.ParseFromString(str)) {	//反序列化
        std::cout << res.msgid().msgtype() << " " << res.name() << " " << res.pwd() << std::endl;
    }

    pt::LoginRsp loginRsp;
    pt::MsgType* m = loginRsp.mutable_msgid();
    m->set_msgtype(pt::EnMsgType::LOGIN_MSG_ACK);

    loginRsp.set_id(1);
    loginRsp.set_name("cmf");
    loginRsp.set_errcode(pt::ErrCode::SUCCESS);
    loginRsp.set_errmsg("test");
    loginRsp.add_offlinemsg("nihao");

    pt::FriendsInfo *info = loginRsp.add_friends();
    info->set_name("cc");
    info->set_id(2);
    info->set_state("no");
    std::string strr;
    loginRsp.SerializeToString(&strr);
    std::cout << strr << std::endl;

    for (int i = 0; i < loginRsp.friends_size(); ++i) {
        pt::FriendsInfo info = loginRsp.friends(i);
        std::cout << info.name() << " " << info.id() << " " << info.state() << std::endl;
    }
    return 0;
}

編譯運行加 -lprotobuf

轉換介面

#include <google/protobuf/util/json_util.h>

using google::protobuf::util::JsonStringToMessage;

bool proto_to_json(const google::protobuf::Message& message, std::string& json) {
    google::protobuf::util::JsonPrintOptions options;
    options.add_whitespace = true;
    options.always_print_primitive_fields = true;
    options.preserve_proto_field_names = true;
    return MessageToJsonString(message, &json, options).ok();
}

bool json_to_proto(const std::string& json, google::protobuf::Message& message) {
    return JsonStringToMessage(json, &message).ok();
}