schottra/docker-protobufjs

docker-protobufjs

一个用于通过https://github.com/dcodeIO/protobuf.js%E7%94%9F%E6%88%90%E4%BB%A3%E7%A0%81%E7%9A%84Docker%E5%AE%B9%E5%99%A8%E9%95%9C%E5%83%8F%E3%80%82

本项目灵感来源于https://github.com/namely/docker-protoc%EF%BC%8C%E5%B9%B6%E5%9C%A8%E6%9F%90%E4%BA%9B%E6%96%B9%E9%9D%A2%E6%A8%A1%E4%BB%BF%E5%85%B6%E8%A1%8C%E4%B8%BA%E3%80%82

核心功能

• 通过protobuf.js的命令行工具（pbjs/pbts）生成JS和TS文件
• 支持传递几乎所有pbjs工具的参数，灵活控制输出格式
• 指定模块名生成对应名称的输出文件
• 可指定多个目录搜索.proto文件

使用场景

适用于需要将.proto文件转换为JS或TS代码的开发场景，例如：

• 前后端基于Protobuf的数据交互协议实现
• 微服务架构中跨服务的通信协议定义转换
• 客户端应用（Web/移动端）与服务端的协议对接开发

配置说明

使用容器的两个核心要求：

1. 必须将根protobuf目录挂载到容器内的/defs卷
2. 运行容器时必须指定--module-name参数，用于命名输出的JS和TS文件

基础示例

以下命令：

sh
docker run -v `pwd`:/defs docker.xuanyuan.run/schottra/docker-protobufjs:latest --module-name mymodule -d protos -- -t static-module -w es6

将处理./protos目录下所有.proto文件（非递归），生成静态ES6模块到/gen/pb-js/mymodule.js，同时生成TypeScript定义文件到/gen/pb-js/mymodule.d.ts。

注意：--之后的参数将转发给pbjs，可参考pbjs的https://github.com/dcodeIO/protobuf.js#command-line%E8%B0%83%E6%95%B4%E8%BE%93%E5%87%BA%E8%A1%8C%E4%B8%BA%E3%80%82

更多示例

处理多个目录并使用共享根包含路径：

sh
docker run -v `pwd`:/defs docker.xuanyuan.run/schottra/docker-protobufjs:latest --module-name mymodule -d protos/core -d protos/client -- -t static-module -w es6 -p /defs/protos

使用高级选项精简功能并设置根命名空间：

sh
docker run -v `pwd`:/defs docker.xuanyuan.run/schottra/docker-protobufjs:latest --module-name mymodule -d protos/core -d protos/client -- --root mymodule -t static-module -w es6 --no-delimited --force-long --no-convert

选项

容器行为控制选项：

    -d, --dir       指定一个或多个搜索.proto文件的目录；也可将单个文件名放在`--`后直接传递给pbjs
    --module-name   决定输出JS和TS文件的名称