protobuf学习笔记

最新推荐文章于 2024-10-09 14:38:08 发布

冰火两重天

最新推荐文章于 2024-10-09 14:38:08 发布

阅读量3.3k

点赞数

分类专栏：序列化机制文章标签：数据结构 google 扩展语言平台

本文链接：https://blog.youkuaiyun.com/sprayabc/article/details/7796459

版权

序列化机制专栏收录该内容

6 篇文章

订阅专栏

本文是关于protobuf的学习笔记，介绍了protobuf的基本概念、消息格式定义、编译流程、API使用以及序列化与解析的方法。重点讨论了required、optional和repeated字段的区别，并强调了protobuf的不可变性和兼容性问题。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

公司新来的CTO为google大牛，要求所有通信协议为protobuf，我也学习下protobuf。

众所周知，protobuf是类似thrift的语言无关、平台无关、可扩展的用来通信的数据结构，且被序列化了。与thrift相比，protobuf仅仅提供了消息序列化与反序列化的能力。

https://developers.google.com/protocol-buffers/docs/javatutorial?hl=zh-CN

1 定义消息格式

package tutorial;//如果不指定java_package选项，则次为默认的Java包名

option java_package = "com.example.tutorial";
option java_outer_classname = "AddressBookProtos";//包装消息体的类名，如果不知定，则生成的Java文件名为.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 phone = 4;
}

message AddressBook {
  repeated Person person = 1;
}

在消息定义中，支持很多基本的域类型： bool , int32 , float , double，枚举和 string，你可以使用Message来定制自己的消息结构体，以及消息体的嵌套。

"=1" "=2"，每个域上的代表了在二进制中唯一的'tag'。tag数1-15与更大的tag数相比，需要少一个字节来编码。大于16个tag，使用option。在重复域中每个元素需要重新编码tag number。所以repeated fields使用option最合适了。

required：值必须提供，否则message会被认为“未初始化”，构建未初始化的messge会抛出RuntimeException。

optionnal：值可能被设置或未被设置。如果未被设置，使用default。对于简单类型来说，数字类型为0，string为空字符串，false为bool。对于嵌套message，默认值为默认的实例，值都没有被设置。

repeated：feild会重复多次，重复值的次序会存在protobuf中，可以看作为动态数组。

注意：如果停止写或发送一个required field，变更为optionnal时，会引发问题。不兼容old reader。

2编译protocol buff

protoc -I=$SRC_DIR --java_out=$DST_DIR $SRC_DIR/addressbook.proto

3 protocol buffer api

在.proto中定义的每个Message都有一个builder，用来创建该message的实例。

4 Builders vs. Messages

message类是不可变的，一旦创建不可更改。创建一个对象时，必须一个builder，然后设置filed的值，最后调用build()方法。例如：

Person john =
  Person.newBuilder()
    .setId(1234)
    .setName("John Doe")
    .setEmail("jdoe@example.com")
    .addPhone(
      Person.PhoneNumber.newBuilder()
        .setNumber("555-4321")
        .setType(Person.PhoneType.HOME))
    .build();