|
此版本仍在开发中,尚未被视为稳定版本。如需最新稳定版本,请使用 Spring Boot 4.0.4! |
构建
Spring Boot 包含适用于 Maven 和 Gradle 的构建插件。 本节回答有关这些插件的常见问题。
生成构建信息
Maven 插件和 Gradle 插件都允许生成包含项目坐标、名称和版本的构建信息。
这些插件还可以通过配置来添加额外的属性。
当存在此类文件时,Spring Boot 会自动配置一个 BuildProperties Bean。
要使用 Maven 生成构建信息,请为 build-info 目标添加一个执行配置,如下例所示:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>3.5.13-SNAPSHOT</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-parent POM 包含一个预配置的插件,用于生成 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-parent POM 包含一个预配置的插件来生成 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 '2.3.0'
}
使用 Maven 创建可执行 JAR
spring-boot-maven-plugin 可用于创建可执行的“fat” JAR。
如果您使用 spring-boot-starter-parent POM,您可以声明插件,并且您的 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.5.13-SNAPSHOT</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 用作依赖项时,这些类将无法被找到。
为了生成两个构件,一个用作依赖项,另一个可执行,必须指定一个分类器。 该分类器将应用于可执行归档文件的名称,从而保留默认归档文件以作为依赖项使用。
要在 Maven 中配置分类器 exec,可以使用以下配置:
<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 作为两个独立的构建产物,那么可执行版本通常包含一些在库 JAR 中不需要的额外配置文件。
例如,application.yaml 配置文件可能会被排除在非可执行 JAR 之外。
在 Maven 中,可执行 JAR 必须是主要构件(main artifact),你可以为库添加一个带分类器(classified)的 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目录(针对 jar)或WEB-INF/lib目录(针对 war)中添加运行时依赖项。 请记住不要压缩归档文件中的条目。 -
在用于 jar 的嵌套
provided目录或用于 war 的BOOT-INF/lib目录中添加WEB-INF/lib-provided(嵌入式容器)依赖项。 请记住不要压缩归档文件中的条目。 -
在归档文件的根目录添加
spring-boot-loader类(以便Main-Class可用)。 -
在清单中使用适当的Starters(例如,对于 jar 文件使用
JarLauncher)作为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>