C++ 关于ProtoBuf的使用记录

对 ProtoBuf 的基本概念有了一定了解之后，具体该如何使用 ProtoBuf。

第一步，创建 .proto 文件，定义数据结构，如下例1所示：

// 例1: 在 xxx.proto 文件中定义 Example1 message
message Example1 {
    optional string stringVal = 1;
    optional bytes bytesVal = 2;
    message EmbeddedMessage {
        int32 int32Val = 1;
        string stringVal = 2;
    }
    optional EmbeddedMessage embeddedExample1 = 3;
    repeated int32 repeatedInt32Val = 4;
    repeated string repeatedStringVal = 5;
}

规则以及规范：

message xxx {
  // 字段规则：required -> 字段只能也必须出现 1 次
  // 字段规则：optional -> 字段可出现 0 次或1次
  // 字段规则：repeated -> 字段可出现任意多次（包括 0）
  // 类型：int32、int64、sint32、sint64、string、32-bit ....
  // 字段编号：0 ~ 536870911（除去 19000 到 19999 之间的数字）
  字段规则 类型 名称 = 字段编号;
}

message 和 字段命名:
使用驼峰命名法（首字母大写）命名 message
使用下划线命名字段
必须使用以下修饰符之一注释每个字段：

required: 必须提供该字段的值，否则该消息将被视为“未初始化”。如果是在调试模式下编译 libprotobuf，则序列化一个未初始化的 message 将将导致断言失败。在优化的构建中，将跳过检查并始终写入消息。但是，解析未初始化的消息将始终失败（通过从解析方法返回 false）。除此之外，required 字段的行为与 optional 字段完全相同。

optional: 可以设置也可以不设置该字段。如果未设置可选字段值，则使用默认值。对于简单类型，你可以指定自己的默认值，就像我们在示例中为电话号码类型所做的那样。否则，使用系统默认值：数字类型为 0，字符串为空字符串，bools 为 false。对于嵌入 message，默认值始终是消息的 “默认实例” 或 “原型”，其中没有设置任何字段。调用访问器以获取尚未显式设置的 optional（或 required）字段的值始终返回该字段的默认值。

repeated: 该字段可以重复任意次数（包括零次）。重复值的顺序将保留在 protocol buffer 中。可以将 repeated 字段视为动态大小的数组。

例子：
message CRspInfo
{
	optional int32 errorid = 1; 	// 错误代码
	optional string errprmsg = 2; 	// 错误信息
}
自动生成下面这些
inline void CRspInfo::clear_errorid() {
  errorid_ = 0;
  clear_has_errorid();
}
inline ::google::protobuf::int32 CRspInfo::errorid() const {
  // @@protoc_insertion_point(field_get:xtp.CRspInfo.ErrorID)
  return errorid_;
}
//标准 Message 方法
//每个 message 类还包含许多其他方法，可用于检查或操作整个 message，包括：
    bool IsInitialized() const;// 检查是否已设置所有必填 required 字段
    string DebugString() const;// 返回 message 的人类可读表达，对调试特别有用

    void CopyFrom(const Person& from);// 用给定的 message 的值覆盖 message
    void Clear();// 将所有元素清除回 empty 状态

第二步，protoc 编译 .proto 文件生成读写接口

我们在 .proto 文件中定义了数据结构，这些数据结构是面向开发者和业务程序的，并不面向存储和传输。
当需要把这些数据进行存储或传输时，就需要将这些结构数据进行序列化、反序列化以及读写。那么如何实现呢？不用担心， ProtoBuf 将会为我们提供相应的接口代码。如何提供？答案就是通过 protoc 这个编译器。

可通过如下命令生成相应的接口代码：

// $SRC_DIR: .proto 所在的源目录
// --cpp_out: 生成 c++ 代码
// $DST_DIR: 生成代码的目标目录
// xxx.proto: 要针对哪个 proto 文件生成接口代码

protoc -I=$SRC_DIR --cpp_out=$DST_DIR $SRC_DIR/xxx.proto

ProtoBuf 的序列化使用过程：

定义 .proto 文件
protoc 编译器编译 .proto 文件生成一系列接口代码
调用生成的接口实现对 .proto 定义的字段的读取以及 message 对象的序列化、反序列化方法