多阶段构建

目录

解释

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

多阶段构建在您的 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 文件）。最后，它定义了启动应用程序的运行时配置（使用CMD或ENTRYPOINT）。

试一试

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

  1. 下载并安装 Docker Desktop。

  2. 打开此 预初始化项目 来生成一个 ZIP 文件。以下是它的样子

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

    Spring Initializr 是 Spring 项目的快速启动生成器。它提供可扩展的 API，可以使用多种常见概念的实现来生成基于 JVM 的项目——例如为 Java、Kotlin 和 Groovy 生成基本语言。

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

    在此演示中，您已将 Maven 构建自动化与 Java、Spring Web 依赖项和 Java 21 配对用于您的元数据。

  3. 导航到项目目录。解压缩文件后，您将看到以下项目目录结构

    spring-boot-docker
├── HELP.md
├── mvnw
├── mvnw.cmd
├── pom.xml
└── src
    ├── main
    │   ├── java
    │   │   └── com
    │   │       └── example
    │   │           └── spring_boot_docker
    │   │               └── SpringBootDockerApplication.java
    │   └── resources
    │       ├── application.properties
    │       ├── static
    │       └── templates
    └── test
        └── java
            └── com
                └── example
                    └── spring_boot_docker
                        └── SpringBootDockerApplicationTests.java

15 directories, 7 files

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

    pom.xml文件是 Maven 项目配置的核心。它是一个单一的配置文件，
    包含构建自定义项目所需的大部分信息。POM 很大，看起来可能
    令人生畏。值得庆幸的是，您现在无需了解每一个细节即可有效地使用它。

  4. 创建一个显示“Hello World！”的 RESTful 网络服务。

    在src/main/java/com/example/spring_boot_docker/目录下，您可以使用以下内容修改您的
    SpringBootDockerApplication.java文件

    package com.example.spring_boot_docker;

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.spring_boot_docker包并导入必要的 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. 设置容器启动时要执行的默认命令。此命令指示容器使用spring-boot:run目标运行 Maven 包装器 (./mvnw)，这将构建并执行您的 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.4:run (default-cli) @ spring-boot-docker ---
[INFO] Attaching agents: []

     .   ____          _            __ _ _
    /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
   ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
    \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
     '  |____| .__|_| |_|_| |_\__, | / / / /
    =========|_|==============|___/=/_/_/_/

    :: Spring Boot ::                (v3.3.4)

2024-09-29T23:54:07.157Z  INFO 159 --- [spring-boot-docker] [           main]
c.e.s.SpringBootDockerApplication        : Starting SpringBootDockerApplication using Java
21.0.2 with PID 159 (/app/target/classes started by root in /app)
 ….

  2. 通过 Web 浏览器访问您的“Hello World”页面，网址为 http://localhost: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)。此镜像提供的 Java 运行时环境 (JRE) 足以运行编译后的应用程序 (JAR 文件)。

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

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

  2. 现在，重新构建您的镜像并运行您已准备好的生产版本。

    $ 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 阶段。

  3. 使用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 镜像更轻量级、更安全、更易于管理。

其他资源