WIP support for modular Spring AOT

sdeleuze · sdeleuze · commit ce7a5a55db62 · 2025-09-12T18:07:00.000+02:00
This commit which leverages https://github.com/sdeleuze/spring-framework/tree/modular-spring-aot introduces support for modular Spring AOT, with the main goal to provide more control on which benefits/side effects are enabled. It introduces 4 new boolean properties to the Gradle AOT tasks: - beanRegistration - predefinedClasses - classpathIndexes - reachabilityMetadata When none of those 4 boolean properties are defined, they are all enabled to keep backward compatibility. Build configuration example: processAot { predefinedClasses = true classpathIndexes = true } Other possible options for DevXP: - Some artifact types enabled by default on the JVM when Spring AOT processing happen but -Dspring.aot.enabled is not specified - Have some kind of "JVM mode" flag
diff --git a/build-plugin/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/aot/AbstractAot.java b/build-plugin/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/aot/AbstractAot.java
@@ -17,20 +17,27 @@
 package org.springframework.boot.gradle.tasks.aot;
 
 import java.util.ArrayList;
+import java.util.HashSet;
 import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 import org.gradle.api.file.DirectoryProperty;
 import org.gradle.api.provider.Property;
 import org.gradle.api.tasks.Input;
 import org.gradle.api.tasks.JavaExec;
+import org.gradle.api.tasks.Optional;
 import org.gradle.api.tasks.OutputDirectory;
 import org.gradle.work.DisableCachingByDefault;
 
+import org.springframework.aot.generate.GeneratedArtifact;
+
 /**
  * Specialization of {@link JavaExec} to be used as a base class for tasks that perform
  * ahead-of-time processing.
  *
  * @author Andy Wilkinson
+ * @author Sebastien Deleuze
  * @since 3.0.0
  */
 @DisableCachingByDefault(because = "Cacheability can only be determined by a concrete implementation")
@@ -46,12 +53,24 @@ public abstract class AbstractAot extends JavaExec {
 
 	private final Property<String> artifactId;
 
+	private final Property<Boolean> beanRegistration;
+
+	private final Property<Boolean> predefinedClasses;
+
+	private final Property<Boolean> classpathIndexes;
+
+	private final Property<Boolean> reachabilityMetadata;
+
 	protected AbstractAot() {
 		this.sourcesDir = getProject().getObjects().directoryProperty();
 		this.resourcesDir = getProject().getObjects().directoryProperty();
 		this.classesDir = getProject().getObjects().directoryProperty();
 		this.groupId = getProject().getObjects().property(String.class);
 		this.artifactId = getProject().getObjects().property(String.class);
+		this.beanRegistration = getProject().getObjects().property(Boolean.class);
+		this.predefinedClasses = getProject().getObjects().property(Boolean.class);
+		this.classpathIndexes = getProject().getObjects().property(Boolean.class);
+		this.reachabilityMetadata = getProject().getObjects().property(Boolean.class);
 	}
 
 	/**
@@ -99,13 +118,57 @@ public final DirectoryProperty getClassesOutput() {
 		return this.classesDir;
 	}
 
+	@Input
+	@Optional
+	public final Property<Boolean> getBeanRegistration() {
+		return this.beanRegistration;
+	}
+
+	@Input
+	@Optional
+	public final Property<Boolean> getPredefinedClasses() {
+		return this.predefinedClasses;
+	}
+
+	@Input
+	@Optional
+	public final Property<Boolean> getClasspathIndexes() {
+		return this.classpathIndexes;
+	}
+
+	@Input
+	@Optional
+	public final Property<Boolean> getReachabilityMetadata() {
+		return this.reachabilityMetadata;
+	}
+
 	List<String> processorArgs() {
 		List<String> args = new ArrayList<>();
 		args.add(getSourcesOutput().getAsFile().get().getAbsolutePath());
 		args.add(getResourcesOutput().getAsFile().get().getAbsolutePath());
 		args.add(getClassesOutput().getAsFile().get().getAbsolutePath());
 		args.add(getGroupId().get());
 		args.add(getArtifactId().get());
+		Set<GeneratedArtifact> artifactTypes = new HashSet<>();
+		if (Boolean.TRUE.equals(this.beanRegistration.getOrNull())) {
+			artifactTypes.add(GeneratedArtifact.BEAN_REGISTRATION);
+		}
+		if (Boolean.TRUE.equals(this.predefinedClasses.getOrNull())) {
+			artifactTypes.add(GeneratedArtifact.PREDEFINED_CLASSES);
+		}
+		if (Boolean.TRUE.equals(this.classpathIndexes.getOrNull())) {
+			artifactTypes.add(GeneratedArtifact.CLASSPATH_INDEXES);
+		}
+		if (Boolean.TRUE.equals(this.reachabilityMetadata.getOrNull())) {
+			artifactTypes.add(GeneratedArtifact.REACHABILITY_METADATA);
+		}
+		if (artifactTypes.isEmpty()) {
+			artifactTypes.add(GeneratedArtifact.BEAN_REGISTRATION);
+			artifactTypes.add(GeneratedArtifact.PREDEFINED_CLASSES);
+			artifactTypes.add(GeneratedArtifact.CLASSPATH_INDEXES);
+			artifactTypes.add(GeneratedArtifact.REACHABILITY_METADATA);
+		}
+		args.add(artifactTypes.stream().map(GeneratedArtifact::toString).collect(Collectors.joining(",")));
 		args.addAll(super.getArgs());
 		return args;
 	}
diff --git a/build.gradle b/build.gradle
@@ -39,6 +39,7 @@ subprojects {
 				includeGroup "net.shibboleth"
 			}
 		}
+		mavenLocal()
 		spring.mavenRepositories()
 	}
 
diff --git a/core/spring-boot/src/main/java/org/springframework/boot/SpringApplicationAotProcessor.java b/core/spring-boot/src/main/java/org/springframework/boot/SpringApplicationAotProcessor.java
@@ -20,6 +20,7 @@
 import java.nio.file.Paths;
 import java.util.Arrays;
 
+import org.springframework.aot.generate.GeneratedArtifact;
 import org.springframework.boot.SpringApplication.AbandonedRunException;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ConfigurableApplicationContext;
@@ -38,6 +39,7 @@
  * @author Stephane Nicoll
  * @author Andy Wilkinson
  * @author Phillip Webb
+ * @author Sebastien Deleuze
  * @since 3.0.0
  */
 public class SpringApplicationAotProcessor extends ContextAotProcessor {
@@ -65,20 +67,23 @@ protected GenericApplicationContext prepareApplicationContext(Class<?> applicati
 	}
 
 	public static void main(String[] args) throws Exception {
-		int requiredArgs = 6;
+		int requiredArgs = 7;
 		Assert.state(args.length >= requiredArgs, () -> "Usage: " + SpringApplicationAotProcessor.class.getName()
-				+ " <applicationMainClass> <sourceOutput> <resourceOutput> <classOutput> <groupId> <artifactId> <originalArgs...>");
+				+ " <applicationMainClass> <sourceOutput> <resourceOutput> <classOutput> <groupId> <artifactId> <artifactTypes> <originalArgs...>");
 		Class<?> application = Class.forName(args[0]);
-		Settings settings = Settings.builder()
+		Settings.Builder builder = Settings.builder()
 			.sourceOutput(Paths.get(args[1]))
 			.resourceOutput(Paths.get(args[2]))
 			.classOutput(Paths.get(args[3]))
 			.groupId((StringUtils.hasText(args[4])) ? args[4] : "unspecified")
-			.artifactId(args[5])
-			.build();
+			.artifactId(args[5]);
+		String[] artifactTypes = args[6].split(",");
+		for (String artifactType : artifactTypes) {
+			builder.generatedArtifact(GeneratedArtifact.valueOf(artifactType));
+		}
 		String[] applicationArgs = (args.length > requiredArgs) ? Arrays.copyOfRange(args, requiredArgs, args.length)
 				: new String[0];
-		new SpringApplicationAotProcessor(application, settings, applicationArgs).process();
+		new SpringApplicationAotProcessor(application, builder.build(), applicationArgs).process();
 	}
 
 	/**
diff --git a/gradle.properties b/gradle.properties
@@ -19,7 +19,7 @@ mavenVersion=3.9.10
 mockitoVersion=5.19.0
 nativeBuildToolsVersion=0.11.0
 snakeYamlVersion=2.4
-springFrameworkVersion=7.0.0-M8
+springFrameworkVersion=7.0.0-SNAPSHOT
 springFramework60xVersion=6.0.23
 tomcatVersion=11.0.10
 nullabilityPluginVersion=0.0.4

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ subprojects {`
`39`	`39`	`includeGroup "net.shibboleth"`
`40`	`40`	`}`
`41`	`41`	`}`
	`42`	`+ mavenLocal()`
`42`	`43`	`spring.mavenRepositories()`
`43`	`44`	`}`
`44`	`45`