Protobuf是什么
Protobuf全名:Protocol Buffers。是谷歌用于序列化结构化数据的语言无关和平台无关的可扩展机制。目前本人接触到的应用场景主要有:
- 定义服务之间所依赖数据的结构。比如服务A需要将结构体S写入文件,服务B需要从文件读取结构体S。在这种场景下我们通常用Protobuf定义S的结构属性。
- 定义服务之间通信的数据结构,通常用于rpc的场景。后面会专门出一篇博客介绍这部分功能。
Protobuf基本语法
我们跟着一个简单Protobuf文件来了解下Protobuf基本语法吧:(基于Proto3)
syntax = "proto3"; //指定本文件采用的proto v3语法
message Person_Entity { // 定义Person结构体
enum Gender { // 定义性别,为枚举类型,值为男性(Male)或者女性(Female)
Male = 0;
Female = 1;
}
string name = 1; // 定义Person结构体中的名称属性,类型为string
uint32 age = 2; // 定义Person结构体中的年龄属性,类型为uint32
Gender gender = 3; // 定义Person结构体中的性别属性,类型为Gender
repeated Person_Entity children = 4; // 定义Person结构体中的孩子属性,类型为Person的列表类型
map<string, string> education_address_map = 5; // 定义上学阶段->上学地址的map映射
}
其中,enum类型的第一个value必须是0。
Protobuf编译
我们定义好了proto文件,在我们的项目中怎么使用呢?很简单,我们需要先用protoc将定义好的proto编译成符合我们项目语言的代码,之后直接在项目中使用即可。
1. 下载protobuf源码包
本文中使用Protobuf v3.5.0,下载地址:https://github.com/protocolbuffers/protobuf/releases/download/v3.5.0/protobuf-all-3.5.0.tar.gz
或者也可以前往https://github.com/protocolbuffers/protobuf/tags挑选你想要的版本。
如果使用wget下载失效,可以前往https://github.com/protocolbuffers/protobuf/releases/tag/v3.5.0手动点击下方protobuf-all-3.5.0.tar.gz进行下载。
2. 解压protobuf源码包
tar -zxvf protobuf-all-3.5.0.tar.gz
3. 设置protobuf编译目录
在这里,编译目录设置为protobuf源码路径下,之后在安装完protoc之后,protoc命令将存在于/usr/local/protobuf-3.5.0/bin/protoc
cshen@cshen-mac local % cd protobuf-3.5.0
cshen@cshen-mac protobuf-3.5.0 % ./configure --prefix=/usr/local/protobuf-3.5.0
4. 安装protoc
cshen@cshen-mac protobuf-3.5.0