protobuf简介及实践
protobuf简介及使用
protobuf的用途
几个开源代码仓之间的联系
笔者发现pb存在几个开源代码仓,之间的关联也不是很清晰,仔细探究一番后,进行了总计。如以下几点
1、pb需要一个通用的编译器,将proto文件转换为特定语言的源码,即解析idl。
2、针对于特定语言,定义基础的复合数据结构,并实现生成该特定语言的细节,实现一个该语言的生成器。
仓库名 | 用途 | 链接 | 发布件 |
---|---|---|---|
protobuf | 生成编译器 | https://github.com/protocolbuffers/protobuf/ | protoc |
protobuf-c | 生成c代码 | https://github.com/protobuf-c/protobuf-c | protoc-gen-c |
protobuf-go | 生成go代码 | https://github.com/protocolbuffers/protobuf-go | protoc-gen-go |
protobuf仓库直接内置了部分语言的生成器,主要是以下语言:
- C++
- C#
- Java
- Kotlin
- Objective-C
- PHP
- Python
- Ruby
使用
编译器和生成器
protobuf的编译器称为protoc
。这里重点关注c和go的生成器,其中的c生成器是protoc-gen-c
,go生成器是protoc-gen-go
。
安装编译器
$ git clone --depth=1 https://github.com/protocolbuffers/protobuf
$ cd protobuf
$ ./autogen.sh
$ ./configure
$ make
$ sudo make install
$ protoc --version # 查看 protoc 版本,成功输出版本号,说明安装成功
libprotoc 3.15.6
安装生成器
这里需要区分不同的语言
c
由于笔者用的是mac,使用github直接make安装是很方便的。仓库地址:https://github.com/protobuf-c/protobuf-c。
./configure && make && make install
go
go install github.com/golang/protobuf/protoc-gen-go@latest
语言实践
编写原型文件
syntax="proto3";
package foo.bar;
message Phone {
int32 phoneNumber = 1;
}
message Person {
string name = 1;
int32 id = 2;
string email = 3;
Phone phone = 4;
}
C语言
protoc --c_out=. example.proto
Go语言
protoc --go_out=. example.proto
python
protoc --python_out=. example.proto
参考
注意点
使用github如果不太方便可以使用替换网站,如gitee、gitcode等。
update in gitee
codesnippets-c