此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Boot 3.4.0spring-doc.cn

打包 OCI 映像

该插件可以使用 Cloud Native Buildpacks (CNB) 从 jar 或 war 文件创建 OCI 映像。 可以使用 goal 在命令行上构建图像。 这可确保在创建映像之前运行包生命周期。build-imagespring-doc.cn

出于安全原因,映像以非 root 用户身份构建和运行。 有关更多详细信息,请参阅 CNB 规范

最简单的入门方法是在项目上调用 。 每当调用该阶段时,都可以自动创建映像,如以下示例所示:mvn spring-boot:build-imagepackagespring-doc.cn

<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-forkbuild-imagepackagebuild-imagebuild-imagebuild-image-no-fork
当 buildpack 从可执行存档运行时,无需先执行目标,因为如有必要,可执行存档会自动创建。 重新打包应用程序时,它会应用与目标相同的设置,即可以使用其中一个 exclude 选项排除依赖项。 默认情况下,会自动排除 and 模块(您可以使用 和 属性控制这一点)。repackagebuild-imagerepackagespring-boot-devtoolsspring-boot-docker-composeexcludeDevtoolsexcludeDockerCompose

Docker 守护程序

该目标需要访问 Docker 守护程序。 该目标将检查本地 Docker CLI 配置文件以确定当前上下文,并使用上下文连接信息与 Docker 守护程序通信。 如果无法确定当前上下文或上下文没有连接信息,则目标将使用默认的本地连接。 这适用于所有受支持的平台上的 Docker Engine,无需配置。build-imagespring-doc.cn

可以设置环境变量,以将目标配置为使用备用本地或远程连接。 下表显示了环境变量及其值:build-imagespring-doc.cn

环境变量 描述

DOCKER_CONFIGspring-doc.cn

用于确定当前上下文的 Docker CLI 配置文件的位置(默认为$HOME/.docker)spring-doc.cn

DOCKER_CONTEXTspring-doc.cn

应该用于从 Docker CLI 配置文件中检索主机信息的上下文的名称(覆盖DOCKER_HOST)spring-doc.cn

DOCKER_HOSTspring-doc.cn

包含 Docker 守护程序的主机和端口的 URL - 例如tcp://192.168.99.100:2376spring-doc.cn

DOCKER_TLS_VERIFYspring-doc.cn

当设置为 (optional) 时启用安全 HTTPS 协议1spring-doc.cn

DOCKER_CERT_PATHspring-doc.cn

HTTPS 的证书和密钥文件的路径(如果为 ,则为 required,否则为 ignored)DOCKER_TLS_VERIFY=1spring-doc.cn

也可以使用插件配置中的参数提供 Docker 守护程序连接信息。 下表总结了可用参数:dockerspring-doc.cn

参数 描述

contextspring-doc.cn

应用于从 Docker CLI 配置文件中检索主机信息的上下文的名称spring-doc.cn

hostspring-doc.cn

包含 Docker 守护程序的主机和端口的 URL - 例如tcp://192.168.99.100:2376spring-doc.cn

tlsVerifyspring-doc.cn

当设置为 (optional) 时启用安全 HTTPS 协议truespring-doc.cn

certPathspring-doc.cn

HTTPS 的证书和密钥文件的路径(如果为 is ,则为必需,否则为忽略)tlsVerifytruespring-doc.cn

bindHostToBuilderspring-doc.cn

当 时,将向为 CNB 生成器创建的容器提供该属性的值(可选)truehostspring-doc.cn

有关更多详细信息,另请参阅示例spring-doc.cn

Docker 注册表

如果 or 参数指定的 Docker 镜像存储在需要身份验证的私有 Docker 镜像注册表中,则可以使用参数提供身份验证凭证。builderrunImagedocker.builderRegistryspring-doc.cn

如果要将生成的 Docker 镜像发布到 Docker 镜像注册表,则可以使用参数提供身份验证凭证。docker.publishRegistryspring-doc.cn

提供了用于用户身份验证或身份令牌身份验证的参数。 有关支持的身份验证方法的更多信息,请参阅用于存储映像的 Docker 注册表的文档。spring-doc.cn

下表总结了 和 的可用参数:docker.builderRegistrydocker.publishRegistryspring-doc.cn

参数 描述

usernamespring-doc.cn

Docker 镜像注册表用户的用户名。用户身份验证是必需的。spring-doc.cn

passwordspring-doc.cn

Docker 镜像注册表用户的密码。用户身份验证是必需的。spring-doc.cn

urlspring-doc.cn

Docker 镜像注册表的地址。对于用户身份验证,可选。spring-doc.cn

emailspring-doc.cn

Docker 镜像注册表用户的电子邮件地址。对于用户身份验证,可选。spring-doc.cn

tokenspring-doc.cn

Docker 镜像注册表用户的身份令牌。令牌身份验证是必需的。spring-doc.cn

有关更多详细信息,另请参阅示例spring-doc.cn

图像自定义

该插件调用构建器来编排映像的生成。 构建器包含多个 buildpack,这些 buildpack 可以检查应用程序以影响生成的映像。 默认情况下,插件会选择一个构建器镜像。 生成的映像的名称是从项目属性中推导出来的。spring-doc.cn

该参数允许配置构建器以及它应该如何在项目中运行。 下表总结了可用参数及其默认值:imagespring-doc.cn

参数 / (用户属性) 描述 默认值

builder
(spring-boot.build-image.builder)spring-doc.cn

要使用的生成器映像的名称。spring-doc.cn

paketobuildpacks/builder-jammy-java-tiny:latestspring-doc.cn

trustBuilder
(spring-boot.build-image.trustBuilder)spring-doc.cn

是否将生成器视为受信任spring-doc.cn

true如果构建器是 、 、 、 否则。paketobuildpacks/builder-jammy-java-tinypaketobuildpacks/builder-noble-java-tinypaketobuildpacks/builder-jammy-tinypaketobuildpacks/builder-jammy-basepaketobuildpacks/builder-jammy-fullpaketobuildpacks/builder-jammy-buildpackless-tinypaketobuildpacks/builder-jammy-buildpackless-basepaketobuildpacks/builder-jammy-buildpackless-fullgcr.io/buildpacks/builderheroku/builderfalsespring-doc.cn

imagePlatform
(spring-boot.build-image.imagePlatform)spring-doc.cn

拉取的任何构建器、运行和 buildpack 镜像的平台 (操作系统和架构)。 必须采用 的形式,例如 、 或 。 请参阅正在使用的生成器的文档,以确定可用的映像操作系统和架构选项。OS[/architecture[/variant]]linux/amd64linux/arm64linux/arm/v5spring-doc.cn

无默认值,表示应使用主机的平台。spring-doc.cn

runImage
(spring-boot.build-image.runImage)spring-doc.cn

要使用的运行映像的名称。spring-doc.cn

无默认值,指示应使用生成器元数据中指定的运行映像。spring-doc.cn

name
(spring-boot.build-image.imageName)spring-doc.cn

生成的镜像的镜像名称spring-doc.cn

docker.io/library/
${project.artifactId}:${project.version}spring-doc.cn

pullPolicy
(spring-boot.build-image.pullPolicy)spring-doc.cn

用于确定何时从注册表中提取生成器和运行镜像的策略。 可接受的值为 、 和 。ALWAYSNEVERIF_NOT_PRESENTspring-doc.cn

ALWAYSspring-doc.cn

envspring-doc.cn

应传递给生成器的环境变量。spring-doc.cn

buildpacksspring-doc.cn

构建者在构建镜像时应使用的 Buildpack。 将仅使用指定的 buildpack,覆盖构建器中包含的默认 buildpack。 Buildpack 引用必须采用以下形式之一:spring-doc.cn

  • 构建器中的 buildpack -[urn:cnb:builder:]<buildpack ID>[@<version>]spring-doc.cn

  • Buildpack 位于文件系统上的目录中 -[file://]<path>spring-doc.cn

  • 文件系统上 gzip 压缩的 tar (.tgz) 文件中的 buildpack -[file://]<path>/<file name>spring-doc.cn

  • OCI 映像中的 Buildpack -[docker://]<host>/<repo>[:<tag>][@<digest>]spring-doc.cn

None,表示构建器应使用其中包含的 buildpack。spring-doc.cn

bindingsspring-doc.cn

在构建镜像时应挂载到构建器容器的卷绑定挂载。 在创建构建器容器时,绑定将未经解析和验证地传递给 Docker。 绑定必须采用以下形式之一:spring-doc.cn

  • <host source path>:<container destination path>[:<options>]spring-doc.cn

  • <host volume name>:<container destination path>[:<options>]spring-doc.cn

位置 可以包含:<options>spring-doc.cn

network + (spring-boot.build-image.network)spring-doc.cn

生成器容器将配置为使用的网络驱动程序。 在创建构建器容器时,提供的值将在未经验证的情况下传递给 Docker。spring-doc.cn

cleanCache + (spring-boot.build-image.cleanCache)spring-doc.cn

是否在构建前清理缓存。spring-doc.cn

falsespring-doc.cn

verboseLoggingspring-doc.cn

启用生成器操作的详细日志记录。spring-doc.cn

falsespring-doc.cn

publish + (spring-boot.build-image.publish)spring-doc.cn

是否将生成的镜像发布到 Docker 注册表。spring-doc.cn

falsespring-doc.cn

tagsspring-doc.cn

要应用于生成的图像的一个或多个其他标记。 提供给选项的值应为 full image references。 有关更多详细信息,请参阅 tags 部分tagsspring-doc.cn

buildWorkspacespring-doc.cn

一个临时工作区,构建器和 buildpack 将使用它来在映像构建期间存储文件。 该值可以是命名卷或绑定挂载位置。spring-doc.cn

Docker 守护程序中的命名卷,其名称派生自映像名称。spring-doc.cn

buildCachespring-doc.cn

包含由 buildpack 创建并由映像构建过程使用的层的缓存。 该值可以是命名卷或绑定挂载位置。spring-doc.cn

Docker 守护程序中的命名卷,其名称派生自映像名称。spring-doc.cn

launchCachespring-doc.cn

包含由 buildpack 创建并由映像启动进程使用的层的缓存。 该值可以是命名卷或绑定挂载位置。spring-doc.cn

Docker 守护程序中的命名卷,其名称派生自映像名称。spring-doc.cn

createdDate
(spring-boot.build-image.createdDate)spring-doc.cn

将用于在生成的图像元数据中设置字段的日期。 该值必须是 ISO 8601 即时格式的字符串,或者要使用当前日期和时间。Creatednowspring-doc.cn

启用构建可重现性的固定日期。spring-doc.cn

applicationDirectory
(spring-boot.build-image.applicationDirectory)spring-doc.cn

应用程序内容将在生成器映像中上传到的目录的路径。 应用程序内容也将位于生成的映像中的此位置。spring-doc.cn

/workspacespring-doc.cn

securityOptionsspring-doc.cn

将应用于生成器容器的安全选项,以字符串值数组的形式提供spring-doc.cn

["label=disable"]在 Linux 和 macOS 上, 在 Windows 上[]spring-doc.cn

该插件使用编译器的插件配置或属性来检测项目的目标 Java 兼容性。 当使用默认的 Paketo 构建器和 buildpack 时,该插件会指示 buildpack 安装相同的 Java 版本。 您可以覆盖此行为,如 builder 配置示例所示。maven.compiler.target

有关更多详细信息,另请参阅示例spring-doc.cn

标签格式

提供给选项的值应为 full image references。 接受的格式为 .tags[domainHost:port/][path/]name[:tag][@digest]spring-doc.cn

如果缺少域,则默认为 。 如果缺少路径,则默认为 。 如果缺少标记,则默认为 .docker.iolibrarylatestspring-doc.cn

一些例子:spring-doc.cn

  • my-image指向图像引用docker.io/library/my-image:latestspring-doc.cn

  • my-repository/my-image导致docker.io/my-repository/my-image:latestspring-doc.cn

  • example.com/my-repository/my-image:1.0.0将按原样使用spring-doc.cn

spring-boot:build-image

org.springframework.boot:spring-boot-maven-plugin:3.4.1-SNAPSHOTspring-doc.cn

使用 buildpack 将应用程序打包到 OCI 映像中,分叉生命周期以确保运行。此目标适用于命令行调用。如果您需要在构建中配置目标,请改用。packageexecutionbuild-image-no-forkspring-doc.cn

必需参数

名字 类型 违约

源目录spring-doc.cn

Filespring-doc.cn

${project.build.directory}spring-doc.cn

参数详情

classifier

查找源存档时使用的分类器。spring-doc.cn

名字spring-doc.cn

classifierspring-doc.cn

类型spring-doc.cn

java.lang.Stringspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

2.3.0spring-doc.cn

excludeDevtools

从重新打包的存档中排除 Spring Boot devtools。spring-doc.cn

名字spring-doc.cn

excludeDevtoolsspring-doc.cn

类型spring-doc.cn

booleanspring-doc.cn

默认值spring-doc.cn

truespring-doc.cn

用户属性spring-doc.cn

spring-boot.repackage.excludeDevtoolsspring-doc.cn

因为spring-doc.cn

1.3.0spring-doc.cn

excludeDockerCompose

从重新打包的存档中排除 Spring Boot 开发服务。spring-doc.cn

名字spring-doc.cn

excludeDockerComposespring-doc.cn

类型spring-doc.cn

booleanspring-doc.cn

默认值spring-doc.cn

truespring-doc.cn

用户属性spring-doc.cn

spring-boot.repackage.excludeDockerComposespring-doc.cn

因为spring-doc.cn

3.1.0spring-doc.cn

excludeGroupIds

要排除的 groupId 名称的逗号分隔列表(完全匹配)。spring-doc.cn

名字spring-doc.cn

excludeGroupIdsspring-doc.cn

类型spring-doc.cn

java.lang.Stringspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

spring-boot.excludeGroupIdsspring-doc.cn

因为spring-doc.cn

1.1.0spring-doc.cn

excludes

要排除的项目定义的集合。该元素定义 mandatory 和 components 以及 optional component。当配置为属性时,值应使用冒号分隔的组件进行逗号分隔:ExcludegroupIdartifactIdclassifiergroupId:artifactId,groupId:artifactId:classifierspring-doc.cn

名字spring-doc.cn

excludesspring-doc.cn

类型spring-doc.cn

java.util.Listspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

spring-boot.excludesspring-doc.cn

因为spring-doc.cn

1.1.0spring-doc.cn

image

图像配置,带有 、 和 选项。builderrunImagenameenvcleanCacheverboseLoggingpullPolicypublishspring-doc.cn

名字spring-doc.cn

imagespring-doc.cn

类型spring-doc.cn

org.springframework.boot.maven.Imagespring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

2.3.0spring-doc.cn

includeSystemScope

包括系统范围的依赖项。spring-doc.cn

名字spring-doc.cn

includeSystemScopespring-doc.cn

类型spring-doc.cn

booleanspring-doc.cn

默认值spring-doc.cn

falsespring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

1.4.0spring-doc.cn

includeTools

包括 JAR 工具。spring-doc.cn

名字spring-doc.cn

includeToolsspring-doc.cn

类型spring-doc.cn

booleanspring-doc.cn

默认值spring-doc.cn

truespring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

3.3.0spring-doc.cn

includes

要包含的项目定义的集合。该元素定义 mandatory 和 components 以及 optional component。当配置为属性时,值应使用冒号分隔的组件进行逗号分隔:IncludegroupIdartifactIdclassifiergroupId:artifactId,groupId:artifactId:classifierspring-doc.cn

名字spring-doc.cn

includesspring-doc.cn

类型spring-doc.cn

java.util.Listspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

spring-boot.includesspring-doc.cn

因为spring-doc.cn

1.2.0spring-doc.cn

layers

图层配置,其中包含用于禁用图层创建、排除图层工具 jar 和提供自定义图层配置文件的选项。spring-doc.cn

名字spring-doc.cn

layersspring-doc.cn

类型spring-doc.cn

org.springframework.boot.maven.Layersspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

2.3.0spring-doc.cn

layout

存档的类型(对应于其中依赖项的布局方式)。可能的值为 、 、 、 、 。默认为基于存档类型的猜测。JARWARZIPDIRNONEspring-doc.cn

名字spring-doc.cn

layoutspring-doc.cn

类型spring-doc.cn

org.springframework.boot.maven.AbstractPackagerMojo$LayoutTypespring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

2.3.11spring-doc.cn

layoutFactory

如果未设置显式布局,则将用于创建可执行存档的布局工厂。替代布局实现可由第三方提供。spring-doc.cn

名字spring-doc.cn

layoutFactoryspring-doc.cn

类型spring-doc.cn

org.springframework.boot.loader.tools.LayoutFactoryspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

2.3.11spring-doc.cn

loaderImplementation

应该使用的 loader 实现。spring-doc.cn

名字spring-doc.cn

loaderImplementationspring-doc.cn

类型spring-doc.cn

org.springframework.boot.loader.tools.LoaderImplementationspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

3.2.0spring-doc.cn

mainClass

主类的名称。如果未指定,则将使用找到的第一个包含方法的编译类。mainspring-doc.cn

名字spring-doc.cn

mainClassspring-doc.cn

类型spring-doc.cn

java.lang.Stringspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

1.0.0spring-doc.cn

skip

跳过执行。spring-doc.cn

名字spring-doc.cn

skipspring-doc.cn

类型spring-doc.cn

booleanspring-doc.cn

默认值spring-doc.cn

falsespring-doc.cn

用户属性spring-doc.cn

spring-boot.build-image.skipspring-doc.cn

因为spring-doc.cn

2.3.0spring-doc.cn

sourceDirectory

包含源存档的目录。spring-doc.cn

名字spring-doc.cn

sourceDirectoryspring-doc.cn

类型spring-doc.cn

java.io.Filespring-doc.cn

默认值spring-doc.cn

${project.build.directory}spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

2.3.0spring-doc.cn

spring-boot:build-image-no-fork

org.springframework.boot:spring-boot-maven-plugin:3.4.1-SNAPSHOTspring-doc.cn

使用 buildpack 将应用程序打包到 OCI 映像中,但不分叉生命周期。在构建中配置目标时,应使用此目标。要在命令行上调用目标,请改用。executionbuild-imagespring-doc.cn

必需参数

名字 类型 违约

源目录spring-doc.cn

Filespring-doc.cn

${project.build.directory}spring-doc.cn

参数详情

classifier

查找源存档时使用的分类器。spring-doc.cn

名字spring-doc.cn

classifierspring-doc.cn

类型spring-doc.cn

java.lang.Stringspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

2.3.0spring-doc.cn

excludeDevtools

从重新打包的存档中排除 Spring Boot devtools。spring-doc.cn

名字spring-doc.cn

excludeDevtoolsspring-doc.cn

类型spring-doc.cn

booleanspring-doc.cn

默认值spring-doc.cn

truespring-doc.cn

用户属性spring-doc.cn

spring-boot.repackage.excludeDevtoolsspring-doc.cn

因为spring-doc.cn

1.3.0spring-doc.cn

excludeDockerCompose

从重新打包的存档中排除 Spring Boot 开发服务。spring-doc.cn

名字spring-doc.cn

excludeDockerComposespring-doc.cn

类型spring-doc.cn

booleanspring-doc.cn

默认值spring-doc.cn

truespring-doc.cn

用户属性spring-doc.cn

spring-boot.repackage.excludeDockerComposespring-doc.cn

因为spring-doc.cn

3.1.0spring-doc.cn

excludeGroupIds

要排除的 groupId 名称的逗号分隔列表(完全匹配)。spring-doc.cn

名字spring-doc.cn

excludeGroupIdsspring-doc.cn

类型spring-doc.cn

java.lang.Stringspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

spring-boot.excludeGroupIdsspring-doc.cn

因为spring-doc.cn

1.1.0spring-doc.cn

excludes

要排除的项目定义的集合。该元素定义 mandatory 和 components 以及 optional component。当配置为属性时,值应使用冒号分隔的组件进行逗号分隔:ExcludegroupIdartifactIdclassifiergroupId:artifactId,groupId:artifactId:classifierspring-doc.cn

名字spring-doc.cn

excludesspring-doc.cn

类型spring-doc.cn

java.util.Listspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

spring-boot.excludesspring-doc.cn

因为spring-doc.cn

1.1.0spring-doc.cn

image

图像配置,带有 、 和 选项。builderrunImagenameenvcleanCacheverboseLoggingpullPolicypublishspring-doc.cn

名字spring-doc.cn

imagespring-doc.cn

类型spring-doc.cn

org.springframework.boot.maven.Imagespring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

2.3.0spring-doc.cn

includeSystemScope

包括系统范围的依赖项。spring-doc.cn

名字spring-doc.cn

includeSystemScopespring-doc.cn

类型spring-doc.cn

booleanspring-doc.cn

默认值spring-doc.cn

falsespring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

1.4.0spring-doc.cn

includeTools

包括 JAR 工具。spring-doc.cn

名字spring-doc.cn

includeToolsspring-doc.cn

类型spring-doc.cn

booleanspring-doc.cn

默认值spring-doc.cn

truespring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

3.3.0spring-doc.cn

includes

要包含的项目定义的集合。该元素定义 mandatory 和 components 以及 optional component。当配置为属性时,值应使用冒号分隔的组件进行逗号分隔:IncludegroupIdartifactIdclassifiergroupId:artifactId,groupId:artifactId:classifierspring-doc.cn

名字spring-doc.cn

includesspring-doc.cn

类型spring-doc.cn

java.util.Listspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

spring-boot.includesspring-doc.cn

因为spring-doc.cn

1.2.0spring-doc.cn

layers

图层配置,其中包含用于禁用图层创建、排除图层工具 jar 和提供自定义图层配置文件的选项。spring-doc.cn

名字spring-doc.cn

layersspring-doc.cn

类型spring-doc.cn

org.springframework.boot.maven.Layersspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

2.3.0spring-doc.cn

layout

存档的类型(对应于其中依赖项的布局方式)。可能的值为 、 、 、 、 。默认为基于存档类型的猜测。JARWARZIPDIRNONEspring-doc.cn

名字spring-doc.cn

layoutspring-doc.cn

类型spring-doc.cn

org.springframework.boot.maven.AbstractPackagerMojo$LayoutTypespring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

2.3.11spring-doc.cn

layoutFactory

如果未设置显式布局,则将用于创建可执行存档的布局工厂。替代布局实现可由第三方提供。spring-doc.cn

名字spring-doc.cn

layoutFactoryspring-doc.cn

类型spring-doc.cn

org.springframework.boot.loader.tools.LayoutFactoryspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

2.3.11spring-doc.cn

loaderImplementation

应该使用的 loader 实现。spring-doc.cn

名字spring-doc.cn

loaderImplementationspring-doc.cn

类型spring-doc.cn

org.springframework.boot.loader.tools.LoaderImplementationspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

3.2.0spring-doc.cn

mainClass

主类的名称。如果未指定,则将使用找到的第一个包含方法的编译类。mainspring-doc.cn

名字spring-doc.cn

mainClassspring-doc.cn

类型spring-doc.cn

java.lang.Stringspring-doc.cn

默认值spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

1.0.0spring-doc.cn

skip

跳过执行。spring-doc.cn

名字spring-doc.cn

skipspring-doc.cn

类型spring-doc.cn

booleanspring-doc.cn

默认值spring-doc.cn

falsespring-doc.cn

用户属性spring-doc.cn

spring-boot.build-image.skipspring-doc.cn

因为spring-doc.cn

2.3.0spring-doc.cn

sourceDirectory

包含源存档的目录。spring-doc.cn

名字spring-doc.cn

sourceDirectoryspring-doc.cn

类型spring-doc.cn

java.io.Filespring-doc.cn

默认值spring-doc.cn

${project.build.directory}spring-doc.cn

用户属性spring-doc.cn

因为spring-doc.cn

2.3.0spring-doc.cn

例子

自定义映像生成器

如果您需要自定义用于创建映像的生成器或用于启动构建映像的运行映像,请配置插件,如以下示例所示:spring-doc.cn

<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>

此配置将使用具有 name 和 tag 的生成器映像,以及名为 和 tag 的运行映像。mine/java-cnb-builderlatestmine/java-cnb-runlatestspring-doc.cn

也可以在命令行上指定 builder 和 run image,如以下示例所示:spring-doc.cn

$ mvn spring-boot:build-image -Dspring-boot.build-image.builder=mine/java-cnb-builder -Dspring-boot.build-image.runImage=mine/java-cnb-run

Builder 配置

如果生成器使用环境变量公开配置选项,则可以使用 attributes 设置这些选项。envspring-doc.cn

以下是在构建时配置 Paketo Java buildpack 使用的 JVM 版本的示例:spring-doc.cn

<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 构建器时,可以通过设置 and/or 环境变量来实现,如以下示例所示:HTTPS_PROXYHTTP_PROXYspring-doc.cn

<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 通过设置环境变量来配置 JVM 运行时环境。 可以修改 buildpack-provided 值,以自定义在容器中启动应用程序映像时的 JVM 运行时行为。JAVA_TOOL_OPTIONSJAVA_TOOL_OPTIONSspring-doc.cn

应存储在映像中并应用于每个部署的环境变量修改可以按照 Paketo 文档中所述进行设置,如以下示例所示:spring-doc.cn

<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>

自定义镜像名称

默认情况下,映像名称是从项目的 和 中推断出来的,类似于 . 您可以控制名称,如以下示例所示:artifactIdversiondocker.io/library/${project.artifactId}:${project.version}spring-doc.cn

<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}

也可以在命令行上指定映像名称,如以下示例所示:spring-doc.cn

$ mvn spring-boot:build-image -Dspring-boot.build-image.imageName=example.com/library/my-app:v1

构建包

默认情况下,构建器将使用构建器镜像中包含的 buildpack,并按预定义的顺序应用它们。 可以提供一组替代的 buildpack 来应用未包含在构建器中的 buildpack,或更改包含的 buildpack 的顺序。 当提供一个或多个 buildpack 时,将仅应用指定的 buildpack。spring-doc.cn

以下示例指示构建器使用打包在文件中的自定义 buildpack,后跟构建器中包含的 buildpack。.tgzspring-doc.cn

<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 可以采用下面显示的任何形式指定。spring-doc.cn

位于 CNB Builder 中的 buildpack(如果构建器中只有一个 buildpack 与 ):buildpack-idspring-doc.cn

包含 buildpack 内容的目录的路径(在 Windows 上不受支持):spring-doc.cn

包含 buildpack 内容的 gzip 压缩 tar 文件的路径:spring-doc.cn

包含打包的 buildpack 的 OCI 映像:spring-doc.cn

图像发布

通过启用选项,可以将生成的映像发布到 Docker 注册表。publishspring-doc.cn

如果 Docker 注册表需要身份验证,则可以使用参数配置凭据。 如果 Docker 注册表不需要身份验证,则可以省略配置。docker.publishRegistrydocker.publishRegistryspring-doc.cn

映像将发布到的注册表由映像名称的注册表部分确定(在这些示例中为 )。 如果配置了凭据并包含参数,则此值将传递到注册表,但不用于确定发布注册表位置。docker.example.comdocker.publishRegistryurl
<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>

也可以在命令行上指定该选项,如以下示例所示:publishspring-doc.cn

$ mvn spring-boot:build-image -Dspring-boot.build-image.imageName=docker.example.com/library/my-app:v1 -Dspring-boot.build-image.publish=true

在命令行上使用 authentication 选项时,您可以使用 properties 提供凭证,如下例所示:publishspring-doc.cn

$ 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 配置中的属性:spring-doc.cn

<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 守护程序中,其名称派生自目标映像的全名。 如果映像名称频繁更改,例如,当项目版本用作映像名称中的标记时,则缓存可能会频繁失效。spring-doc.cn

缓存卷可以配置为使用备用名称,以便更好地控制缓存生命周期,如以下示例所示:spring-doc.cn

<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 需要一个位置来存储临时文件。 默认情况下,此临时构建工作区存储在命名卷中。spring-doc.cn

缓存和构建工作区可以配置为使用绑定挂载而不是命名卷,如以下示例所示:spring-doc.cn

<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 守护进程通信,而不是默认的本地连接。spring-doc.cn

在 Linux 和 macOS 上,可以在 minikube 启动后使用命令设置环境变量。eval $(minikube docker-env)spring-doc.cn

还可以通过提供类似于以下示例中所示的连接详细信息,将插件配置为使用 minikube 守护进程:spring-doc.cn

<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 容器引擎通信。spring-doc.cn

通过提供类似于以下示例中所示的连接详细信息,可以将插件配置为使用 podman 本地连接:spring-doc.cn

<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>
安装 CLI 后,该命令可用于获取本示例所示的 configuration 属性的值。colimapodman info --format='{{.Host.RemoteSocket.Path}}'docker.host

Colima 的 Docker 配置

该插件可以与 Colima 提供的 Docker 守护程序通信。 可以使用以下命令设置环境变量:DOCKER_HOSTspring-doc.cn

$ export DOCKER_HOST=$(docker context inspect colima -f '{{.Endpoints.docker.Host}}')

还可以通过提供类似于以下示例中所示的连接详细信息,将插件配置为使用 Colima 守护程序:spring-doc.cn

<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.builderRegistryspring-doc.cn

<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.builderRegistryspring-doc.cn

<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>