打包可执行存档文件 (Packaging Executable Archives) _ Spring Boot3.4.0-SNAPSHOT中文文档(官方文档中文翻译)|Spring 教程 —

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

该插件可以创建包含应用程序的所有依赖项的可执行存档（jar 文件和 war 文件），然后可以使用 .java -jarspring-doc.cn

打包可执行存档由 goal 执行，如以下示例所示：repackagespring-doc.cn

<build>
	<plugins>
		<plugin>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-maven-plugin</artifactId>
			<executions>
				<execution>
					<goals>
						<goal>repackage</goal>
					</goals>
				</execution>
			</executions>
		</plugin>
	</plugins>
</build>

该目标不应在命令行上单独使用，因为它在阶段生成的源（或）上运行。要在命令行上使用此目标，必须包含阶段：。repackagejarwarpackagepackagemvn package spring-boot:repackage

如果您使用的是，则此类执行已预先配置了执行 ID，因此只应添加插件定义。spring-boot-starter-parentrepackage

上面的示例重新打包了在 Maven 生命周期的包阶段构建的 or 存档，包括项目中定义的任何依赖项。如果需要排除其中一些依赖项，您可以使用以下选项之一;有关更多详细信息，请参阅依赖项排除。jarwarprovidedexcludespring-doc.cn

默认情况下，原始（即不可执行）构件已重命名，但也可以使用自定义分类器保留原始构件。.originalspring-doc.cn

目前不支持的功能。outputFileNameMappingmaven-war-plugin

默认情况下，会自动排除 and 模块（您可以使用和属性控制这一点）。为了使它与打包一起工作，必须将 and dependencies 设置为 scope 或 with the scope。spring-boot-devtoolsspring-boot-docker-composeexcludeDevtoolsexcludeDockerComposewarspring-boot-devtoolsspring-boot-docker-composeoptionalprovidedspring-doc.cn

该插件会重写您的清单，特别是它管理 and 条目。如果默认值不起作用，则必须在 Spring Boot 插件中配置值，而不是在 jar 插件中配置值。清单中的由 Spring Boot 插件的属性控制，如以下示例所示：Main-ClassStart-ClassMain-Classlayoutspring-doc.cn

<build>
	<plugins>
		<plugin>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-maven-plugin</artifactId>
			<configuration>
				<mainClass>${start.class}</mainClass>
				<layout>ZIP</layout>
			</configuration>
			<executions>
				<execution>
					<goals>
						<goal>repackage</goal>
					</goals>
				</execution>
			</executions>
		</plugin>
	</plugins>
</build>

该属性默认为由存档类型（或）确定的值。以下布局可用：layoutjarwarspring-doc.cn

JAR：常规可执行 JAR 布局。spring-doc.cn
WAR：可执行的 WAR 布局。放置依赖项以避免在 servlet 容器中部署时发生任何冲突。providedWEB-INF/lib-providedwarspring-doc.cn
ZIP（别名为）：类似于使用的布局。DIRJARPropertiesLauncherspring-doc.cn
NONE：捆绑所有依赖项和项目资源。不捆绑 bootstrap 加载程序。spring-doc.cn

如果您使用的是，则此类执行已预先配置了执行 ID，因此只应添加插件定义。spring-boot-starter-parentrepackage

目前不支持的功能。outputFileNameMappingmaven-war-plugin

分层 Jar 或 War

重新打包的 jar 分别包含和中的应用程序的类和依赖项。同样，可执行 war 包含应用程序的类 in 和依赖项 in 和。对于需要从 jar 或 war 的内容构建 docker 镜像的情况，能够进一步分离这些目录以便将它们写入不同的层非常有用。BOOT-INF/classesBOOT-INF/libWEB-INF/classesWEB-INF/libWEB-INF/lib-providedspring-doc.cn

分层存档使用与常规重新打包的 jar 或 war 相同的布局，但包含一个描述每个层的附加元数据文件。spring-doc.cn

默认情况下，定义了以下图层：spring-doc.cn

dependencies对于其版本不包含 .SNAPSHOTspring-doc.cn
spring-boot-loader对于加载器类。spring-doc.cn
snapshot-dependencies对于其版本包含 .SNAPSHOTspring-doc.cn
application对于本地模块依赖项、应用程序类和资源。spring-doc.cn

通过查看属于当前版本的所有模块来识别模块依赖项。如果模块依赖项只能因为它已安装到 Maven 的本地缓存中并且它不是当前构建的一部分而得到解决，则它将被标识为常规依赖项。spring-doc.cn

层顺序非常重要，因为它决定了当应用程序的一部分发生更改时，可以缓存先前层的可能性。默认顺序为，，，。应首先添加最不可能更改的内容，然后添加更有可能更改的图层。dependenciesspring-boot-loadersnapshot-dependenciesapplicationspring-doc.cn

默认情况下，重新打包的存档包含该文件。要禁用此功能，您可以通过以下方式执行此操作：layers.idxspring-doc.cn

<project>
	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<configuration>
					<layers>
						<enabled>false</enabled>
					</layers>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>

自定义图层配置

根据您的应用程序，您可能希望调整层的创建方式并添加新层。这可以使用一个单独的配置文件来完成，该文件应该被注册，如下所示：spring-doc.cn

<project>
	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<configuration>
					<layers>
						<enabled>true</enabled>
						<configuration>${project.basedir}/src/layers.xml</configuration>
					</layers>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>

配置文件描述了如何将档案分离为多个层，以及这些层的顺序。以下示例显示了如何显式定义上述默认 Sequences：spring-doc.cn

<layers xmlns="http://www.springframework.org/schema/boot/layers"
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xsi:schemaLocation="http://www.springframework.org/schema/boot/layers
	                      layers-xsd: https://www.springframework.org/schema/boot/layers/layers-3.4.xsd">
	<application>
		<into layer="spring-boot-loader">
			<include>org/springframework/boot/loader/**</include>
		</into>
		<into layer="application" />
	</application>
	<dependencies>
		<into layer="application">
			<includeModuleDependencies />
		</into>
		<into layer="snapshot-dependencies">
			<include>*:*:*SNAPSHOT</include>
		</into>
		<into layer="dependencies" />
	</dependencies>
	<layerOrder>
		<layer>dependencies</layer>
		<layer>spring-boot-loader</layer>
		<layer>snapshot-dependencies</layer>
		<layer>application</layer>
	</layerOrder>
</layers>

XML 格式分为三个部分：layersspring-doc.cn

该块定义应用程序类和资源的分层方式。<application>spring-doc.cn
该块定义了依赖项应该如何分层。<dependencies>spring-doc.cn
该块定义层的写入顺序。<layerOrder>spring-doc.cn

嵌套块在和部分中用于声明图层的内容。这些块按照定义的顺序从上到下进行评估。任何未被先前区块认领的内容仍可供后续区块考虑。<into><application><dependencies>spring-doc.cn

该块使用 nested 和元素声明内容。该部分对包含/排除表达式使用 Ant 样式路径匹配。该部分使用模式。它还提供了可用于包含或排除本地模块依赖项的 and 元素。<into><include><exclude><application><dependencies>group:artifact[:version]<includeModuleDependencies /><excludeModuleDependencies />spring-doc.cn

如果定义了 no，则考虑所有内容（未被先前的块声明）。<include>spring-doc.cn

如果未定义 no，则不应用任何排除项。<exclude>spring-doc.cn

查看上面的示例，我们可以看到第一个将声明 . 下一个将声明该层的所有 SNAPSHOT 依赖项。 final 将声明该层的剩余任何内容（在本例中为非 SNAPSHOT 的任何依赖项）。<dependencies><into>application.layer<into>snapshot-dependencies<into>dependenciesspring-doc.cn

该区块也有类似的规则。首先声明图层的内容。然后声明该层的所有剩余类和资源。<application>org/springframework/boot/loader/**spring-boot-loaderapplicationspring-doc.cn

块的定义顺序通常与层的写入顺序不同。因此，必须始终包含该元素，并且必须覆盖块引用的所有层。<into><layerOrder><into>

`spring-boot:repackage`

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

重新打包现有的 JAR 和 WAR 存档，以便可以使用 .With 也可以简单地用于打包具有嵌套依赖项的 JAR（并且没有主类，因此不是可执行文件）。java -jarlayout=NONEspring-doc.cn

必需参数

名字类型违约

名字	类型	违约
outputDirectory （输出目录）spring-doc.cn	`File`spring-doc.cn	`${project.build.directory}`spring-doc.cn

outputDirectory （输出目录）spring-doc.cn

Filespring-doc.cn

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

可选参数

名字类型违约

名字	类型	违约
附加 spring-doc.cn	`boolean`spring-doc.cn	`true`spring-doc.cn
分类 spring-doc.cn	`String`spring-doc.cn
embeddedLaunchScript spring-doc.cn	`File`spring-doc.cn
embeddedLaunchScriptProperties spring-doc.cn	`Properties`spring-doc.cn
excludeDevtools spring-doc.cn	`boolean`spring-doc.cn	`true`spring-doc.cn
excludeDockerCompose 的 spring-doc.cn	`boolean`spring-doc.cn	`true`spring-doc.cn
excludeGroupIds spring-doc.cn	`String`spring-doc.cn
排除 spring-doc.cn	`List`spring-doc.cn
可执行 spring-doc.cn	`boolean`spring-doc.cn	`false`spring-doc.cn
includeSystemScope spring-doc.cn	`boolean`spring-doc.cn	`false`spring-doc.cn
include工具 spring-doc.cn	`boolean`spring-doc.cn	`true`spring-doc.cn
包括 spring-doc.cn	`List`spring-doc.cn
层 spring-doc.cn	`Layers`spring-doc.cn
布局 spring-doc.cn	`LayoutType`spring-doc.cn
布局工厂 spring-doc.cn	`LayoutFactory`spring-doc.cn
loader实现 spring-doc.cn	`LoaderImplementation`spring-doc.cn
main类 spring-doc.cn	`String`spring-doc.cn
outputTimestamp （输出时间戳）spring-doc.cn	`String`spring-doc.cn	`${project.build.outputTimestamp}`spring-doc.cn
需要解压缩 spring-doc.cn	`List`spring-doc.cn
跳 spring-doc.cn	`boolean`spring-doc.cn	`false`spring-doc.cn

附加 spring-doc.cn

booleanspring-doc.cn

truespring-doc.cn

分类 spring-doc.cn

Stringspring-doc.cn

embeddedLaunchScript spring-doc.cn

Filespring-doc.cn

embeddedLaunchScriptProperties spring-doc.cn

Propertiesspring-doc.cn

excludeDevtools spring-doc.cn

booleanspring-doc.cn

truespring-doc.cn

excludeDockerCompose 的 spring-doc.cn

booleanspring-doc.cn

truespring-doc.cn

excludeGroupIds spring-doc.cn

Stringspring-doc.cn

排除 spring-doc.cn

Listspring-doc.cn

可执行 spring-doc.cn

booleanspring-doc.cn

falsespring-doc.cn

includeSystemScope spring-doc.cn

booleanspring-doc.cn

falsespring-doc.cn

include工具 spring-doc.cn

booleanspring-doc.cn

truespring-doc.cn

包括 spring-doc.cn

Listspring-doc.cn

层 spring-doc.cn

Layersspring-doc.cn

布局 spring-doc.cn

LayoutTypespring-doc.cn

布局工厂 spring-doc.cn

LayoutFactoryspring-doc.cn

loader实现 spring-doc.cn

LoaderImplementationspring-doc.cn

main类 spring-doc.cn

Stringspring-doc.cn

outputTimestamp （输出时间戳）spring-doc.cn

Stringspring-doc.cn

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

需要解压缩 spring-doc.cn

Listspring-doc.cn

跳 spring-doc.cn

booleanspring-doc.cn

falsespring-doc.cn

参数详情

`attach`

将重新打包的存档附加到本地 Maven 存储库或部署到远程存储库。如果未配置分类器，它将替换普通的 jar。如果已配置 a 使得普通 jar 和重新打包的 jar 不同，它将与普通 jar 一起附加。当该属性设置为时，将不会安装或部署重新打包的存档。classifierfalsespring-doc.cn

名字spring-doc.cn	`attach`spring-doc.cn
类型spring-doc.cn	`boolean`spring-doc.cn
默认值spring-doc.cn	`true`spring-doc.cn
用户属性spring-doc.cn
因为spring-doc.cn	`1.4.0`spring-doc.cn

分层 Jar 或 War

自定义图层配置

spring-boot:repackage

必需参数

可选参数

参数详情

attach

classifier

embeddedLaunchScript

embeddedLaunchScriptProperties

excludeDevtools

excludeDockerCompose

excludeGroupIds

excludes

executable

includeSystemScope

includeTools

includes

layers

layout

layoutFactory

loaderImplementation

mainClass

outputDirectory

outputTimestamp

requiresUnpack

skip

例子

自定义分类器

自定义名称

本地重新打包的工件

自定义布局

依赖项排除

JAR 工具

自定义图层配置

`spring-boot:repackage`

`attach`

`classifier`

`embeddedLaunchScript`

`embeddedLaunchScriptProperties`

`excludeDevtools`

`excludeDockerCompose`

`excludeGroupIds`

`excludes`

`executable`

`includeSystemScope`

`includeTools`

`includes`

`layers`

`layout`

`layoutFactory`

`loaderImplementation`

`mainClass`

`outputDirectory`

`outputTimestamp`

`requiresUnpack`

`skip`