yaalalabs/maven-protobuf

docker-maven-protobuf 镜像文档

镜像概述

docker-maven-protobuf是一个集成了Maven和Google Protobuf的Docker镜像，旨在为开发者提供一站式的容器化开发环境，无需在本地系统单独安装配置Maven和Protobuf，即可直接进行项目构建和Protocol Buffers相关开发工作。

核心功能与特性

• 集成Maven：包含完整的Maven构建工具，支持Maven项目的编译、打包、依赖管理等标准操作。
• 集成Google Protobuf：内置Protobuf编译器（protoc）及相关工具，支持.proto文件的编译和代码生成。
• 环境预配置：镜像已预先配置好Maven和Protobuf的环境变量，开箱即可使用，减少环境配置时间。

使用场景

• 快速搭建Maven+Protobuf开发环境，避免本地环境依赖冲突。
• CI/CD流程中集成，用于自动化构建包含Protobuf定义的Maven项目。
• 多环境一致性保障，确保开发、测试、部署环境中Maven和Protobuf版本统一。

使用方法

基础使用（docker run）

通过以下命令运行容器，挂载本地项目目录并执行Maven构建：

bash
docker run -v /path/to/your/maven-project:/app -w /app docker-maven-protobuf mvn clean package

说明：

• -v /path/to/your/maven-project:/app：将本地Maven项目目录挂载到容器内的/app目录。
• -w /app：设置工作目录为/app，即项目根目录。
• mvn clean package：执行Maven清理并打包命令。

编译Protobuf文件

在容器内编译.proto文件：

bash
docker run -v /path/to/your/proto-files:/proto -w /proto docker-maven-protobuf protoc --java_out=. your_proto_file.proto

说明：

• -v /path/to/your/proto-files:/proto：挂载本地.proto文件所在目录到容器内的/proto目录。
• protoc --java_out=. your_proto_file.proto：使用protoc编译器将.proto文件编译为Java代码，输出到当前目录。

Docker Compose配置示例

创建docker-compose.yml文件，配置服务：

yaml
version: '3'
services:
  maven-protobuf:
    image: docker-maven-protobuf
    volumes:
      - ./maven-project:/app
    working_dir: /app
    command: mvn clean install

运行命令：

bash
docker-compose up