protocol buffers基本使用

柔情只为你懂 2021-11-05 14:26 250阅读 0赞

官方文档：  
[官方文档链接][Link 1]  
中文版：  
[文档链接][Link 2]

## 文章目录  @\[toc\]  特点：  数据结构  语法：  第一行：  字段定义：  注释：  保留字段  使用其他类型  嵌套类型  常见关键字 ##

--------------------

# 特点： #

灵活、有效、自动配置的序列化结构数据，类似xml，但是更小，更快，更简单

# 数据结构 #

文件类型后缀为.proto  
定义message作为类型  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzA5MzUwMQ_size_16_color_FFFFFF_t_70]  
每个message有一个或多个字段，每个字段有名字和值类型

运行后，产生一个类，包含每个字段和对应的方法。

# 语法： #

## 第一行： ##

syntax =“proto3”;  
不写的话，，默认认为是proto2

## 字段定义： ##

每个字段都有类型，除了基本的还可以有复合类型和枚举  
每个字段都要加一个编号，用来一二进制格式表示字段（需要注意的是，1-15用一个字节保存，其他的两个字节，所以，频繁出现的应该使用前15个编号），最小数为1，最大为2的29次方-1.（注意19000到19999为保留数字，不能用）

## 注释： ##

//和/\* … \*/

## 保留字段 ##

使用reserved关键字  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzA5MzUwMQ_size_16_color_FFFFFF_t_70 1]

## 使用其他类型 ##

允许使用其他message的类型  
如果要是用的类型为其他文件的message就要导入  
import “myproject/other\_protos.proto”;

## 嵌套类型 ##

可以一个message中定义多个message，外界使用时，用父message.内部message方式。

# 常见关键字 #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzA5MzUwMQ_size_16_color_FFFFFF_t_70 2]

[Link 1]: https://developers.google.com/protocol-buffers/docs/overview
[Link 2]: https://colobu.com/2017/03/16/Protobuf3-language-guide/#%E4%BF%9D%E7%95%99%E6%A0%87%E8%AF%86%E7%AC%A6%EF%BC%88Reserved%EF%BC%89
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzA5MzUwMQ_size_16_color_FFFFFF_t_70]: /images/20211105/df8cf0e427e14447bda341d7c1ee15b1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzA5MzUwMQ_size_16_color_FFFFFF_t_70 1]: /images/20211105/78fdcb3fafa04ac58f56e01055af6884.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzA5MzUwMQ_size_16_color_FFFFFF_t_70 2]: /images/20211105/683d05a98dfb428e9220d2be04169f65.png