|
对于最新的稳定版本，请使用 Spring Boot 3.4.0！ |
打包 OCI 映像
该插件可以使用 Cloud Native Buildpacks （CNB） 从 jar 或 war 文件创建 OCI 映像。
可以在命令行上使用build-image目标。
这可确保在创建映像之前运行包生命周期。
| 出于安全原因，映像以非 root 用户身份构建和运行。 有关更多详细信息，请参阅 CNB 规范。 |
最简单的入门方法是调用mvn spring-boot:build-image在项目中。
只要packagephase 调用，如以下示例所示：
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>build-image-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>用build-image-no-fork将目标绑定到 package 生命周期时。
此目标类似于build-image但不分叉生命周期以确保package已经运行。
在本节的其余部分，build-image用于指代build-image或build-image-no-fork目标。 |
虽然 buildpack 从可执行存档运行，但无需执行repackageGoal first，因为如有必要，会自动创建可执行存档。
当build-image重新打包应用程序，它会应用与repackage目标，即可以使用 Exclude 选项之一排除依赖项。
这spring-boot-devtools和spring-boot-docker-compose默认情况下，模块会自动排除（您可以使用excludeDevtools和excludeDockerCompose属性）。 |
Docker 守护程序
这build-imagegoal 需要访问 Docker 守护程序。
该目标将检查本地 Docker CLI 配置文件以确定当前上下文，并使用上下文连接信息与 Docker 守护程序通信。
如果无法确定当前上下文或上下文没有连接信息，则目标将使用默认的本地连接。
这适用于所有受支持的平台上的 Docker Engine，无需配置。
可以设置环境变量来配置build-image目标以使用备用本地或远程连接。
下表显示了环境变量及其值：
| 环境变量 | 描述 |
|---|---|
DOCKER_CONFIG |
用于确定当前上下文的 Docker CLI 配置文件的位置（默认为 |
DOCKER_CONTEXT |
应该用于从 Docker CLI 配置文件中检索主机信息的上下文的名称（覆盖 |
DOCKER_HOST |
包含 Docker 守护程序的主机和端口的 URL - 例如 |
DOCKER_TLS_VERIFY |
启用安全 HTTPS 协议（当设置为 |
DOCKER_CERT_PATH |
HTTPS 的证书和密钥文件的路径（如果满足以下条件，则需要 |
Docker 守护进程连接信息也可以使用docker参数。
下表总结了可用参数：
| 参数 | 描述 |
|---|---|
|
|
|
包含 Docker 守护程序的主机和端口的 URL - 例如 |
|
启用安全 HTTPS 协议（当设置为 |
|
HTTPS 的证书和密钥文件的路径（如果满足以下条件，则需要 |
|
什么时候 |
有关更多详细信息，另请参阅示例。
Docker 注册表
如果builder或runImage参数存储在需要身份验证的私有 Docker 镜像注册表中，可以使用docker.builderRegistry参数。
如果要将生成的 Docker 镜像发布到 Docker 镜像注册表，则可以使用docker.publishRegistry参数。
提供了用于用户身份验证或身份令牌身份验证的参数。 有关支持的身份验证方法的更多信息，请参阅用于存储映像的 Docker 注册表的文档。
下表总结了docker.builderRegistry和docker.publishRegistry:
| 参数 | 描述 |
|---|---|
|
Docker 镜像注册表用户的用户名。用户身份验证是必需的。 |
|
Docker 镜像注册表用户的密码。用户身份验证是必需的。 |
|
Docker 镜像注册表的地址。对于用户身份验证，可选。 |
|
Docker 镜像注册表用户的电子邮件地址。对于用户身份验证，可选。 |
|
Docker 镜像注册表用户的身份令牌。令牌身份验证是必需的。 |
有关更多详细信息，另请参阅示例。
图像自定义
该插件调用构建器来编排映像的生成。 构建器包含多个 buildpack，这些 buildpack 可以检查应用程序以影响生成的映像。 默认情况下，插件会选择一个构建器镜像。 生成的映像的名称是从项目属性中推导出来的。
这imageparameter 允许配置构建器及其在项目中的作方式。
下表总结了可用参数及其默认值：
| 参数 / （用户属性） | 描述 | 默认值 |
|---|---|---|
|
要使用的 Builder 映像的名称。 |
|
|
要使用的运行映像的名称。 |
无默认值，指示应使用生成器元数据中指定的运行映像。 |
|
生成的镜像的镜像名称。 |
|
|
用于确定何时从注册表中提取生成器和运行镜像的策略。
可接受的值为 |
|
|
应传递给生成器的环境变量。 |
|
|
构建者在构建镜像时应使用的 Buildpack。 将仅使用指定的 buildpack，覆盖构建器中包含的默认 buildpack。 Buildpack 引用必须采用以下形式之一：
|
None，表示构建器应使用其中包含的 buildpack。 |
|
在构建镜像时应挂载到构建器容器的卷绑定挂载。 在创建构建器容器时，绑定将未经解析和验证地传递给 Docker。 绑定必须采用以下形式之一：
哪里
|
|
|
生成器容器将配置为使用的网络驱动程序。 在创建构建器容器时，提供的值将在未经验证的情况下传递给 Docker。 |
|
|
是否在构建前清理缓存。 |
|
|
启用生成器作的详细日志记录。 |
|
|
是否将生成的镜像发布到 Docker 注册表。 |
|
|
要应用于生成的图像的一个或多个其他标记。
提供给 |
|
|
一个临时工作区，构建器和 buildpack 将使用它来在映像构建期间存储文件。 该值可以是命名卷或绑定挂载位置。 |
Docker 守护程序中的命名卷，其名称派生自映像名称。 |
|
包含由 buildpack 创建并由映像构建过程使用的层的缓存。 该值可以是命名卷或绑定挂载位置。 |
Docker 守护程序中的命名卷，其名称派生自映像名称。 |
|
包含由 buildpack 创建并由映像启动进程使用的层的缓存。 该值可以是命名卷或绑定挂载位置。 |
Docker 守护程序中的命名卷，其名称派生自映像名称。 |
|
将用于设置 |
启用构建可重现性的固定日期。 |
|
应用程序内容将在生成器映像中上传到的目录的路径。 应用程序内容也将位于生成的映像中的此位置。 |
|
|
将应用于生成器容器的安全选项，以字符串值数组的形式提供 |
|
该插件使用编译器的插件配置或maven.compiler.target财产。
当使用默认的 Paketo 构建器和 buildpack 时，该插件会指示 buildpack 安装相同的 Java 版本。
您可以覆盖此行为，如 builder 配置示例所示。 |
有关更多详细信息，另请参阅示例。
标签格式
提供给tags选项应为完整图像引用。
接受的格式为[domainHost:port/][path/]name[:tag][@digest].
如果缺少域，则默认为docker.io.
如果缺少路径，则默认为library.
如果缺少标签，则默认为latest.
一些例子：
-
my-image指向图像引用docker.io/library/my-image:latest -
my-repository/my-image导致docker.io/my-repository/my-image:latest -
example.com/my-repository/my-image:1.0.0将按原样使用
spring-boot:build-image
org.springframework.boot:spring-boot-maven-plugin:3.3.6
使用 buildpack 将应用程序打包到 OCI 映像中，分叉生命周期以确保package跑。此目标适用于命令行调用。如果您需要配置目标execution在您的构建中，使用build-image-no-fork相反。
可选参数
| 名字 | 类型 | 违约 |
|---|---|---|
|
||
|
|
|
|
|
|
|
||
|
||
|
|
|
|
|
|
|
||
|
||
|
|
参数详情
excludeDevtools
从重新打包的存档中排除 Spring Boot devtools。
名字 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
因为 |
|
excludeDockerCompose
从重新打包的存档中排除 Spring Boot 开发服务。
名字 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
因为 |
|
excludeGroupIds
要排除的 groupId 名称的逗号分隔列表（完全匹配）。
名字 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
因为 |
|
excludes
要排除的项目定义的集合。这Exclude元素定义 mandatorygroupId和artifactId组件和可选的classifier元件。当配置为属性时，值应使用冒号分隔的组件进行逗号分隔：groupId:artifactId,groupId:artifactId:classifier
名字 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
因为 |
|
image
Image configuration， 使用builder,runImage,name,env,cleanCache,verboseLogging,pullPolicy和publish选项。
名字 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
因为 |
|
includes
要包含的项目定义的集合。这Include元素定义 mandatorygroupId和artifactId组件和可选的classifier元件。当配置为属性时，值应使用冒号分隔的组件进行逗号分隔：groupId:artifactId,groupId:artifactId:classifier
名字 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
因为 |
|
layout
存档的类型（对应于其中依赖项的布局方式）。可能的值为JAR,WAR,ZIP,DIR,NONE.默认为基于存档类型的猜测。
名字 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
因为 |
|
spring-boot:build-image-no-fork
org.springframework.boot:spring-boot-maven-plugin:3.3.6
使用 buildpack 将应用程序打包到 OCI 映像中，但不分叉生命周期。配置目标时应使用此目标execution在你的构建中。要在命令行上调用目标，请使用build-image相反。
可选参数
| 名字 | 类型 | 违约 |
|---|---|---|
|
||
|
|
|
|
|
|
|
||
|
||
|
|
|
|
|
|
|
||
|
||
|
|
参数详情
excludeDevtools
从重新打包的存档中排除 Spring Boot devtools。
名字 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
因为 |
|
excludeDockerCompose
从重新打包的存档中排除 Spring Boot 开发服务。
名字 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
因为 |
|
excludeGroupIds
要排除的 groupId 名称的逗号分隔列表（完全匹配）。
名字 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
因为 |
|
excludes
要排除的项目定义的集合。这Exclude元素定义 mandatorygroupId和artifactId组件和可选的classifier元件。当配置为属性时，值应使用冒号分隔的组件进行逗号分隔：groupId:artifactId,groupId:artifactId:classifier
名字 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
因为 |
|
image
Image configuration， 使用builder,runImage,name,env,cleanCache,verboseLogging,pullPolicy和publish选项。
名字 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
因为 |
|
includes
要包含的项目定义的集合。这Include元素定义 mandatorygroupId和artifactId组件和可选的classifier元件。当配置为属性时，值应使用冒号分隔的组件进行逗号分隔：groupId:artifactId,groupId:artifactId:classifier
名字 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
因为 |
|
layout
存档的类型（对应于其中依赖项的布局方式）。可能的值为JAR,WAR,ZIP,DIR,NONE.默认为基于存档类型的猜测。
名字 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
因为 |
|
例子
自定义映像生成器
如果您需要自定义用于创建映像的生成器或用于启动构建映像的运行映像，请配置插件，如以下示例所示：
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<image>
<builder>mine/java-cnb-builder</builder>
<runImage>mine/java-cnb-run</runImage>
</image>
</configuration>
</plugin>
</plugins>
</build>
</project>此配置将使用名称为mine/java-cnb-builder和标签latest，并将名为mine/java-cnb-run和标签latest.
也可以在命令行上指定 builder 和 run image，如以下示例所示：
$ mvn spring-boot:build-image -Dspring-boot.build-image.builder=mine/java-cnb-builder -Dspring-boot.build-image.runImage=mine/java-cnb-runBuilder 配置
如果构建器使用环境变量公开配置选项，则可以使用env属性。
以下是在构建时配置 Paketo Java buildpack 使用的 JVM 版本的示例：
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<image>
<env>
<BP_JVM_VERSION>17</BP_JVM_VERSION>
</env>
</image>
</configuration>
</plugin>
</plugins>
</build>
</project>如果构建器运行的 Docker 守护进程与 buildpack 下载工件的网络位置之间存在网络代理，则需要将构建器配置为使用该代理。
使用 Paketo 构建器时，可以通过设置HTTPS_PROXY和/或HTTP_PROXY环境变量，如以下示例所示：
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<image>
<env>
<HTTP_PROXY>http://proxy.example.com</HTTP_PROXY>
<HTTPS_PROXY>https://proxy.example.com</HTTPS_PROXY>
</env>
</image>
</configuration>
</plugin>
</plugins>
</build>
</project>运行时 JVM 配置
Paketo Java buildpack 通过设置JAVA_TOOL_OPTIONS环境变量。
buildpack 提供的JAVA_TOOL_OPTIONS值，以自定义在容器中启动应用程序映像时的 JVM 运行时行为。
应存储在映像中并应用于每个部署的环境变量修改可以按照 Paketo 文档中所述进行设置，如以下示例所示：
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<image>
<env>
<BPE_DELIM_JAVA_TOOL_OPTIONS xml:space="preserve"> </BPE_DELIM_JAVA_TOOL_OPTIONS>
<BPE_APPEND_JAVA_TOOL_OPTIONS>-XX:+HeapDumpOnOutOfMemoryError</BPE_APPEND_JAVA_TOOL_OPTIONS>
</env>
</image>
</configuration>
</plugin>
</plugins>
</build>
</project>自定义镜像名称
默认情况下，镜像名称是从artifactId和version中，类似于docker.io/library/${project.artifactId}:${project.version}.
您可以控制名称，如以下示例所示：
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<image>
<name>example.com/library/${project.artifactId}</name>
</image>
</configuration>
</plugin>
</plugins>
</build>
</project>此配置不提供显式标记，因此latest被使用。
也可以指定标签，使用${project.version}、内部版本或硬编码版本中可用的任何属性。 |
也可以在命令行上指定映像名称，如以下示例所示：
$ mvn spring-boot:build-image -Dspring-boot.build-image.imageName=example.com/library/my-app:v1构建包
默认情况下，构建器将使用构建器镜像中包含的 buildpack，并按预定义的顺序应用它们。 可以提供一组替代的 buildpack 来应用未包含在构建器中的 buildpack，或更改包含的 buildpack 的顺序。 当提供一个或多个 buildpack 时，将仅应用指定的 buildpack。
以下示例指示构建器使用打包在.tgz文件，后跟构建器中包含的 buildpack。
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<image>
<buildpacks>
<buildpack>file:///path/to/example-buildpack.tgz</buildpack>
<buildpack>urn:cnb:builder:paketo-buildpacks/java</buildpack>
</buildpacks>
</image>
</configuration>
</plugin>
</plugins>
</build>
</project>Buildpack 可以采用下面显示的任何形式指定。
位于 CNB Builder 中的 buildpack（如果构建器中只有一个 buildpack 与buildpack-id):
-
urn:cnb:builder:buildpack-id -
urn:cnb:builder:[email protected] -
buildpack-id
包含 buildpack 内容的目录的路径（在 Windows 上不受支持）：
-
file:///path/to/buildpack/ -
/path/to/buildpack/
包含 buildpack 内容的 gzip 压缩 tar 文件的路径：
-
file:///path/to/buildpack.tgz -
/path/to/buildpack.tgz
包含打包的 buildpack 的 OCI 映像：
-
docker://example/buildpack -
docker:///example/buildpack:latest -
docker:///example/buildpack@sha256:45b23dee08… -
example/buildpack -
example/buildpack:latest -
example/buildpack@sha256:45b23dee08…
图像发布
生成的镜像可以通过启用publish选择。
如果 Docker 注册表需要身份验证，则可以使用docker.publishRegistry参数。
如果 Docker 注册表不需要身份验证，则docker.publishRegistryconfiguration 可以省略。
映像将发布到的注册表由映像名称的注册表部分 （docker.example.com在这些例子中）。
如果docker.publishRegistry凭证已配置并包括url参数，此值将传递给注册表，但不用于确定发布注册表位置。 |
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<image>
<name>docker.example.com/library/${project.artifactId}</name>
<publish>true</publish>
</image>
<docker>
<publishRegistry>
<username>user</username>
<password>secret</password>
</publishRegistry>
</docker>
</configuration>
</plugin>
</plugins>
</build>
</project>这publishoption 也可以在命令行上指定，如以下示例所示：
$ mvn spring-boot:build-image -Dspring-boot.build-image.imageName=docker.example.com/library/my-app:v1 -Dspring-boot.build-image.publish=true使用publish选项，您可以使用属性提供凭证，如以下示例所示：
$ mvn spring-boot:build-image \
-Ddocker.publishRegistry.username=user \
-Ddocker.publishRegistry.password=secret \
-Ddocker.publishRegistry.url=docker.example.com \
-Dspring-boot.build-image.publish=true \
-Dspring-boot.build-image.imageName=docker.example.com/library/my-app:v1并引用 XML 配置中的属性：
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<docker>
<publishRegistry>
<url>${docker.publishRegistry.url}</url>
<username>${docker.publishRegistry.username}</username>
<password>${docker.publishRegistry.password}</password>
</publishRegistry>
</docker>
</configuration>
</plugin>
</plugins>
</build>
</project>Builder 缓存和工作区配置
CNB 构建器缓存构建和启动映像时使用的层。 默认情况下，这些缓存作为命名卷存储在 Docker 守护程序中，其名称派生自目标映像的全名。 如果映像名称频繁更改，例如，当项目版本用作映像名称中的标记时，则缓存可能会频繁失效。
缓存卷可以配置为使用备用名称，以便更好地控制缓存生命周期，如以下示例所示：
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<image>
<buildCache>
<volume>
<name>cache-${project.artifactId}.build</name>
</volume>
</buildCache>
<launchCache>
<volume>
<name>cache-${project.artifactId}.launch</name>
</volume>
</launchCache>
</image>
</configuration>
</plugin>
</plugins>
</build>
</project>在映像构建期间，构建器和 buildpack 需要一个位置来存储临时文件。 默认情况下，此临时构建工作区存储在命名卷中。
缓存和构建工作区可以配置为使用绑定挂载而不是命名卷，如以下示例所示：
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<image>
<buildWorkspace>
<bind>
<source>/tmp/cache-${project.artifactId}.work</source>
</bind>
</buildWorkspace>
<buildCache>
<bind>
<source>/tmp/cache-${project.artifactId}.build</source>
</bind>
</buildCache>
<launchCache>
<bind>
<source>/tmp/cache-${project.artifactId}.launch</source>
</bind>
</launchCache>
</image>
</configuration>
</plugin>
</plugins>
</build>
</project>Docker 配置
minikube 的 Docker 配置
该插件可以与 minikube 提供的 Docker 守护进程通信，而不是默认的本地连接。
在 Linux 和 macOS 上，可以使用命令eval $(minikube docker-env)在 Minikube 启动后。
还可以通过提供类似于以下示例中所示的连接详细信息，将插件配置为使用 minikube 守护进程：
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<docker>
<host>tcp://192.168.99.100:2376</host>
<tlsVerify>true</tlsVerify>
<certPath>/home/user/.minikube/certs</certPath>
</docker>
</configuration>
</plugin>
</plugins>
</build>
</project>podman 的 Docker 配置
该插件可以与 podman 容器引擎通信。
通过提供类似于以下示例中所示的连接详细信息，可以将插件配置为使用 podman 本地连接：
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<docker>
<host>unix:///run/user/1000/podman/podman.sock</host>
<bindHostToBuilder>true</bindHostToBuilder>
</docker>
</configuration>
</plugin>
</plugins>
</build>
</project>使用colimaCLI 安装后，命令podman info --format='{{.Host.RemoteSocket.Path}}'可用于获取docker.hostconfiguration 属性。 |
Colima 的 Docker 配置
该插件可以与 Colima 提供的 Docker 守护程序通信。
这DOCKER_HOST可以使用以下命令设置环境变量：
$ export DOCKER_HOST=$(docker context inspect colima -f '{{.Endpoints.docker.Host}}')还可以通过提供类似于以下示例中所示的连接详细信息，将插件配置为使用 Colima 守护程序：
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<docker>
<host>unix:///${user.home}/.colima/docker.sock</host>
</docker>
</configuration>
</plugin>
</plugins>
</build>
</project>用于身份验证的 Docker 配置
如果构建器或运行镜像存储在支持用户身份验证的私有 Docker 注册表中，则可以使用docker.builderRegistry参数，如以下示例所示：
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<docker>
<builderRegistry>
<username>user</username>
<password>secret</password>
<url>https://docker.example.com/v1/</url>
<email>[email protected]</email>
</builderRegistry>
</docker>
</configuration>
</plugin>
</plugins>
</build>
</project>如果构建器或运行镜像存储在支持令牌身份验证的私有 Docker 注册表中，则可以使用docker.builderRegistry参数，如以下示例所示：
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<docker>
<builderRegistry>
<token>9cbaf023786cd7...</token>
</builderRegistry>
</docker>
</configuration>
</plugin>
</plugins>
</build>
</project>