Ahead-of-Time Processing (Ahead-of-Time Processing) _ Spring Boot3.4.0-SNAPSHOT中文文档(官方文档中文翻译)|Spring 教程 —

This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Boot 3.3.4!spring-doc.cn

Spring AOT is a process that analyzes your application at build-time and generate an optimized version of it. It is a mandatory step to run a Spring ApplicationContext in a native image.spring-doc.cn

For an overview of GraalVM Native Images support in Spring Boot, check the reference documentation.

The Spring Boot Maven plugin offers goals that can be used to perform AOT processing on both application and test code.spring-doc.cn

For an overview of GraalVM Native Images support in Spring Boot, check the reference documentation.

Processing Applications

To configure your application to use this feature, add an execution for the process-aot goal, as shown in the following example:spring-doc.cn

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

As the BeanFactory is fully prepared at build-time, conditions are also evaluated. This has an important difference compared to what a regular Spring Boot application does at runtime. For instance, if you want to opt-in or opt-out for certain features, you need to configure the environment used at build time to do so. The process-aot goal shares a number of properties with the run goal for that reason.spring-doc.cn

Using the Native Profile

If you use spring-boot-starter-parent as the parent of your project, a native profile can be used to streamline the steps required to build a native image.spring-doc.cn

The native profile configures the following:spring-doc.cn

Execution of process-aot when the Spring Boot Maven Plugin is applied on a project.spring-doc.cn
Suitable settings so that build-image generates a native image.spring-doc.cn
Sensible defaults for the Native Build Tools Maven Plugin, in particular:spring-doc.cn
- Making sure the plugin uses the raw classpath, and not the main jar file as it does not understand our repackaged jar format.spring-doc.cn
- Validate that a suitable GraalVM version is available.spring-doc.cn
- Download third-party reachability metadata.spring-doc.cn

The use of the raw classpath means that native image does not know about the generated MANIFEST. If you need to read the content of the manifest in a native image, for instance to get the implementation version of your application, configure the classesDirectory option to use the regular jar.spring-doc.cn

To benefit from the native profile, a module that represents an application should define two plugins, as shown in the following example:spring-doc.cn

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

A single project can trigger the generation of a native image on the command-line using either Cloud Native Buildpacks or Native Image Build Tools.spring-doc.cn

To use the native profile with a multi-modules project, you can create a customization of the native profile so that it invokes your preferred technique.spring-doc.cn

To bind Cloud Native Buildpacks during the package phase, add the following to the root POM of your multi-modules project:spring-doc.cn

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

The example below does the same for Native Build Tools:spring-doc.cn

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

Once the above is in place, you can build your multi-modules project and generate a native image in the relevant sub-modules, as shown in the following example:spring-doc.cn

$ mvn package -Pnative

A "relevant" sub-module is a module that represents a Spring Boot application. Such module must define the Native Build Tools and Spring Boot plugins as described above.

`spring-boot:process-aot`

org.springframework.boot:spring-boot-maven-plugin:3.4.0-SNAPSHOTspring-doc.cn

Invoke the AOT engine on the application.spring-doc.cn

Required parameters

Name Type Default

Name	Type	Default
classesDirectory spring-doc.cn	`File`spring-doc.cn	`${project.build.outputDirectory}`spring-doc.cn
generatedClasses spring-doc.cn	`File`spring-doc.cn	`${project.build.directory}/spring-aot/main/classes`spring-doc.cn
generatedResources spring-doc.cn	`File`spring-doc.cn	`${project.build.directory}/spring-aot/main/resources`spring-doc.cn
generatedSources spring-doc.cn	`File`spring-doc.cn	`${project.build.directory}/spring-aot/main/sources`spring-doc.cn

classesDirectory spring-doc.cn

Filespring-doc.cn

${project.build.outputDirectory}spring-doc.cn

generatedClasses spring-doc.cn

Filespring-doc.cn

${project.build.directory}/spring-aot/main/classesspring-doc.cn

generatedResources spring-doc.cn

Filespring-doc.cn

${project.build.directory}/spring-aot/main/resourcesspring-doc.cn

generatedSources spring-doc.cn

Filespring-doc.cn

${project.build.directory}/spring-aot/main/sourcesspring-doc.cn

Optional parameters

Name Type Default

Name	Type	Default
arguments spring-doc.cn	`String[]`spring-doc.cn
compilerArguments spring-doc.cn	`String`spring-doc.cn
excludeGroupIds spring-doc.cn	`String`spring-doc.cn
excludes spring-doc.cn	`List`spring-doc.cn
includes spring-doc.cn	`List`spring-doc.cn
jvmArguments spring-doc.cn	`String`spring-doc.cn
mainClass spring-doc.cn	`String`spring-doc.cn
profiles spring-doc.cn	`String[]`spring-doc.cn
skip spring-doc.cn	`boolean`spring-doc.cn	`false`spring-doc.cn
systemPropertyVariables spring-doc.cn	`Map`spring-doc.cn

arguments spring-doc.cn

String[]spring-doc.cn

compilerArguments spring-doc.cn

Stringspring-doc.cn

excludeGroupIds spring-doc.cn

Stringspring-doc.cn

excludes spring-doc.cn

Listspring-doc.cn

includes spring-doc.cn

Listspring-doc.cn

jvmArguments spring-doc.cn

Stringspring-doc.cn

mainClass spring-doc.cn

Stringspring-doc.cn

profiles spring-doc.cn

String[]spring-doc.cn

skip spring-doc.cn

booleanspring-doc.cn

falsespring-doc.cn

systemPropertyVariables spring-doc.cn

Mapspring-doc.cn

Parameter details

`arguments`

Application arguments that should be taken into account for AOT processing.spring-doc.cn

Namespring-doc.cn	`arguments`spring-doc.cn
Typespring-doc.cn	`java.lang.String[]`spring-doc.cn
Default valuespring-doc.cn
User propertyspring-doc.cn
Sincespring-doc.cn

Processing Applications

Using the Native Profile

spring-boot:process-aot

Required parameters

Optional parameters

Parameter details

arguments

classesDirectory

compilerArguments

excludeGroupIds

excludes

generatedClasses

generatedResources

generatedSources

includes

jvmArguments

mainClass

profiles

skip

systemPropertyVariables

Processing Tests

spring-boot:process-test-aot

Required parameters

Optional parameters

Parameter details

classesDirectory

compilerArguments

excludeGroupIds

excludes

generatedClasses

generatedResources

generatedSources

generatedTestClasses

includes

jvmArguments

skip

systemPropertyVariables

testClassesDirectory

`spring-boot:process-aot`

`arguments`

`classesDirectory`

`compilerArguments`

`excludeGroupIds`

`excludes`

`generatedClasses`

`generatedResources`

`generatedSources`

`includes`

`jvmArguments`

`mainClass`

`profiles`

`skip`

`systemPropertyVariables`

`spring-boot:process-test-aot`

`classesDirectory`

`compilerArguments`

`excludeGroupIds`

`excludes`

`generatedClasses`

`generatedResources`

`generatedSources`

`generatedTestClasses`

`includes`

`jvmArguments`

`skip`

`systemPropertyVariables`

`testClassesDirectory`