构建

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.4.5</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 文件。要使用它，请在你的 POM 中添加以下 Git Commit Id Plugin 声明

<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。要使用它，请在你的 POM 中添加以下 cyclonedx-maven-plugin 声明

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

自定义依赖版本

spring-boot-dependencies POM 管理常用依赖的版本。用于 Maven 和 Gradle 的 Spring Boot 插件允许使用构建属性自定义这些管理的依赖版本。

每个 Spring Boot 发布版本都是针对这组特定的第三方依赖项设计和测试的。覆盖版本可能会导致兼容性问题。

要使用 Maven 覆盖依赖版本，请参阅 Maven 插件文档中的使用插件。

要在 Gradle 中覆盖依赖版本，请参阅 Gradle 插件文档中的自定义管理的版本。

使用 Maven 创建可执行 JAR

spring-boot-maven-plugin 可用于创建可执行的“胖”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.4.5</version>
			<executions>
				<execution>
					<goals>
						<goal>repackage</goal>
					</goals>
				</execution>
			</executions>
		</plugin>
	</plugins>
</build>

有关完整的使用详情，请参阅插件文档。

将 Spring Boot 应用用作依赖

与 war 文件类似，Spring Boot 应用不旨在用作依赖。如果你的应用包含希望与其他项目共享的类，推荐的方法是将这些代码移到一个单独的模块中。然后你的应用和其他项目可以依赖该独立模块。

如果无法按上述建议重新组织代码，则必须配置 Spring Boot 的 Maven 和 Gradle 插件以生成适合用作依赖的单独 artifact。可执行归档不能用作依赖，因为可执行 jar 格式将应用类打包在 BOOT-INF/classes 中。这意味着当可执行 jar 用作依赖时，无法找到这些类。

要生成两个 artifact，一个可用作依赖，另一个是可执行的，必须指定一个分类器 (classifier)。此分类器将应用于可执行归档的名称，而默认归档则用于依赖。

要在 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 必须是主 artifact，你可以按如下方式为库添加一个带有分类器的 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>

远程调试使用 Maven 启动的 Spring Boot 应用

要将远程调试器附加到使用 Maven 启动的 Spring Boot 应用，可以使用 maven 插件的 jvmArguments 属性。

有关更多详细信息，请参见此示例。

在不使用 spring-boot-antlib 的情况下从 Ant 构建可执行归档

要使用 Ant 构建，你需要获取依赖项、编译，然后创建一个 jar 或 war 归档。要使其可执行，你可以使用 spring-boot-antlib 模块，或者你可以按照以下说明进行操作

  1. 如果你正在构建一个 jar，将应用的类和资源打包到嵌套的 BOOT-INF/classes 目录中。如果你正在构建一个 war，将应用的类像往常一样打包到嵌套的 WEB-INF/classes 目录中。

  2. 将运行时依赖项添加到 jar 的嵌套 BOOT-INF/lib 目录或 war 的 WEB-INF/lib 目录中。请记住不要压缩归档中的条目。

  3. 将 provided（嵌入式容器）依赖项添加到 jar 的嵌套 BOOT-INF/lib 目录或 war 的 WEB-INF/lib-provided 目录中。请记住不要压缩归档中的条目。

  4. 将 spring-boot-loader 类添加到归档的根目录（以便 Main-Class 可用）。

  5. 使用适当的启动器（例如 jar 文件的 JarLauncher）作为 manifest 中的 Main-Class 属性，并通过设置 Start-Class 属性等方式指定其所需的其他 manifest 条目。

以下示例展示了如何使用 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>