protobuf

pony

Ref Website

• https://colobu.com/2019/10/03/protobuf-ultimate-tutorial-in-go/
• https://developers.google.com/protocol-buffers/docs/cpptutorial
• 高级教程

1 主要特点

• 跨平台
• 跨语言
• 序列化、反序列化（数据的编码存储和读取）
• 后续添加消息不影响之前的代码，但是需要遵循一定的规则

2 格式

syntax = "proto2";
package tutorial; 
import  "other.proto"; # 引入其他proto
message Person {
  required string name = 1; # 必须要有
  required int32 id = 2;
  optional string email = 3; # 可选，真实数据中不一定要有
  enum PhoneType {
    MOBILE = 0;
    HOME = 1;
    WORK = 2;
  }
  message PhoneNumber {
    required string number = 1; # 动态数组
    optional PhoneType type = 2 [default = HOME];
  }
  repeated PhoneNumber phones = 4;
}
message AddressBook {
  repeated Person people = 1;
}

字段是以[ "repeated" ] type fieldName "=" fieldNumber [ "[" fieldOptions "]" ] ";"格式定义的

每个元素上的“= 1”、“= 2”标记标识字段在二进制编码中使用的唯一“标记”。标签号1-15比更高的数字需要少一个字节的编码，因此作为优化，您可以决定对常用或重复的元素使用这些标签，对不常用的可选元素使用标签号16或更高。重复字段中的每个元素都需要对标签号进行重新编码，因此重复字段尤其适合于这种优化。

3 API

  // name
  inline bool has_name() const;
  inline void clear_name();
  inline const ::std::string& name() const;
  inline void set_name(const ::std::string& value);
  inline void set_name(const char* value);
  inline ::std::string* mutable_name();
  // id
  inline bool has_id() const;
  inline void clear_id();
  inline int32_t id() const;
  inline void set_id(int32_t value);
  // email
  inline bool has_email() const;
  inline void clear_email();
  inline const ::std::string& email() const;
  inline void set_email(const ::std::string& value);
  inline void set_email(const char* value);
  inline ::std::string* mutable_email();
  // phones
  inline int phones_size() const;
  inline void clear_phones();
  inline const ::google::protobuf::RepeatedPtrField< ::tutorial::Person_PhoneNumber >& phones() const;
  inline ::google::protobuf::RepeatedPtrField< ::tutorial::Person_PhoneNumber >* mutable_phones();
  inline const ::tutorial::Person_PhoneNumber& phones(int index) const;
  inline ::tutorial::Person_PhoneNumber* mutable_phones(int index);
  inline ::tutorial::Person_PhoneNumber* add_phones();

对于single 类型的数据，has_xx()
对于repeated 类型数据，xx_size()
大家公有clear_xx(),xx() get方法，set_xx set方法。
对于string或者repeated方法，mutable_xx
对于repeated，还有xx(index),xxs(),add_xx()

4 Standard Message Methods

5 Parsing and Serialization