Add documentation and fix issues after rebase

Author: christophstrobl

src/main/antora/modules/ROOT/pages/aot.adoc

@@ -0,0 +1,71 @@
+= Ahead of Time Optimizations
+
+This chapter covers Spring Data's Ahead of Time (AOT) optimizations that build upon {spring-framework-docs}/core/aot.html[Spring's Ahead of Time Optimizations].
+
+[[aot.bestpractices]]
+== Best Practices
+
+=== Annotate your Domain Types
+
+During application startup, Spring scans the classpath for domain classes for early processing of entities.
+By annotating your domain types with Spring Data Store specific `@Table`, `@Document` or `@Entity` annotations you can aid initial entity scanning and ensure that those types are registered with `ManagedTypes` for Runtime Hints.
+Classpath scanning is not possible in native image arrangements and so Spring has to use `ManagedTypes` for the initial entity set.
+
+[[aot.code-gen]]
+== Ahead of Time Code Generation
+
+Ahead of time code generation is not limited to usage with GraalVM Native Image but also offers benefits when working with regular deployments and can help optimize startup performance on the jvm.
+
+If Ahead of Time compilation is enabled Spring Data can (depending on the actual Module in use) contribute several components during the AOT phase of your build.
+
+* Bytecode for generated Type/Property Accessors
+* Sourcecode for the defined Repository Interfaces
+* Repository Metadata in JSON format
+
+Each of the above is enabled by default.
+However there users may fine tune the configuration with following options.
+
+[options = "autowidth",cols="1,1"]
+|===
+|spring.aot.data.accessors.enabled
+|boolean flag to control contribution of Bytecode for generated Type/Property Accessors
+
+|spring.aot.data.accessors.exclude
+|comma separated list of FQCN for which to skip contribution of Bytecode for generated Type/Property Accessors
+
+|spring.aot.data.accessors.include
+|comma separated list of FQCN for which to contribute Bytecode for generated Type/Property Accessors
+
+|spring.aot.repositories.enabled
+|boolean flag to control contribution of Source Code for Repository Interfaces
+
+|spring.aot.[module-name].repositories.enabled
+|boolean flag to control contribution of Source Code for Repository Interfaces for a certain module (eg. jdbc)
+|===
+
+[[aot.repositories]]
+== Ahead of Time Repositories
+
+AOT Repositories are an extension to AOT processing by pre-generating eligible query method implementations.
+Query methods are opaque to developers regarding their underlying queries being executed in a query method call.
+AOT repositories contribute query method implementations based on derived, annotated, and named queries that are known at build-time.
+This optimization moves query method processing from runtime to build-time, which can lead to a significant performance improvement as query methods do not need to be analyzed reflectively upon each application start.
+
+The resulting AOT repository fragment follows the naming scheme of `<Repository FQCN>Impl_AotRepository` and is placed in the same package as the repository interface.
+
+[[aot.hints]]
+== Native Image Runtime Hints
+
+Running an application as a native image requires additional information compared to a regular JVM runtime.
+Spring Data contributes {spring-framework-docs}/core/aot.html#aot.hints[Runtime Hints] during AOT processing for native image usage.
+These are in particular hints for:
+
+* Auditing
+* `ManagedTypes` to capture the outcome of class-path scans
+* Repositories
+** Reflection hints for entities, return types, and Spring Data annotations
+** Repository fragments
+** Querydsl `Q` classes
+** Kotlin Coroutine support
+* Web support (Jackson Hints for `PagedModel`)
+

src/main/java/org/springframework/data/aot/AotContext.java

@@ -24,7 +24,6 @@
 import java.util.function.Consumer;
 
 import org.jspecify.annotations.Nullable;
-import org.springframework.aot.hint.TypeReference;
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.NoSuchBeanDefinitionException;
 import org.springframework.beans.factory.config.BeanDefinition;

src/main/java/org/springframework/data/aot/AotMappingContext.java

@@ -28,7 +28,6 @@
 import org.springframework.data.mapping.model.EntityInstantiators;
 import org.springframework.data.mapping.model.Property;
 import org.springframework.data.mapping.model.SimpleTypeHolder;
-import org.springframework.data.repository.aot.generate.RepositoryContributor;
 import org.springframework.data.util.TypeInformation;
 
 /**

src/main/java/org/springframework/data/aot/AotTypeConfiguration.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2025. the original author or authors.
+ * Copyright 2025-present the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *      http://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -31,27 +31,73 @@
 import org.springframework.data.projection.TargetAware;
 
 /**
+ * Configuration object that captures various AOT configuration aspects of types within the data context by offering
+ * predefined methods to register native configuration necessary for data binding, projection proxy definitions, AOT
+ * cglib bytecode generation and other common tasks.
+ * <p>
+ * On {@link #contribute(Environment, GenerationContext)} the configuration is added to the {@link GenerationContext}.
+ * 
  * @author Christoph Strobl
+ * @since 4.0
  */
 public interface AotTypeConfiguration {
 
+	/**
+	 * Configure the referenced type for data binding. In case of {@link java.lang.annotation.Annotation} only data ones
+	 * are considered. For more fine grained control use {@link #forReflectiveAccess(MemberCategory...)}.
+	 *
+	 * @return this.
+	 */
 	AotTypeConfiguration forDataBinding();
 
+	/**
+	 * Configure the referenced type for reflective access by providing at least one {@link MemberCategory}.
+	 *
+	 * @param categories must not contain {@literal null}.
+	 * @return this.
+	 */
 	AotTypeConfiguration forReflectiveAccess(MemberCategory... categories);
 
+	/**
+	 * Contribute generated cglib accessors for the referenced type.
+	 * <p>
+	 * Can be disabled by user configuration ({@code spring.aot.data.accessors.enabled}). Honors in/exclusions set by user
+	 * configuration {@code spring.aot.data.accessors.include} / {@code spring.aot.data.accessors.exclude}
+	 *
+	 * @return this.
+	 */
 	AotTypeConfiguration contributeAccessors();
 
 	// TODO: ? should this be a global condition for the entire configuration or do we need it for certain aspects ?
 	AotTypeConfiguration filter(Predicate<Class<?>> filter);
 
+	/**
+	 * Configure the referenced type as a projection interface returned by eg. a query method.
+	 * <p>
+	 * Shortcut for {@link #proxyInterface(Class[]) proxyInterface(TargetAware, SpringProxy, DecoratingProxy)}
+	 * 
+	 * @return this.
+	 */
 	default AotTypeConfiguration usedAsProjectionInterface() {
 		return proxyInterface(TargetAware.class, SpringProxy.class, DecoratingProxy.class);
 	}
 
+	/**
+	 * Configure the referenced type as a spring proxy interface.
+	 * <p>
+	 * Shortcut for {@link #proxyInterface(Class[]) proxyInterface(SpringProxy, Advised, DecoratingProxy)}
+	 *
+	 * @return this.
+	 */
 	default AotTypeConfiguration springProxy() {
 		return proxyInterface(SpringProxy.class, Advised.class, DecoratingProxy.class);
 	}
 
+	/**
+	 * Configure the referenced type as a repository proxy.
+	 *
+	 * @return this.
+	 */
 	default AotTypeConfiguration repositoryProxy() {
 
 		springProxy();
@@ -67,14 +113,36 @@ default AotTypeConfiguration repositoryProxy() {
 		return this;
 	}
 
+	/**
+	 * Register a proxy for the referenced type that also implements the given proxyInterfaces.
+	 * 
+	 * @param proxyInterfaces additional interfaces the proxy implements. Order matters!
+	 * @return this.
+	 */
 	AotTypeConfiguration proxyInterface(List<TypeReference> proxyInterfaces);
 
+	/**
+	 * Register a proxy for the referenced type that also implements the given proxyInterfaces.
+	 *
+	 * @param proxyInterfaces additional interfaces the proxy implements. Order matters!
+	 * @return this.
+	 */
 	default AotTypeConfiguration proxyInterface(Class<?>... proxyInterfaces) {
 		return proxyInterface(Stream.of(proxyInterfaces).map(TypeReference::of).toList());
 	}
 
+	/**
+	 * Configure the referenced type for usage with Querydsl by registering hints for potential {@code Q} types.
+	 * 
+	 * @return this.
+	 */
 	AotTypeConfiguration forQuerydsl();
 
+	/**
+	 * Write the configuration to the given {@link GenerationContext}.
+	 * 
+	 * @param environment must not be {@literal null}.
+	 * @param generationContext must not be {@literal null}.
+	 */
 	void contribute(Environment environment, GenerationContext generationContext);
-
 }

src/main/java/org/springframework/data/aot/DefaultAotContext.java

@@ -30,7 +30,6 @@
 import java.util.stream.Stream;
 
 import org.jspecify.annotations.Nullable;
-
 import org.springframework.aot.generate.GenerationContext;
 import org.springframework.aot.hint.MemberCategory;
 import org.springframework.aot.hint.TypeReference;
@@ -41,8 +40,6 @@
 import org.springframework.beans.factory.support.DefaultListableBeanFactory;
 import org.springframework.beans.factory.support.RootBeanDefinition;
 import org.springframework.core.env.Environment;
-import org.springframework.core.env.Environment;
-import org.springframework.data.mapping.context.MappingContext;
 import org.springframework.data.util.QTypeContributor;
 import org.springframework.data.util.TypeContributor;
 import org.springframework.util.AntPathMatcher;
@@ -53,22 +50,28 @@
  * Default {@link AotContext} implementation.
  *
  * @author Mark Paluch
+ * @author Christoph Strobl
  * @since 3.0
  */
 class DefaultAotContext implements AotContext {
 
-	private final AotMappingContext mappingContext = new AotMappingContext();;
+	private final AotMappingContext mappingContext;
 	private final ConfigurableListableBeanFactory factory;
 
 	// TODO: should we reuse the config or potentially have multiple ones with different settings - somehow targets the
 	// filtering issue
 	private final Map<Class<?>, AotTypeConfiguration> typeConfigurations = new HashMap<>();
-    private final Environment environment;
+	private final Environment environment;
 
 	public DefaultAotContext(BeanFactory beanFactory, Environment environment) {
+		this(beanFactory, environment, new AotMappingContext());
+	}
+
+	DefaultAotContext(BeanFactory beanFactory, Environment environment, AotMappingContext mappingContext) {
 		this.factory = beanFactory instanceof ConfigurableListableBeanFactory cbf ? cbf
 				: new DefaultListableBeanFactory(beanFactory);
 		this.environment = environment;
+		this.mappingContext = mappingContext;
 	}
 
 	@Override
@@ -255,11 +258,7 @@ public void contribute(Environment environment, GenerationContext generationCont
 			}
 
 			if (forDataBinding) {
-
 				TypeContributor.contribute(type, Set.of(TypeContributor.DATA_NAMESPACE), generationContext);
-
-				generationContext.getRuntimeHints().reflection().registerType(type, MemberCategory.INVOKE_DECLARED_CONSTRUCTORS,
-						MemberCategory.INVOKE_DECLARED_METHODS);
 			}
 
 			if (forQuerydsl) {
@@ -268,9 +267,8 @@ public void contribute(Environment environment, GenerationContext generationCont
 
 			if (!proxies.isEmpty()) {
 				for (List<TypeReference> proxyInterfaces : proxies) {
-					generationContext.getRuntimeHints().proxies()
-							.registerJdkProxy(Stream.concat(Stream.of(TypeReference.of(type)), proxyInterfaces.stream())
-									.toArray(TypeReference[]::new));
+					generationContext.getRuntimeHints().proxies().registerJdkProxy(
+							Stream.concat(Stream.of(TypeReference.of(type)), proxyInterfaces.stream()).toArray(TypeReference[]::new));
 				}
 			}
 

src/main/java/org/springframework/data/aot/ManagedTypesBeanRegistrationAotProcessor.java

@@ -22,7 +22,6 @@
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.jspecify.annotations.Nullable;
-
 import org.springframework.aot.generate.GenerationContext;
 import org.springframework.beans.factory.BeanCreationException;
 import org.springframework.beans.factory.aot.BeanRegistrationAotContribution;
@@ -70,11 +69,6 @@ public void setEnvironment(Environment environment) {
 		this.environment = Lazy.of(environment);
 	}
 
-	@Override
-	public void setEnvironment(Environment environment) {
-		this.environment = Lazy.of(() -> environment);
-	}
-
 	@Override
 	public @Nullable BeanRegistrationAotContribution processAheadOfTime(RegisteredBean registeredBean) {
 
@@ -153,7 +147,7 @@ protected void contributeType(ResolvableType type, GenerationContext generationC
 				.contributeAccessors() //
 				.forQuerydsl().contribute(environment.get(), generationContext));
 
-        		TypeUtils.resolveUsedAnnotations(type.toClass()).forEach(
+		TypeUtils.resolveUsedAnnotations(type.toClass()).forEach(
 				annotation -> TypeContributor.contribute(annotation.getType(), annotationNamespaces, generationContext));
 	}
 

src/main/java/org/springframework/data/aot/ManagedTypesRegistrationAotContribution.java

@@ -23,7 +23,6 @@
 import javax.lang.model.element.Modifier;
 
 import org.jspecify.annotations.Nullable;
-
 import org.springframework.aot.generate.AccessControl;
 import org.springframework.aot.generate.GeneratedMethod;
 import org.springframework.aot.generate.GenerationContext;
@@ -80,8 +79,8 @@ class ManagedTypesRegistrationAotContribution implements RegisteredBeanAotContri
 	private final BiConsumer<ResolvableType, GenerationContext> contributionAction;
 	private final RegisteredBean source;
 
-	public ManagedTypesRegistrationAotContribution(AotContext aotContext, ManagedTypes managedTypes, RegisteredBean registeredBean,
-			BiConsumer<ResolvableType, GenerationContext> contributionAction) {
+	public ManagedTypesRegistrationAotContribution(AotContext aotContext, ManagedTypes managedTypes,
+			RegisteredBean registeredBean, BiConsumer<ResolvableType, GenerationContext> contributionAction) {
 
 		this.aotContext = aotContext;
 		this.managedTypes = managedTypes;
@@ -145,7 +144,8 @@ protected ManagedTypesInstanceCodeFragment(List<Class<?>> sourceTypes, Registere
 		}
 
 		@Override
-		public CodeBlock generateInstanceSupplierCode(GenerationContext generationContext, BeanRegistrationCode beanRegistrationCode, boolean allowDirectSupplierShortcut) {
+		public CodeBlock generateInstanceSupplierCode(GenerationContext generationContext,
+				BeanRegistrationCode beanRegistrationCode, boolean allowDirectSupplierShortcut) {
 
 			GeneratedMethod generatedMethod = beanRegistrationCode.getMethods().add("Instance",
 					this::generateInstanceFactory);