构建

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.0</version>
			<executions>
				<execution>
					<goals>
						<goal>build-info</goal>
					</goals>
				</execution>
			</executions>
		</plugin>
	</plugins>
</build>
有关更多详细信息，请参阅 Spring Boot Maven Plugin 文档。

以下示例使用 Gradle 实现相同的功能：

springBoot {
	buildInfo()
}
有关更多详细信息，请参阅 Spring Boot Gradle Plugin 文档。

生成 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 '2.3.0'
}

自定义依赖版本

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

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

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

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

使用 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.0</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。

例如，要指示 JRuby 应该被标记为解包，使用 Maven 插件，您需要添加以下配置：

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

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

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

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

不使用 spring-boot-antlib 从 Ant 构建可执行归档文件

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

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

  2. 在嵌套的 BOOT-INF/lib 目录（对于 jar）或 WEB-INF/lib（对于 war）中添加运行时依赖项。 记住*不要*压缩归档文件中的条目。

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

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

  5. 在清单中使用适当的启动器（例如 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>