如何为含公共模块的多模块gRPC微服务组织多阶段Dockerfile

我有一个gRPC微服务项目，结构如下：

- common（公共protobuf定义）
- microservices
  - ms1
    ..
  - msN

现在我想为每个微服务添加多阶段Dockerfile，但存在问题：构建其他项目必需的common模块，无法在微服务的Dockerfile中引用其外部源码。

我目前想到两种方案：

1. 在根目录使用一个Dockerfile构建所有镜像，示例代码如下：

FROM maven:3.8.6-eclipse-temurin-17 AS builder
COPY ./ /usr/app
RUN mvn -f /usr/app/pom.xml clean package


FROM eclipse-temurin:17-jre-alpine
COPY --from=builder /usr/app/microservices/ms1/target/ms1-1.0-SNAPSHOT.jar /usr/app/ms1-1.0-SNAPSHOT.jar
ENTRYPOINT ["java", "-jar", "/usr/app/ms1-1.0-SNAPSHOT.jar"]

但这种方式必须在构建镜像中编译整个项目。
2. 为构建环节创建单独的Docker镜像，在微服务Dockerfile中通过标签引用，但我不知道如何在构建微服务镜像时触发构建镜像的重建。

请问还有其他方案吗？我应该选择哪种方案？

方案三：Docker BuildKit多阶段依赖构建 #

利用Docker BuildKit的特性，先单独构建common模块的依赖产物，再在微服务的Dockerfile中直接引用该构建阶段，无需提前推送镜像到仓库。

操作步骤：

1. 在项目根目录创建Dockerfile.common，专门处理common模块的构建：

FROM maven:3.8.6-eclipse-temurin-17 AS common-builder
COPY ./common /usr/app/common
COPY ./pom.xml /usr/app/
# 仅安装common模块到本地Maven仓库，跳过测试以加快速度
RUN mvn -f /usr/app/common/pom.xml clean install -DskipTests

2. 在每个微服务（如ms1）的目录下编写独立的多阶段Dockerfile：

# 引用本地构建的common-builder阶段
FROM common-builder AS common-deps

FROM maven:3.8.6-eclipse-temurin-17 AS ms-builder
# 复制common的构建产物到当前构建环境的Maven仓库，确保微服务能找到依赖
COPY --from=common-deps /root/.m2/repository /root/.m2/repository
COPY ./microservices/ms1 /usr/app/ms1
COPY ./pom.xml /usr/app/
RUN mvn -f /usr/app/ms1/pom.xml clean package -DskipTests

FROM eclipse-temurin:17-jre-alpine
COPY --from=ms-builder /usr/app/ms1/target/ms1-1.0-SNAPSHOT.jar /usr/app/ms1.jar
ENTRYPOINT ["java", "-jar", "/usr/app/ms1.jar"]

3. 启用BuildKit构建微服务镜像，指定common的构建上下文：

DOCKER_BUILDKIT=1 docker build -t ms1:latest --build-context common-builder=../ .

也可以通过Docker Compose管理构建上下文，自动触发依赖的构建流程。

方案四：将common模块发布到Maven仓库 #

在构建微服务前，先把common模块编译并发布到本地Maven仓库（.m2目录）或私有Maven仓库，微服务构建时直接从仓库拉取依赖，无需复制common源码。

操作示例：

1. 本地开发时，先执行common模块的安装：

mvn -f common/pom.xml clean install

2. 微服务的Dockerfile只需复制自身源码和根pom即可打包：

FROM maven:3.8.6-eclipse-temurin-17 AS builder
COPY ./microservices/ms1 /usr/app/ms1
COPY ./pom.xml /usr/app/
RUN mvn -f /usr/app/ms1/pom.xml clean package -DskipTests

FROM eclipse-temurin:17-jre-alpine
COPY --from=builder /usr/app/ms1/target/ms1-1.0-SNAPSHOT.jar /usr/app/ms1.jar
ENTRYPOINT ["java", "-jar", "/usr/app/ms1.jar"]

CI/CD环境中，可先构建common并推送到私有仓库，微服务构建时指定仓库地址即可。

方案选择建议 #

• 小型项目/本地开发：优先选方案一（根目录单Dockerfile），配置简单，无需额外步骤，虽然每次要编译整个项目，但对小型项目影响可忽略。
• 中大型项目，需单独构建微服务：优先选方案三（BuildKit多阶段依赖构建），既不用编译全量代码，也不用维护额外镜像，能保证依赖一致性，构建速度更快。
• 有成熟CI/CD流程+私有Maven仓库：方案四是最优解，将common作为独立依赖管理，微服务构建完全解耦，符合模块化开发的最佳实践。

至于你提到的方案二，若要触发构建镜像重建，可在CI流程中给common镜像打唯一标签（如Git commit hash），微服务构建时引用该标签，通过CI的依赖关系自动触发common镜像更新，但这种方式需要维护标签规则和CI流程，复杂度较高，实用性不如方案三或四。

内容的提问来源于stack exchange，提问作者kodlan