多阶段构建

解释

在传统构建中,所有构建指令按顺序在单个构建容器中执行:下载依赖项、编译代码和打包应用程序。所有这些层最终都会出现在您的最终镜像中。这种方法有效,但会导致臃肿的镜像,会带来不必要的负担并增加您的安全风险。这就是多阶段构建发挥作用的地方。

多阶段构建在您的 Dockerfile 中引入了多个阶段,每个阶段都有特定的目的。可以将其视为在多个不同环境中同时运行构建的不同部分的能力。通过将构建环境与最终运行时环境分离,您可以显著减小镜像大小并减少攻击面。对于具有大量构建依赖项的应用程序来说,这尤其有利。

建议对所有类型的应用程序使用多阶段构建。

  • 对于解释性语言(如 JavaScript、Ruby 或 Python),您可以在一个阶段构建和压缩代码,并将生产就绪的文件复制到较小的运行时镜像中。这会优化您的镜像以进行部署。
  • 对于编译性语言(如 C、Go 或 Rust),多阶段构建允许您在一个阶段进行编译,并将编译后的二进制文件复制到最终的运行时镜像中。无需在最终镜像中捆绑整个编译器。

以下是用伪代码展示的多阶段构建结构的简化示例。请注意,存在多个 FROM 语句以及一个新的 AS <stage-name>。此外,第二阶段中的 COPY 语句是从上一个阶段 --from 复制的。

# Stage 1: Build Environment
FROM builder-image AS build-stage 
# Install build tools (e.g., Maven, Gradle)
# Copy source code
# Build commands (e.g., compile, package)

# Stage 2: Runtime environment
FROM runtime-image AS final-stage  
#  Copy application artifacts from the build stage (e.g., JAR file)
COPY --from=build-stage /path/in/build/stage /path/to/place/in/final/stage
# Define runtime configuration (e.g., CMD, ENTRYPOINT) 

此 Dockerfile 使用两个阶段

  • 构建阶段使用包含编译应用程序所需的构建工具的基本镜像。它包含安装构建工具、复制源代码和执行构建命令的命令。
  • 最终阶段使用更小的基本镜像,适合运行您的应用程序。它从构建阶段复制编译后的工件(例如 JAR 文件)。最后,它定义用于启动应用程序的运行时配置(使用 CMDENTRYPOINT)。

试一试

在本实践指南中,您将释放多阶段构建的强大功能,为示例 Java 应用程序创建精简高效的 Docker 镜像。您将使用基于 Maven 的简单“Hello World”Spring Boot 应用程序作为您的示例。

  1. 下载并安装 Docker Desktop。

  2. 打开此 预初始化项目 生成一个 ZIP 文件。以下是其外观

    A screenshot of Spring Initializr tool selected with Java 21, Spring Web and Spring Boot 3.3.0

    Spring Initializr 是 Spring 项目的快速入门生成器。它提供可扩展的 API 来生成基于 JVM 的项目,其中包含对几个常见概念的实现——例如 Java、Kotlin 和 Groovy 的基本语言生成。

    选择**生成**以创建并下载此项目的 zip 文件。

    对于此演示,您已将 Maven 构建自动化与 Java、Spring Web 依赖项和 Java 21 结合使用以获取元数据。

  3. 浏览项目目录。解压缩文件后,您将看到以下项目目录结构

    spring-boot-docker
    ├── Dockerfile
    ├── Dockerfile.multi
    ├── HELP.md
    ├── mvnw
    ├── mvnw.cmd
    ├── pom.xml
    └── src
        ├── main
        │   ├── java
        │   │   └── com
        │   │       └── example
        │   │           └── springbootdocker
        │   │               └── SpringBootDockerApplication.java
        │   └── resources
        │       ├── application.properties
        │       ├── static
        │       └── templates
        └── test
            └── java
                └── com
                    └── example
                        └── springbootdocker
                            └── SpringBootDockerApplicationTests.java
    
    15 directories, 9 files

    src/main/java 目录包含项目的源代码,src/test/java 目录
    包含测试源代码,pom.xml 文件是项目的项目对象模型 (POM)。

    pom.xml 文件是 Maven 项目配置的核心。它是一个单一的配置文件,
    包含构建自定义项目所需的大多数信息。POM 非常庞大,看起来
    很吓人。幸运的是,您还没有必要了解每个细节才能有效地使用它。

  4. 创建一个 RESTful Web 服务来显示“Hello World!”。

    src/main/java/com/example/springbootdocker/ 目录下,您可以修改您的
    SpringBootDockerApplication.java 文件,内容如下

    package com.example.springbootdocker;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    
    @RestController
    @SpringBootApplication
    public class SpringBootDockerApplication {
    
        @RequestMapping("/")
            public String home() {
            return "Hello World";
        }
    
    	public static void main(String[] args) {
    		SpringApplication.run(SpringBootDockerApplication.class, args);
    	}
    
    }

    SpringbootDockerApplication.java 文件首先声明您的 com.example.springbootdocker 包并导入必要的 Spring 框架。此 Java 文件创建一个简单的 Spring Boot Web 应用程序,当用户访问其主页时,它会以“Hello World”进行响应。

创建 Dockerfile

现在您有了项目,您可以创建 Dockerfile 了。

  1. 在包含所有其他文件夹和文件(如 src、pom.xml 等)的同一文件夹中创建一个名为 Dockerfile 的文件。

  2. Dockerfile 中,通过添加以下行定义基本镜像

    FROM eclipse-temurin:21.0.2_13-jdk-jammy
  3. 现在,使用 WORKDIR 指令定义工作目录。这将指定未来命令将在哪里运行以及将复制到容器镜像中的目录文件。

    WORKDIR /app
  4. 将 Maven 包装器脚本和项目的 pom.xml 文件复制到容器中的当前工作目录 /app 中。

    COPY .mvn/ .mvn
    COPY mvnw pom.xml ./
  5. 在容器中执行一个命令。它运行 ./mvnw dependency:go-offline 命令,该命令使用 Maven 包装器 (./mvnw) 下载项目的所有依赖项,而不会构建最终的 JAR 文件(这对加速构建很有用)。

    RUN ./mvnw dependency:go-offline
  6. 将主机上的项目中的 src 目录复制到容器中的 /app 目录。

    COPY src ./src
  7. 将容器启动时执行的默认命令设置为。此命令指示容器运行 Maven 包装器 (./mvnw) 以及 spring-boot:run 目标,这将构建并执行 Spring Boot 应用程序。

    CMD ["./mvnw", "spring-boot:run"]

    就这样,您应该有以下 Dockerfile

    FROM eclipse-temurin:21.0.2_13-jdk-jammy
    WORKDIR /app
    COPY .mvn/ .mvn
    COPY mvnw pom.xml ./
    RUN ./mvnw dependency:go-offline
    COPY src ./src
    CMD ["./mvnw", "spring-boot:run"]

构建容器镜像

  1. 执行以下命令来构建 Docker 镜像

    $ docker build -t spring-helloworld .
    
  2. 使用 docker images 命令查看 Docker 镜像的大小

    $ docker images
    

    这样做将产生如下输出

    REPOSITORY          TAG       IMAGE ID       CREATED          SIZE
    spring-helloworld   latest    ff708d5ee194   3 minutes ago    880MB
    

    此输出显示镜像大小为 880MB。它包含完整的 JDK、Maven 工具链等等。在生产环境中,您在最终镜像中不需要这些内容。

运行 Spring Boot 应用程序

  1. 现在您已构建了一个镜像,是时候运行容器了。

    $ docker run -d -p 8080:8080 spring-helloworld
    

    然后您将在容器日志中看到类似于以下的输出

    [INFO] --- spring-boot:3.3.0-M3:run (default-cli) @ spring-boot-docker ---
    [INFO] Attaching agents: []
     .   ____          _            __ _ _
     /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
     ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
     \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
     '  |____| .__|_| |_|_| |_\__, | / / / /
      =========|_|==============|___/=/_/_/_/
    
     :: Spring Boot ::             (v3.3.0-M3)
    
     2024-04-04T15:36:47.202Z  INFO 42 --- [spring-boot-docker] [           main]       
     c.e.s.SpringBootDockerApplication        : Starting SpringBootDockerApplication using Java    
     21.0.2 with PID 42 (/app/target/classes started by root in /app)
     ….
  2. 通过 Web 浏览器访问“Hello World”页面,地址为 https://127.0.0.1:8080,或者通过以下 curl 命令

    $ curl localhost:8080
    Hello World
    

使用多阶段构建

  1. 考虑以下 Dockerfile

    FROM eclipse-temurin:21.0.2_13-jdk-jammy AS builder
    WORKDIR /opt/app
    COPY .mvn/ .mvn
    COPY mvnw pom.xml ./
    RUN ./mvnw dependency:go-offline
    COPY ./src ./src
    RUN ./mvnw clean install
    
    FROM eclipse-temurin:21.0.2_13-jre-jammy AS final
    WORKDIR /opt/app
    EXPOSE 8080
    COPY --from=builder /opt/app/target/*.jar /opt/app/*.jar
    ENTRYPOINT ["java", "-jar", "/opt/app/*.jar"]

    请注意,此 Dockerfile 已拆分为两个阶段。

    • 第一阶段与之前的 Dockerfile 相同,提供了一个用于构建应用程序的 Java 开发工具包 (JDK) 环境。此阶段被称为 builder。

    • 第二阶段是一个名为 `final` 的新阶段。它使用一个更精简的 `eclipse-temurin:21.0.2_13-jre-jammy` 镜像,该镜像仅包含运行应用程序所需的 Java 运行时环境 (JRE)。此镜像提供了运行编译后的应用程序(JAR 文件)所需的 Java 运行时环境。

    对于生产环境使用,强烈建议您使用 jlink 生成一个自定义的 JRE 类运行时。所有版本的 Eclipse Temurin 都提供 JRE 镜像,但 `jlink` 可以让您创建一个仅包含应用程序所需 Java 模块的最小运行时。这可以显著减小最终镜像的大小并提高安全性。 请参阅此页面了解更多信息。

使用多阶段构建,Docker 构建使用一个基础镜像进行编译、打包和单元测试,然后使用另一个单独的镜像作为应用程序运行时。因此,最终镜像的大小会更小,因为它不包含任何开发或调试工具。通过将构建环境与最终运行时环境分离,您可以显著减小镜像大小并提高最终镜像的安全性。

  1. 现在,重新构建您的镜像并运行您的生产环境就绪的构建。

    $ docker build -t spring-helloworld-builder .
    

    此命令使用 `Dockerfile` 文件中位于当前目录的最终阶段构建名为 `spring-helloworld-builder` 的 Docker 镜像。

    注意

    在您的多阶段 Dockerfile 中,最终阶段(final)是构建的默认目标。这意味着,如果您没有使用 `docker build` 命令中的 `--target` 标志显式指定目标阶段,Docker 会默认自动构建最后一个阶段。您可以使用 `docker build -t spring-helloworld-builder --target builder .` 仅构建包含 JDK 环境的 builder 阶段。

  2. 使用 `docker images` 命令查看镜像大小差异

    $ docker images
    

    您将获得类似于以下的输出

    spring-helloworld-builder latest    c5c76cb815c0   24 minutes ago      428MB
    spring-helloworld         latest    ff708d5ee194   About an hour ago   880MB
    

    您的最终镜像只有 428 MB,而原始构建大小为 880 MB。

    通过优化每个阶段并仅包含必要的内容,您可以显著减小
    总体镜像大小,同时仍保持相同的功能。这不仅提高了性能,还
    使您的 Docker 镜像更轻量级、更安全、更易于管理。

附加资源