PowerProto: gRPC工具链(protoc, protoc-gen-go)的一键安装与版本控制

中文 | English

项目地址：🎉 An awesome version control tool for protoc and its related plugins. (github.com/storyicon/powerproto)

PowerProto主要用于解决下面三个问题：

1. 降低gRPC的使用门槛与使用成本。
2. 解决protoc以及其相关插件（比如protoc-gen-go、protoc-gen-grpc-gateway）的版本控制问题。
3. 高效管理proto的编译，实现多平台兼容、一键安装与编译。

🎉 功能

1. 实现protoc的一键安装与多版本管理。
2. 实现protoc相关插件（比如protoc-gen-go）的一键安装与多版本管理。
3. 通过配置文件管理proto的编译，而非shell脚本，提高可读性与兼容性。
4. 引导式生成配置文件，跨平台兼容，一份配置在多个平台均可以实现一键编译。
5. 支持批量、递归编译proto文件，提高效率。
6. 跨平台支持PostAction，可以在编译完成之后执行一些常规操作（比如替换掉所有生成文件中的"omitempty"）。
7. 支持PostShell，在编译完成之后执行特定的shell脚本。
8. 支持 google api, gogo protobuf 等的一键安装与版本控制。

安装与依赖

1. 目前版本的 PowerProto 依赖 go(>=1.16) 以及 git（未来可能会直接使用CDN拉取构建好的二进制），请确保运行环境中包含这两个命令。
2. protoc的下载源是Github，PowerProto在下载protoc时尊重 HTTP_PROXY、HTTPS_PROXY环境变量，如果遇到网络问题，请自行配置代理。
3. 在查询protoc的版本列表时，会对github.com使用git ls-remote，如果遇到网络问题，请自行为git配置代理。
4. 在当前版本，下载和查询插件版本均依赖go命令，所以如果遇到网络问题，请自行配置 GOPROXY环境变量。
5. 默认会使用 用户目录/.powerproto作为安装目录，用于放置下载好的各种插件以及全局配置，可以通过 POWERPROTO_HOME环境变量来修改安装目录。
6. 如果认为powerproto名字太长，可以通过alias成一个更简单的名字来提高输入效率，比如没有人会介意你叫它pp。

一、通过Go进行安装

直接执行下面的命令即可进行安装：

go install github.com/storyicon/powerproto/cmd/powerproto@latest

二、开箱即用版本

可以通过 Github Release Page 下载开箱即用版本。

命令介绍

你可以通过 powerproto -h 来查看帮助，比如：

powerproto -h
powerproto init -h
powerproto tidy -h
powerproto build -h
powerproto env -h

它的好处是命令行中的文档永远和你的二进制版本保持一致。而Github上的文档可能会一直是对应最新的二进制。

一、初始化配置

可以通过下面的命令进行配置的初始化：

powerproto init

二、整理配置

可以通过下面的命令整理配置：

powerproto tidy

它将会从当前目录开始向父级目录搜索名为 powerproto.yaml 的配置文件，并对配置进行读取和整理。

你也可以指定整理哪个配置文件：

powerproto tidy [the path of proto file]

整理配置主要包含两个操作：

1. 通过查询，将版本中的latest替换为真实的最新版本号。
2. 安装配置文件中定义的所有依赖。

支持通过 -d 参数来进入到debug模式，查看更详细的日志。

三、编译Proto文件

可以通过下面的命令进行Proto文件的编译：

// 编译指定的proto文件
powerproto build xxxx.proto

// 编译当前目录下的所有proto文件
powerproto build .

// 递归编译当前目录下的所有proto文件，包括子文件夹。
powerproto build -r .

其执行逻辑是，对于每一个proto文件，从其文件所在目录开始向父级目录寻找 powerproto.yaml 配置文件:

1. 对于找到的配置文件，与其中的scope进行匹配，如果匹配则采用。
2. 检查并安装配置文件中声明的依赖。
3. 根据配置文件中的plugins、protoc