Docker化Spring Boot微服务时如何处理公共模块问题

问题原因 #

构建auth-service时出现包找不到的错误，是因为Docker构建过程中，微服务无法正确获取到common模块的编译依赖——虽然你尝试安装了common，但构建上下文或Maven依赖解析的步骤存在问题，导致微服务编译时找不到common的类。

解决方案 #

方案一：修改Dockerfile确保common被正确安装 #

针对auth-service的Dockerfile，调整构建步骤，确保common模块先被安装到Maven本地仓库，再构建微服务：

FROM maven:3.9.7-eclipse-temurin-21-alpine AS build
WORKDIR /app

# 复制整个项目根目录内容（包含common和auth-service）
COPY . .

# 先安装common模块到Maven本地仓库
RUN mvn -f common/pom.xml clean install -DskipTests

# 构建auth-service
RUN mvn -f auth-service/pom.xml clean package -DskipTests

FROM openjdk:21-jdk
WORKDIR /app

# 复制构建好的auth-service jar包
COPY --from=build /app/auth-service/target/*.jar app.jar

EXPOSE 8082
ENTRYPOINT ["java", "-jar", "app.jar"]

同时，修改docker-compose.yml中其他依赖common的服务（discovery、gateway）的构建配置，将context设为根目录，确保Docker能访问到common模块：

api-discovery:
    build:
      context: .
      dockerfile: discovery/Dockerfile
    networks:
      - gym-tracker

api-gateway:
    build:
      context: .
      dockerfile: gateway/Dockerfile
    ports:
      - "8080:8080"
    depends_on:
      - api-discovery
    networks:
      - gym-tracker

对应的discovery/Dockerfile可以参考auth-service的写法：

FROM maven:3.9.7-eclipse-temurin-21-alpine AS build
WORKDIR /app

COPY . .
RUN mvn -f common/pom.xml clean install -DskipTests
RUN mvn -f discovery/pom.xml clean package -DskipTests

FROM openjdk:21-jdk
WORKDIR /app
COPY --from=build /app/discovery/target/*.jar app.jar

EXPOSE 8761
ENTRYPOINT ["java", "-jar", "app.jar"]

方案二：使用Maven多模块父项目（更简洁） #

在项目根目录创建父pom.xml，统一管理所有模块，简化构建流程：

根目录/pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.gym.tracker</groupId>
    <artifactId>gym-tracker-parent</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <modules>
        <module>common</module>
        <module>discovery</module>
        <module>gateway</module>
        <module>auth-service</module>
    </modules>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.2.0</version> <!-- 替换为你的Spring Boot版本 -->
        <relativePath/>
    </parent>

    <properties>
        <maven.compiler.source>21</maven.compiler.source>
        <maven.compiler.target>21</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
</project>

common/pom.xml添加父模块引用：

<parent>
    <groupId>com.gym.tracker</groupId>
    <artifactId>gym-tracker-parent</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</parent>

auth-service/pom.xml添加父模块引用，并简化common依赖：

<parent>
    <groupId>com.gym.tracker</groupId>
    <artifactId>gym-tracker-parent</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</parent>

<!-- ... 其他配置 ... -->
<dependencies>
    <dependency>
        <groupId>com.gym.tracker</groupId>
        <artifactId>common</artifactId>
    </dependency>
    <!-- ... 其他依赖 ... -->
</dependencies>

然后修改auth-service的Dockerfile：

FROM maven:3.9.7-eclipse-temurin-21-alpine AS build
WORKDIR /app

COPY . .

# 只构建auth-service及其依赖的模块（自动包含common）
RUN mvn clean package -DskipTests -pl auth-service -am

FROM openjdk:21-jdk
WORKDIR /app
COPY --from=build /app/auth-service/target/*.jar app.jar

EXPOSE 8082
ENTRYPOINT ["java", "-jar", "app.jar"]

这种方式下，Maven会自动处理模块间的依赖顺序，无需手动安装common，构建更高效。

关键检查点 #

• 确保每个微服务的pom.xml中，common模块的groupId、artifactId、version与common/pom.xml完全一致。
• 所有依赖common的微服务，Docker构建上下文必须设为项目根目录，否则Docker无法访问common模块的代码。

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