打包可执行存档
该插件可以创建包含应用程序所有依赖项的可执行存档（jar 文件和 war 文件），然后可以使用 java -jar 运行。
打包可执行存档由 repackage 目标执行，如下例所示
<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>
如果您使用的是 spring-boot-starter-parent，则此类执行已预先配置了 repackage 执行 ID，因此只需添加插件定义即可。
|
上面的示例重新打包了在 Maven 生命周期打包阶段构建的 jar 或 war 存档，包括项目中定义的任何 provided 依赖项。如果需要排除其中一些依赖项，可以使用 exclude 选项之一；有关更多详细信息，请参阅 依赖项排除。
默认情况下，原始（即不可执行）工件将重命名为 .original，但也可以使用自定义分类器保留原始工件。
目前不支持 maven-war-plugin 的 outputFileNameMapping 功能。
|
默认情况下，spring-boot-devtools 和 spring-boot-docker-compose 模块会自动排除（您可以使用 excludeDevtools 和 excludeDockerCompose 属性控制此行为）。为了使这与 war 打包一起使用，spring-boot-devtools 和 spring-boot-docker-compose 依赖项必须设置为 optional 或使用 provided 范围。
该插件会重写您的清单，特别是它会管理 Main-Class 和 Start-Class 条目。如果默认值不起作用，您需要在 Spring Boot 插件中配置这些值，而不是在 jar 插件中配置。清单中的 Main-Class 由 Spring Boot 插件的 layout 属性控制，如下例所示
<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>layout 属性默认值为由存档类型（jar 或 war）确定的值。以下布局可用
-
JAR：常规可执行 JAR 布局。 -
WAR：可执行 WAR 布局。provided依赖项放置在WEB-INF/lib-provided中，以避免在将war部署到 servlet 容器时发生任何冲突。 -
ZIP（别名为DIR）：类似于使用PropertiesLauncher的JAR布局。 -
NONE：捆绑所有依赖项和项目资源。不捆绑引导加载程序。
分层 Jar 或 War
重新打包的 jar 包含应用程序的类和依赖项，分别位于 BOOT-INF/classes 和 BOOT-INF/lib 中。类似地，可执行 war 包含应用程序的类，位于 WEB-INF/classes 中，依赖项位于 WEB-INF/lib 和 WEB-INF/lib-provided 中。对于需要从 jar 或 war 的内容构建 docker 镜像的情况，能够进一步分离这些目录非常有用，以便可以将它们写入不同的层。
分层存档使用与常规重新打包的 jar 或 war 相同的布局，但包含一个额外的元数据文件，该文件描述每个层。
默认情况下，定义以下层
-
对于任何版本不包含
SNAPSHOT的依赖项，dependencies层包含这些依赖项。 -
spring-boot-loader层包含加载器类。 -
snapshot-dependencies层包含任何版本包含SNAPSHOT的依赖项。 -
application层包含本地模块依赖项、应用程序类和资源。
模块依赖项通过查看当前构建中包含的所有模块来识别。如果模块依赖项只能通过已安装到 Maven 本地缓存中且不属于当前构建来解析，则它将被识别为常规依赖项。
层的顺序很重要，因为它决定了当应用程序的一部分发生变化时，先前层被缓存的可能性。默认顺序为 dependencies、spring-boot-loader、snapshot-dependencies、application。最不可能更改的内容应首先添加，然后是更可能更改的层。
重新打包的存档默认情况下包含 layers.idx 文件。要禁用此功能，您可以按照以下方式进行操作
<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>自定义层配置
根据您的应用程序，您可能希望调整层的创建方式并添加新的层。这可以通过使用单独的配置文件来完成，该配置文件应按如下所示注册
<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>配置文件描述了如何将存档分成层，以及这些层的顺序。以下示例显示了如何显式定义上述默认排序
<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.3.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>layers XML 格式定义了三个部分
-
<application>块定义了如何对应用程序类和资源进行分层。 -
<dependencies>块定义了如何对依赖项进行分层。 -
<layerOrder>块定义了层的写入顺序。
嵌套的 <into> 块用于 <application> 和 <dependencies> 部分中，以声明层的內容。这些块按定义顺序从上到下进行评估。任何未被先前块声明的內容都将保留，以便后续块考虑。
<into> 块使用嵌套的 <include> 和 <exclude> 元素来声明內容。<application> 部分使用 Ant 风格的路径匹配来进行 include/exclude 表达式。<dependencies> 部分使用 group:artifact[:version] 模式。它还提供了 <includeModuleDependencies /> 和 <excludeModuleDependencies /> 元素，可用于包含或排除本地模块依赖项。
如果未定义 <include>，则所有內容（未被先前块声明）都被视为包含。
如果未定义 <exclude>，则不应用任何排除。
查看上面的<dependencies>示例，我们可以看到第一个<into>将为application.layer声明所有模块依赖项。下一个<into>将为snapshot-dependencies层声明所有 SNAPSHOT 依赖项。最后一个<into>将为dependencies层声明任何剩余的依赖项（在本例中，任何不是 SNAPSHOT 的依赖项）。
<application>块具有类似的规则。首先为spring-boot-loader层声明org/springframework/boot/loader/**内容。然后为application层声明任何剩余的类和资源。
<into>块的定义顺序通常与层写入的顺序不同。因此，<layerOrder>元素必须始终包含，并且必须涵盖<into>块引用的所有层。
|
spring-boot:repackage
org.springframework.boot:spring-boot-maven-plugin:3.3.0
重新打包现有的 JAR 和 WAR 存档，以便可以使用java -jar从命令行执行它们。使用layout=NONE也可以简单地打包一个包含嵌套依赖项的 JAR（没有主类，因此不可执行）。
可选参数
| 名称 | 类型 | 默认值 |
|---|---|---|
|
|
|
|
||
|
||
|
||
|
|
|
|
|
|
|
||
|
||
|
|
|
|
|
|
|
|
|
|
||
|
||
|
|
|
|
||
|
|
参数详细信息
attach
将重新打包的存档附加到您的本地 Maven 存储库中，或部署到远程存储库中。如果没有配置分类器，它将替换正常的 jar。如果配置了classifier，使得正常的 jar 和重新打包的 jar 不同，它将与正常的 jar 一起附加。当属性设置为false时，重新打包的存档将不会被安装或部署。
名称 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自从 |
|
classifier
要添加到重新打包的存档中的分类器。如果未给出，则主工件将被重新打包的存档替换。如果给出，分类器也将用于确定要重新打包的源存档：如果具有该分类器的工件已存在，则将用作源并替换。如果没有这样的工件，则主工件将用作源，并且重新打包的存档将作为具有该分类器的补充工件附加。附加工件允许将其与原始工件一起部署，请参阅 Maven 文档以获取更多详细信息。
名称 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自从 |
|
embeddedLaunchScript
如果 jar 是完全可执行的，则要预先添加到 jar 前面的嵌入式启动脚本。如果未指定，将使用“Spring Boot”默认脚本。
名称 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自从 |
|
embeddedLaunchScriptProperties
应在嵌入式启动脚本中扩展的属性。
名称 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自从 |
|
excludeDevtools
从重新打包的存档中排除 Spring Boot devtools。
名称 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自从 |
|
excludeDockerCompose
从重新打包的存档中排除 Spring Boot 开发服务。
名称 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自从 |
|
excludeGroupIds
要排除的 groupId 名称的逗号分隔列表（完全匹配）。
名称 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自从 |
|
excludes
要排除的工件定义集合。Exclude 元素定义了必需的 groupId 和 artifactId 组件以及可选的 classifier 组件。当配置为属性时，值应以逗号分隔，并以冒号分隔的组件：groupId:artifactId,groupId:artifactId:classifier
名称 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自从 |
|
executable
通过在 jar 文件前面添加启动脚本，为 *nix 机器创建完全可执行的 jar 文件。<p> 目前，一些工具不接受这种格式，因此您可能无法始终使用此技术。例如，jar -xf 可能会静默地无法解压缩已完全可执行的 jar 或 war 文件。建议您仅在打算直接执行它时才启用此选项，而不是使用 java -jar 运行它或将其部署到 servlet 容器中。
名称 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自从 |
|
includes
要包含的工件定义集合。Include 元素定义了必需的 groupId 和 artifactId 组件以及可选的 classifier 组件。当配置为属性时，值应以逗号分隔，组件之间以冒号分隔：groupId:artifactId,groupId:artifactId:classifier
名称 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自从 |
|
layout
存档类型（对应于依赖项在其中布局的方式）。可能的值为 JAR、WAR、ZIP、DIR、NONE。默认情况下，会根据存档类型进行猜测。
名称 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自从 |
|
outputDirectory
包含生成的存档的目录。
名称 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自从 |
|
outputTimestamp
用于可重复输出存档条目的时间戳，格式为 ISO 8601 (yyyy-MM-dd’T’HH:mm:ssXXX) 或表示自纪元以来的秒数的 int。
名称 |
|
|---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自从 |
|
示例
自定义分类器
默认情况下，repackage 目标会用重新打包的工件替换原始工件。对于表示应用程序的模块来说，这是一个合理的做法，但如果您的模块用作另一个模块的依赖项，则需要为重新打包的工件提供一个分类器。原因是应用程序类打包在 BOOT-INF/classes 中，因此依赖模块无法加载重新打包的 jar 的类。
如果是这种情况，或者您希望保留原始工件并使用不同的分类器附加重新打包的工件，请按照以下示例配置插件
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<id>repackage</id>
<goals>
<goal>repackage</goal>
</goals>
<configuration>
<classifier>exec</classifier>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>如果您使用的是 spring-boot-starter-parent，则 repackage 目标会在 ID 为 repackage 的执行中自动执行。在这种情况下，只需要指定配置，如以下示例所示
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<id>repackage</id>
<configuration>
<classifier>exec</classifier>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>此配置将生成两个工件：原始工件和由 repackage 目标生成的重新打包的对应工件。两者都将被透明地安装/部署。
您也可以使用相同的配置来重新打包第二个工件，就像替换主工件一样。以下配置安装/部署一个带有重新打包的应用程序的 task 分类工件
<project>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>jar</goal>
</goals>
<phase>package</phase>
<configuration>
<classifier>task</classifier>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<id>repackage</id>
<goals>
<goal>repackage</goal>
</goals>
<configuration>
<classifier>task</classifier>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>由于 maven-jar-plugin 和 spring-boot-maven-plugin 都在同一阶段运行，因此重要的是 jar 插件要先定义（以便它在 repackage 目标之前运行）。同样，如果您使用的是 spring-boot-starter-parent，则可以简化为以下内容
<project>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<executions>
<execution>
<id>default-jar</id>
<configuration>
<classifier>task</classifier>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<id>repackage</id>
<configuration>
<classifier>task</classifier>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>自定义名称
如果您需要重新打包的 jar 具有与项目 artifactId 属性定义的名称不同的本地名称，请使用标准 finalName，如以下示例所示
<project>
<build>
<finalName>my-app</finalName>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<id>repackage</id>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>此配置将在 target/my-app.jar 中生成重新打包的工件。
本地重新打包的工件
默认情况下，repackage 目标会用可执行文件替换原始工件。如果您只需要部署原始 jar，但仍然能够使用常规文件名运行您的应用程序，请按如下方式配置插件
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<id>repackage</id>
<goals>
<goal>repackage</goal>
</goals>
<configuration>
<attach>false</attach>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>此配置将生成两个工件：原始工件和由 repackage 目标生成的对应可执行文件。只有原始工件将被安装/部署。
自定义布局
Spring Boot 使用自定义布局工厂重新打包此项目的 jar 文件，该工厂定义在附加的 jar 文件中，作为构建插件的依赖项提供。
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<id>repackage</id>
<goals>
<goal>repackage</goal>
</goals>
<configuration>
<layoutFactory implementation="com.example.CustomLayoutFactory">
<customProperty>value</customProperty>
</layoutFactory>
</configuration>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>com.example</groupId>
<artifactId>custom-layout</artifactId>
<version>0.0.1.BUILD-SNAPSHOT</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>布局工厂作为 LayoutFactory（来自 spring-boot-loader-tools）的实现提供，在 pom 中明确指定。如果插件类路径上只有一个自定义 LayoutFactory，并且它在 META-INF/spring.factories 中列出，则无需在插件配置中明确设置它。
如果显式设置了 布局，则始终忽略布局工厂。
依赖项排除
默认情况下，repackage 和 run 目标都将包含项目中定义的任何 provided 依赖项。Spring Boot 项目应将 provided 依赖项视为“容器”依赖项，这些依赖项是运行应用程序所需的。一般来说，Spring Boot 项目不用作依赖项，因此不太可能有任何 optional 依赖项。当项目确实具有可选依赖项时，它们也会被 repackage 和 run 目标包含。
其中一些依赖项可能根本不需要，应该从可执行 jar 中排除。为了保持一致性，它们在运行应用程序时也不应该存在。
有两种方法可以排除依赖项在运行时被打包/使用
-
排除由
groupId和artifactId标识的特定工件，如果需要，可以选择使用classifier。 -
排除属于给定
groupId的任何工件。
以下示例排除 com.example:module1，并且仅排除该工件
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>com.example</groupId>
<artifactId>module1</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
</project>此示例排除属于 com.example 组的任何工件
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludeGroupIds>com.example</excludeGroupIds>
</configuration>
</plugin>
</plugins>
</build>
</project>JAR 工具
当创建分层 jar 或 war 时，spring-boot-jarmode-tools jar 将作为依赖项添加到您的存档中。使用此 jar 在类路径上，您可以以特殊模式启动应用程序，该模式允许引导代码运行与您的应用程序完全不同的东西，例如，提取层的东西。如果您希望排除此依赖项，您可以按照以下方式进行
<project>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<includeTools>false</includeTools>
</configuration>
</plugin>
</plugins>
</build>
</project>自定义层配置
默认设置将依赖项分为快照和非快照，但是，您可能拥有更复杂的规则。例如，您可能希望将项目的公司特定依赖项隔离在专用层中。以下 layers.xml 配置显示了这种设置
<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.3.xsd">
<application>
<into layer="spring-boot-loader">
<include>org/springframework/boot/loader/**</include>
</into>
<into layer="application" />
</application>
<dependencies>
<into layer="snapshot-dependencies">
<include>*:*:*SNAPSHOT</include>
</into>
<into layer="company-dependencies">
<include>com.acme:*</include>
</into>
<into layer="dependencies"/>
</dependencies>
<layerOrder>
<layer>dependencies</layer>
<layer>spring-boot-loader</layer>
<layer>snapshot-dependencies</layer>
<layer>company-dependencies</layer>
<layer>application</layer>
</layerOrder>
</layers>上面的配置创建了一个额外的 company-dependencies 层，其中包含所有具有 com.acme groupId 的库。
