提前处理

Spring AOT 是一种在构建时分析应用程序并生成其优化版本的流程。它是以原生镜像运行 Spring ApplicationContext 的必要步骤。

有关 Spring Boot 中 GraalVM 原生镜像支持的概述,请查看 参考文档

Spring Boot Maven 插件提供了一些目标,可用于对应用程序和测试代码执行 AOT 处理。

处理应用程序

要配置您的应用程序以使用此功能,请添加 process-aot 目标的执行,如以下示例所示

<plugin>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-maven-plugin</artifactId>
	<executions>
		<execution>
			<id>process-aot</id>
			<goals>
				<goal>process-aot</goal>
			</goals>
		</execution>
	</executions>
</plugin>

由于 BeanFactory 在构建时已完全准备就绪,因此条件也会被评估。这与常规 Spring Boot 应用程序在运行时执行的操作相比存在重要差异。例如,如果您想选择加入或选择退出某些功能,则需要在构建时配置所使用的环境。出于这个原因,process-aot 目标与 run 目标 共享许多属性。

使用 Native 配置文件

如果您使用 spring-boot-starter-parent 作为项目的 parent,则可以使用 native 配置文件来简化构建原生镜像所需的步骤。

native 配置文件配置以下内容

  • 在 Spring Boot Maven 插件应用于项目时执行 process-aot

  • 合适的设置,以便 build-image 生成原生镜像。

  • Native Build Tools Maven 插件 的合理默认值,特别是

    • 确保插件使用原始类路径,而不是主 jar 文件,因为它不理解我们重新打包的 jar 格式。

    • 验证是否可以使用合适的 GraalVM 版本。

    • 下载第三方可达性元数据。

要从 native 配置文件中获益,代表应用程序的模块应定义两个插件,如以下示例所示

<plugin>
	<groupId>org.graalvm.buildtools</groupId>
	<artifactId>native-maven-plugin</artifactId>
</plugin>
<plugin>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>

单个项目可以使用 Cloud Native BuildpacksNative Image Build Tools 在命令行上触发原生镜像的生成。

要将 native 配置文件与多模块项目一起使用,您可以创建 native 配置文件的自定义版本,以便它调用您首选的技术。

要在 package 阶段绑定 Cloud Native Buildpacks,请将以下内容添加到多模块项目的根 POM 中

<profile>
	<id>native</id>
	<build>
		<pluginManagement>
			<plugins>
				<plugin>
					<groupId>org.springframework.boot</groupId>
					<artifactId>spring-boot-maven-plugin</artifactId>
					<executions>
						<execution>
							<id>build-image</id>
							<goals>
								<goal>build-image-no-fork</goal>
							</goals>
						</execution>
					</executions>
				</plugin>
			</plugins>
		</pluginManagement>
	</build>
</profile>

以下示例对 Native Build Tools 执行相同的操作

<profile>
	<id>native</id>
	<build>
		<pluginManagement>
			<plugins>
				<plugin>
					<groupId>org.graalvm.buildtools</groupId>
					<artifactId>native-maven-plugin</artifactId>
					<executions>
						<execution>
							<id>build-image</id>
							<goals>
								<goal>compile-no-fork</goal>
							</goals>
						</execution>
					</executions>
				</plugin>
			</plugins>
		</pluginManagement>
	</build>
</profile>

完成上述配置后,您可以构建多模块项目并在相关子模块中生成原生镜像,如下例所示

$ mvn package -Pnative
“相关”子模块是指代表 Spring Boot 应用程序的模块。此类模块必须定义 Native Build Tools 和 Spring Boot 插件,如上所述。

spring-boot:process-aot

org.springframework.boot:spring-boot-maven-plugin:3.3.0

在应用程序上调用 AOT 引擎。

必需参数

名称 类型 默认值

classesDirectory

文件

${project.build.outputDirectory}

generatedClasses

文件

${project.build.directory}/spring-aot/main/classes

generatedResources

文件

${project.build.directory}/spring-aot/main/resources

generatedSources

文件

${project.build.directory}/spring-aot/main/sources

可选参数

名称 类型 默认值

arguments

String[]

compilerArguments

String

excludeGroupIds

String

excludes

列表

includes

列表

jvmArguments

String

mainClass

String

profiles

String[]

skip

布尔值

false

systemPropertyVariables

地图

参数详情

arguments

应考虑用于 AOT 处理的应用程序参数。

名称

arguments

类型

java.lang.String[]

默认值

用户属性

classesDirectory

包含应打包到存档中的类和资源文件的目录。

名称

classesDirectory

类型

java.io.File

默认值

${project.build.outputDirectory}

用户属性

compilerArguments

应提供给 AOT 编译过程的参数。在命令行上,确保将多个值用引号括起来。

名称

compilerArguments

类型

java.lang.String

默认值

用户属性

spring-boot.aot.compilerArguments

excludeGroupIds

要排除的 groupId 名称的逗号分隔列表(完全匹配)。

名称

excludeGroupIds

类型

java.lang.String

默认值

用户属性

spring-boot.excludeGroupIds

1.1.0

excludes

要排除的工件定义集合。Exclude 元素定义了必需的 groupIdartifactId 组件以及可选的 classifier 组件。当配置为属性时,值应以逗号分隔,并以冒号分隔组件:groupId:artifactId,groupId:artifactId:classifier

名称

excludes

类型

java.util.List

默认值

用户属性

spring-boot.excludes

1.1.0

generatedClasses

包含生成类的目录。

名称

generatedClasses

类型

java.io.File

默认值

${project.build.directory}/spring-aot/main/classes

用户属性

generatedResources

包含生成资源的目录。

名称

generatedResources

类型

java.io.File

默认值

${project.build.directory}/spring-aot/main/resources

用户属性

generatedSources

包含生成源代码的目录。

名称

generatedSources

类型

java.io.File

默认值

${project.build.directory}/spring-aot/main/sources

用户属性

includes

要包含的工件定义集合。Include 元素定义了必需的 groupIdartifactId 组件,以及可选的 classifier 组件。当配置为属性时,值应以逗号分隔,组件之间以冒号分隔:groupId:artifactId,groupId:artifactId:classifier

名称

includes

类型

java.util.List

默认值

用户属性

spring-boot.includes

1.2.0

jvmArguments

应与 AOT 进程关联的 JVM 参数。在命令行上,确保将多个值用引号括起来。

名称

jvmArguments

类型

java.lang.String

默认值

用户属性

spring-boot.aot.jvmArguments

mainClass

用作 AOT 进程源的主类的名称。如果未指定,将使用找到的第一个包含“main”方法的编译类。

名称

mainClass

类型

java.lang.String

默认值

用户属性

spring-boot.aot.main-class

profiles

要考虑用于 AOT 处理的 Spring 配置文件。

名称

profiles

类型

java.lang.String[]

默认值

用户属性

skip

跳过执行。

名称

skip

类型

布尔值

默认值

false

用户属性

spring-boot.aot.skip

systemPropertyVariables

传递给 AOT 进程的 JVM 系统属性列表。

名称

systemPropertyVariables

类型

java.util.Map

默认值

用户属性

处理测试

AOT 引擎可以应用于使用 Spring 的测试上下文框架的 JUnit 5 测试。AOT 引擎会处理合适的测试,以生成 ApplicationContextInitializer 代码。

要将您的应用程序配置为使用此功能,请添加 process-test-aot 目标的执行,如以下示例所示

<plugin>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-maven-plugin</artifactId>
	<executions>
		<execution>
			<id>process-test-aot</id>
			<goals>
				<goal>process-test-aot</goal>
			</goals>
		</execution>
	</executions>
</plugin>
如果您使用的是 spring-boot-starter-parent,则如果启用了 nativeTest 配置文件,则会自动配置此执行。

与应用程序 AOT 处理一样,BeanFactory 在构建时已完全准备就绪。

spring-boot:process-test-aot

org.springframework.boot:spring-boot-maven-plugin:3.3.0

在测试中调用 AOT 引擎。

必需参数

名称 类型 默认值

classesDirectory

文件

${project.build.outputDirectory}

generatedClasses

文件

${project.build.directory}/spring-aot/main/classes

generatedResources

文件

${project.build.directory}/spring-aot/test/resources

generatedSources

文件

${project.build.directory}/spring-aot/test/sources

generatedTestClasses

文件

${project.build.directory}/spring-aot/test/classes

testClassesDirectory

文件

${project.build.testOutputDirectory}

可选参数

名称 类型 默认值

compilerArguments

String

excludeGroupIds

String

excludes

列表

includes

列表

jvmArguments

String

skip

布尔值

false

systemPropertyVariables

地图

参数详情

classesDirectory

包含用于运行测试的类和资源文件的目录。

名称

classesDirectory

类型

java.io.File

默认值

${project.build.outputDirectory}

用户属性

compilerArguments

应提供给 AOT 编译过程的参数。在命令行上,确保将多个值用引号括起来。

名称

compilerArguments

类型

java.lang.String

默认值

用户属性

spring-boot.aot.compilerArguments

excludeGroupIds

要排除的 groupId 名称的逗号分隔列表(完全匹配)。

名称

excludeGroupIds

类型

java.lang.String

默认值

用户属性

spring-boot.excludeGroupIds

1.1.0

excludes

要排除的工件定义集合。Exclude 元素定义了必需的 groupIdartifactId 组件以及可选的 classifier 组件。当配置为属性时,值应以逗号分隔,并以冒号分隔组件:groupId:artifactId,groupId:artifactId:classifier

名称

excludes

类型

java.util.List

默认值

用户属性

spring-boot.excludes

1.1.0

generatedClasses

包含生成的测试类的目录。

名称

generatedClasses

类型

java.io.File

默认值

${project.build.directory}/spring-aot/main/classes

用户属性

generatedResources

包含生成的测试资源的目录。

名称

generatedResources

类型

java.io.File

默认值

${project.build.directory}/spring-aot/test/resources

用户属性

generatedSources

包含生成源代码的目录。

名称

generatedSources

类型

java.io.File

默认值

${project.build.directory}/spring-aot/test/sources

用户属性

generatedTestClasses

包含生成的测试类的目录。

名称

generatedTestClasses

类型

java.io.File

默认值

${project.build.directory}/spring-aot/test/classes

用户属性

includes

要包含的工件定义集合。Include 元素定义了必需的 groupIdartifactId 组件,以及可选的 classifier 组件。当配置为属性时,值应以逗号分隔,组件之间以冒号分隔:groupId:artifactId,groupId:artifactId:classifier

名称

includes

类型

java.util.List

默认值

用户属性

spring-boot.includes

1.2.0

jvmArguments

应与 AOT 进程关联的 JVM 参数。在命令行上,确保将多个值用引号括起来。

名称

jvmArguments

类型

java.lang.String

默认值

用户属性

spring-boot.aot.jvmArguments

skip

跳过执行。

名称

skip

类型

布尔值

默认值

false

用户属性

spring-boot.aot.skip

systemPropertyVariables

传递给 AOT 进程的 JVM 系统属性列表。

名称

systemPropertyVariables

类型

java.util.Map

默认值

用户属性

testClassesDirectory

包含应打包到存档中的类和资源文件的目录。

名称

testClassesDirectory

类型

java.io.File

默认值

${project.build.testOutputDirectory}

用户属性