rvolosatovs/protoc

Protocol Buffers + Docker 镜像文档

镜像概述和主要用途

这是一个全面的Protocol Buffers (protoc) Docker镜像，最初基于znly/docker-protobuf分支开发，后发展为独立项目。镜像集成了丰富的Protobuf生态工具链，提供一站式环境，简化Protobuf文件的编译、代码生成、验证和文档生成等开发流程。

核心功能和特性

集成工具链

包含以下Protobuf相关工具和库（完整列表）：

• https://github.com/ckaznocha/protoc-gen-lint
• https://github.com/danielvladco/go-proto-gql
• https://github.com/dart-lang/protobuf
• https://github.com/envoyproxy/protoc-gen-validate
• https://github.com/mwitkow/go-proto-validators
• https://github.com/gogo/protobuf
• https://github.com/golang/protobuf
• https://github.com/google/protobuf
• https://github.com/grpc-ecosystem/grpc-gateway
• https://github.com/grpc/grpc
• https://github.com/grpc/grpc-go
• https://github.com/grpc/grpc-java
• https://github.com/grpc/grpc-swift
• https://github.com/grpc/grpc-web
• https://github.com/improbable-eng/ts-protoc-gen
• https://github.com/protobuf-c/protobuf-c
• https://github.com/pseudomuto/protoc-gen-doc
• https://github.com/stepancheg/grpc-rust
• https://github.com/stepancheg/rust-protobuf
• https://github.com/chrusty/protoc-gen-jsonschema

支持的语言

镜像支持为以下编程语言生成Protobuf代码：

• C
• C#
• C++
• Dart
• Go
• Java / JavaNano (Android)
• JavaScript
• Objective-C
• PHP
• Python
• Ruby
• Rust
• Swift
• TypeScript

使用场景和适用范围

适用于需要高效处理Protobuf协议的开发场景，包括：

• 跨语言微服务API定义与代码生成（如gRPC服务）
• 多平台数据交互协议开发（Android、Web、后端服务等）
• Protobuf文件的语法验证、代码规范检查（lint）
• 自动生成API文档（通过protoc-gen-doc等工具）

使用方法

基本命令格式

bash
docker run --rm -v<本地目录>:<容器内目录> -w<工作目录> rvolosatovs/protoc [选项] PROTO_FILES

参数说明

• --rm: 容器退出后自动删除，避免残留容器文件
• -v<本地目录>:<容器内目录>: 挂载本地目录到容器内，用于访问本地.proto文件（如-v$(pwd):/workspace挂载当前目录）
• -w<工作目录>: 设置容器内工作目录，建议与挂载的本地目录一致（如-w/workspace）
• [选项]: protoc命令的代码生成选项（如--go_out生成Go代码、--java_out生成Java代码等）
• PROTO_FILES: 待处理的.proto文件路径（相对于工作目录）

获取帮助

查看protoc命令完整帮助信息：

bash
docker run --rm rvolosatovs/protoc --help

典型使用示例

示例1：生成Go语言代码

假设本地/home/user/protos目录下有user.proto，生成Go代码到当前目录：

bash
docker run --rm -v/home/user/protos:/protos -w/protos rvolosatovs/protoc --go_out=. user.proto

执行后，/home/user/protos目录将生成Go代码文件（如user_go_proto.go）。

示例2：生成TypeScript代码

使用ts-protoc-gen生成TypeScript代码：

bash
docker run --rm -v$(pwd):/protos -w/protos rvolosatovs/protoc --ts_out=. api.proto