uber/prototool

Prototool Docker镜像说明

镜像概述

Prototool是Protocol Buffers（Protobuf）开发的一站式工具，旨在解决protoc使用复杂、社区缺乏统一存根生成标准等痛点。它提供平台无关的protoc安装、标准化构建流程、代码风格检查与格式化等功能，帮助开发者高效处理Protobuf相关任务，确保团队内Protobuf文件的一致性。

核心功能

• 自动依赖管理：后台处理protoc安装及Well-Known Types导入，无需用户手动配置。
• 标准化构建：通过统一配置文件抽象protoc的复杂操作，简化Protobuf文件编译流程。
• 风格检查：支持Google、Uber V1/V2风格指南或自定义规则的Lint检查。
• 代码格式化：统一Protobuf文件格式，确保团队代码风格一致。
• 模板创建：从模板生成符合Lint规则的Protobuf文件，自动处理包命名。
• 存根生成：根据配置使用任意插件生成多语言存根（如Go、Java）。
• gRPC调用：简化gRPC端点调用，自动完成JSON与二进制格式转换。
• 编辑器集成：输出标准错误格式，支持Vim等编辑器实时检查。

使用场景

1. 团队协作：确保Protobuf文件风格一致，减少代码冲突。
2. 质量检查：快速验证Protobuf文件的语法正确性与风格合规性。
3. 存根生成：自动生成多语言存根，加速服务开发流程。
4. gRPC测试：无需编写客户端代码即可测试gRPC服务接口。
5. CI/CD集成：将Protobuf检查加入流水线，自动保障代码质量。

配置说明

Prototool使用prototool.yaml或prototool.json作为配置文件，推荐基础配置如下：

yaml
protoc:
  version: 3.7.0
lint:
  group: uber2

通过prototool config init命令可生成默认配置文件。配置文件所在目录会作为protoc的-I包含目录，建议在仓库根目录存放配置文件。

Docker部署示例

以下是常见操作的Docker命令示例：

1. Lint检查：

bash
docker run --rm -v $(pwd):/work uber/prototool lint

2. 格式化文件：

bash
docker run --rm -v $(pwd):/work uber/prototool format -w path/to/your.proto

3. 生成存根：

bash
docker run --rm -v $(pwd):/work uber/prototool generate

4. 调用gRPC端点：

bash
docker run --rm -v $(pwd):/work uber/prototool grpc idl/uber --address 0.0.0.0:8080 --method foo.ExcitedService/Exclamation --data '{"value":"hello"}'