|
对于最新的稳定版本，请使用 Spring Boot 3.5.5！ |
构建
Spring Boot 包括 Maven 和 Gradle 的构建插件。 本节回答有关这些插件的常见问题。
生成构建信息
Maven 插件和 Gradle 插件都允许生成包含项目坐标、名称和版本的构建信息。
还可以将插件配置为通过配置添加其他属性。
当存在这样的文件时，Spring Boot 会自动配置一个BuildProperties豆。
要使用 Maven 生成构建信息，请为build-info目标，如以下示例所示：
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>3.4.9</version>
<executions>
<execution>
<goals>
<goal>build-info</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>| 有关更多详细信息，请参阅 Spring Boot Maven 插件文档。 |
以下示例对 Gradle 执行相同的作：
springBoot {
buildInfo()
}| 有关更多详细信息，请参阅 Spring Boot Gradle 插件文档。 |
生成 Git 信息
Maven 和 Gradle 都允许生成git.properties文件，其中包含有关您的状态的信息git生成项目时的源代码存储库。
对于 Maven 用户，spring-boot-starter-parentPOM 包括一个预配置的插件，用于生成git.properties文件。
要使用它，请为Git Commit Id Plugin到你的 POM：
<build>
<plugins>
<plugin>
<groupId>io.github.git-commit-id</groupId>
<artifactId>git-commit-id-maven-plugin</artifactId>
</plugin>
</plugins>
</build>Gradle 用户可以通过使用gradle-git-properties插件，如以下示例所示：
plugins {
id "com.gorylenko.gradle-git-properties" version "2.4.1"
}Maven 和 Gradle 插件都允许git.properties待配置。
中的提交时间git.properties应匹配以下格式：yyyy-MM-dd’T’HH:mm:ssZ.
这是上面列出的两个插件的默认格式。
使用这种格式可以将时间解析为Date及其格式，当序列化为 JSON 时，由 Jackson 的日期序列化配置设置控制。 |
生成 CycloneDX SBOM
Maven 和 Gradle 都允许在项目构建时生成 CycloneDX SBOM。
对于 Maven 用户，spring-boot-starter-parentPOM 包括一个预配置的插件来生成 SBOM。
要使用它，请为cyclonedx-maven-plugin到你的 POM：
<build>
<plugins>
<plugin>
<groupId>org.cyclonedx</groupId>
<artifactId>cyclonedx-maven-plugin</artifactId>
</plugin>
</plugins>
</build>Gradle 用户可以通过使用cyclonedx-gradle-plugin插件，如以下示例所示：
plugins {
id 'org.cyclonedx.bom' version '1.10.0'
}使用 Maven 创建可执行 JAR
这spring-boot-maven-plugin可用于创建可执行的“胖”JAR。
如果您使用spring-boot-starter-parentPOM，您可以声明插件，并且您的 jar 将按如下方式重新打包：
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>如果您不使用父 POM，您仍然可以使用该插件。
但是，您必须额外添加一个<executions>部分，如下所示：
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>3.4.9</version>
<executions>
<execution>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>有关完整的使用详细信息，请参阅插件文档。
使用 Spring Boot 应用程序作为依赖项
与 war 文件一样，Spring Boot 应用程序不打算用作依赖项。 如果您的应用程序包含要与其他项目共享的类，建议的方法是将该代码移动到单独的模块中。 然后，您的应用程序和其他项目可以依赖单独的模块。
如果您无法按照上述建议重新排列代码，则必须将 Spring Boot 的 Maven 和 Gradle 插件配置为生成适合用作依赖项的单独工件。
可执行存档不能用作依赖项，因为可执行 jar 格式将应用程序类打包在BOOT-INF/classes.
这意味着当可执行 jar 用作依赖项时，找不到它们。
要生成两个工件，一个可用作依赖项，一个可执行，必须指定分类器。 此分类器应用于可执行存档的名称，保留默认存档作为依赖项使用。
要配置exec在 Maven 中，您可以使用以下配置：
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<classifier>exec</classifier>
</configuration>
</plugin>
</plugins>
</build>在可执行 jar 运行时提取特定库
可执行 jar 中的大多数嵌套库不需要解压缩即可运行。
但是，某些库可能存在问题。
例如，JRuby 包含自己的嵌套 jar 支持，它假设jruby-complete.jar始终以文件的形式直接提供。
要处理任何有问题的库，您可以标记在可执行 jar 首次运行时应自动解压缩特定的嵌套 jar。
此类嵌套 jar 写在由java.io.tmpdir系统属性。
| 应注意确保您的作系统已配置，以便在应用程序仍在运行时不会删除已解压缩到临时目录的 jar。 |
例如，要指示应使用 Maven 插件标记 JRuby 以进行解包，您可以添加以下配置：
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<requiresUnpack>
<dependency>
<groupId>org.jruby</groupId>
<artifactId>jruby-complete</artifactId>
</dependency>
</requiresUnpack>
</configuration>
</plugin>
</plugins>
</build>创建具有排除项的不可执行 JAR
通常，如果您将可执行文件和不可执行 jar 作为两个单独的构建产品，则可执行文件版本具有库 jar 中不需要的其他配置文件。
例如，application.yaml配置文件可能会从不可执行的 JAR 中排除。
在Maven中，可执行的jar必须是主工件，您可以为库添加一个分类的jar，如下所示：
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
<plugin>
<artifactId>maven-jar-plugin</artifactId>
<executions>
<execution>
<id>lib</id>
<phase>package</phase>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<classifier>lib</classifier>
<excludes>
<exclude>application.yaml</exclude>
</excludes>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>在不使用 spring-boot-antlib 的情况下从 Ant 构建可执行存档
要使用 Ant 进行构建，您需要抓取依赖项，编译，然后创建一个 jar 或 war 存档。
要使其可执行，您可以使用spring-boot-antlib模块，或者您可以按照以下说明进行作：
-
如果您正在构建一个 jar，请将应用程序的类和资源打包在嵌套的
BOOT-INF/classes目录。 如果您正在构建 war，请将应用程序的类打包在嵌套的WEB-INF/classes目录。 -
在嵌套的
BOOT-INF/lib目录或WEB-INF/lib为了一场战争。 请记住不要压缩存档中的条目。 -
添加
provided（嵌入式容器）依赖项BOOT-INF/lib目录或WEB-INF/lib-provided为了一场战争。 请记住不要压缩存档中的条目。 -
添加
spring-boot-loader类（以便Main-Class可用）。 -
使用适当的Starters（例如
JarLauncher对于 jar 文件）作为Main-Class属性，并指定它需要作为清单条目的其他属性——主要是通过设置Start-Class财产。
以下示例显示了如何使用 Ant 构建可执行存档：
<target name="build" depends="compile">
<jar destfile="target/${ant.project.name}-${spring-boot.version}.jar" compress="false">
<mappedresources>
<fileset dir="target/classes" />
<globmapper from="*" to="BOOT-INF/classes/*"/>
</mappedresources>
<mappedresources>
<fileset dir="src/main/resources" erroronmissingdir="false"/>
<globmapper from="*" to="BOOT-INF/classes/*"/>
</mappedresources>
<mappedresources>
<fileset dir="${lib.dir}/runtime" />
<globmapper from="*" to="BOOT-INF/lib/*"/>
</mappedresources>
<zipfileset src="${lib.dir}/loader/spring-boot-loader-jar-${spring-boot.version}.jar" />
<manifest>
<attribute name="Main-Class" value="org.springframework.boot.loader.launch.JarLauncher" />
<attribute name="Start-Class" value="${start-class}" />
</manifest>
</jar>
</target>