Polishing.

Refine local variable handling to logical and physical naming where the logical name is used in AOT contributor code while the physical name is rendered.

See #3270
Original pull request: #3271

Author: mp911de

src/main/java/org/springframework/data/repository/aot/generate/AotQueryMethodGenerationContext.java

@@ -20,9 +20,8 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import javax.lang.model.element.Modifier;
-
 import org.jspecify.annotations.Nullable;
+
 import org.springframework.core.ResolvableType;
 import org.springframework.core.annotation.MergedAnnotation;
 import org.springframework.core.annotation.MergedAnnotationSelectors;
@@ -31,8 +30,6 @@
 import org.springframework.data.repository.query.Parameter;
 import org.springframework.data.repository.query.QueryMethod;
 import org.springframework.data.repository.query.ReturnedType;
-import org.springframework.javapoet.FieldSpec;
-import org.springframework.javapoet.ParameterSpec;
 import org.springframework.javapoet.TypeName;
 import org.springframework.util.ObjectUtils;
 
@@ -51,7 +48,6 @@ public class AotQueryMethodGenerationContext {
 	private final RepositoryInformation repositoryInformation;
 	private final AotRepositoryFragmentMetadata targetTypeMetadata;
 	private final MethodMetadata targetMethodMetadata;
-	private final CodeBlocks codeBlocks;
 	private final VariableNameFactory variableNameFactory;
 
 	AotQueryMethodGenerationContext(RepositoryInformation repositoryInformation, Method method, QueryMethod queryMethod,
@@ -64,11 +60,6 @@ public class AotQueryMethodGenerationContext {
 		this.targetTypeMetadata = targetTypeMetadata;
 		this.targetMethodMetadata = new MethodMetadata(repositoryInformation, method);
 		this.variableNameFactory = LocalVariableNameFactory.forMethod(targetMethodMetadata);
-		this.codeBlocks = new CodeBlocks(targetTypeMetadata);
-	}
-
-	AotRepositoryFragmentMetadata getTargetTypeMetadata() {
-		return targetTypeMetadata;
 	}
 
 	MethodMetadata getTargetMethodMetadata() {
@@ -79,12 +70,18 @@ public RepositoryInformation getRepositoryInformation() {
 		return repositoryInformation;
 	}
 
-	public Method getMethod() {
-		return method;
+	/**
+	 * Obtain the field name by type.
+	 *
+	 * @param type
+	 * @return
+	 */
+	public @Nullable String fieldNameOf(Class<?> type) {
+		return targetTypeMetadata.fieldNameOf(type);
 	}
 
-	public CodeBlocks codeBlocks() {
-		return codeBlocks;
+	public Method getMethod() {
+		return method;
 	}
 
 	/**
@@ -112,10 +109,18 @@ public ReturnedType getReturnedType() {
 		return queryMethod.getResultProcessor().getReturnedType();
 	}
 
+	/**
+	 * @return the actual returned domain type.
+	 * @see org.springframework.data.repository.core.RepositoryMetadata#getReturnedDomainClass(Method)
+	 */
 	public ResolvableType getActualReturnType() {
 		return targetMethodMetadata.getActualReturnType();
 	}
 
+	/**
+	 * @return the query method return type.
+	 * @see org.springframework.data.repository.core.RepositoryMetadata#getReturnType(Method)
+	 */
 	public ResolvableType getReturnType() {
 		return targetMethodMetadata.getReturnType();
 	}
@@ -127,23 +132,13 @@ public TypeName getReturnTypeName() {
 		return TypeName.get(getReturnType().getType());
 	}
 
-	/**
-	 * Suggest naming clash free variant for the given intended variable name within the local method context.
-	 *
-	 * @param variableName the intended variable name.
-	 * @return the suggested VariableName
-	 */
-	public String suggestLocalVariableName(String variableName) {
-		return variableNameFactory.generateName(variableName);
-	}
-
 	/**
 	 * Returns the required parameter name for the {@link Parameter#isBindable() bindable parameter} at the given
 	 * {@code parameterIndex} or throws {@link IllegalArgumentException} if the parameter cannot be determined by its
 	 * index.
 	 *
 	 * @param parameterIndex the zero-based parameter index as used in the query to reference bindable parameters.
-	 * @return the parameter name.
+	 * @return the method parameter name.
 	 */
 	public String getRequiredBindableParameterName(int parameterIndex) {
 
@@ -161,9 +156,8 @@ public String getRequiredBindableParameterName(int parameterIndex) {
 	 * {@code parameterIndex} or {@code null} if the parameter cannot be determined by its index.
 	 *
 	 * @param parameterIndex the zero-based parameter index as used in the query to reference bindable parameters.
-	 * @return the parameter name.
+	 * @return the method parameter name.
 	 */
-	// TODO: Simplify?!
 	public @Nullable String getBindableParameterName(int parameterIndex) {
 
 		int bindable = 0;
@@ -185,12 +179,12 @@ public String getRequiredBindableParameterName(int parameterIndex) {
 	}
 
 	/**
-	 * Returns the required parameter name for the {@link Parameter#isBindable() bindable parameter} at the given
-	 * {@code parameterName} or throws {@link IllegalArgumentException} if the parameter cannot be determined by its
-	 * index.
+	 * Returns the required parameter name for the {@link Parameter#isBindable() bindable parameter} at the given logical
+	 * {@code parameterName} or throws {@link IllegalArgumentException} if the parameter cannot be determined by its name.
 	 *
 	 * @param parameterName the parameter name as used in the query to reference bindable parameters.
-	 * @return the parameter name.
+	 * @return the method parameter name.
+	 * @see org.springframework.data.repository.query.Param
 	 */
 	public String getRequiredBindableParameterName(String parameterName) {
 
@@ -204,13 +198,13 @@ public String getRequiredBindableParameterName(String parameterName) {
 	}
 
 	/**
-	 * Returns the required parameter name for the {@link Parameter#isBindable() bindable parameter} at the given
-	 * {@code parameterName} or {@code null} if the parameter cannot be determined by its index.
+	 * Returns the required parameter name for the {@link Parameter#isBindable() bindable parameter} at the given logical
+	 * {@code parameterName} or {@code null} if the parameter cannot be determined by its name.
 	 *
 	 * @param parameterName the parameter name as used in the query to reference bindable parameters.
-	 * @return the parameter name.
+	 * @return the method parameter name.
+	 * @see org.springframework.data.repository.query.Param
 	 */
-	// TODO: Simplify?!
 	public @Nullable String getBindableParameterName(String parameterName) {
 
 		int totalIndex = 0;
@@ -237,7 +231,7 @@ public List<String> getBindableParameterNames() {
 		List<String> result = new ArrayList<>();
 
 		for (Parameter parameter : queryMethod.getParameters().getBindableParameters()) {
-			getParameterName(parameter.getIndex());
+			result.add(getParameterName(parameter.getIndex()));
 		}
 
 		return result;
@@ -250,45 +244,50 @@ public List<String> getAllParameterNames() {
 		return targetMethodMetadata.getMethodArguments().keySet().stream().toList();
 	}
 
-	public boolean hasField(String fieldName) {
-		return targetTypeMetadata.hasField(fieldName);
-	}
-
-	public void addField(String fieldName, TypeName type, Modifier... modifiers) {
-		targetTypeMetadata.addField(fieldName, type, modifiers);
-	}
-
-	public void addField(FieldSpec fieldSpec) {
-		targetTypeMetadata.addField(fieldSpec);
-	}
-
-	public @Nullable String fieldNameOf(Class<?> type) {
-		return targetTypeMetadata.fieldNameOf(type);
-	}
-
-	@Nullable
-	public String getParameterNameOf(Class<?> type) {
-		return targetMethodMetadata.getParameterNameOf(type);
+	/**
+	 * Obtain a naming-clash free variant for the given logical variable name within the local method context. Returns the
+	 * target variable name when called multiple times with the same {@code variableName}.
+	 *
+	 * @param variableName the logical variable name.
+	 * @return the variable name used in the generated code.
+	 */
+	public String localVariable(String variableName) {
+		return targetMethodMetadata.getLocalVariables().computeIfAbsent(variableName, variableNameFactory::generateName);
 	}
 
+	/**
+	 * Returns the parameter name for the method parameter at {@code position}.
+	 *
+	 * @param position zero-indexed parameter position.
+	 * @return
+	 * @see Method#getParameters()
+	 */
 	public @Nullable String getParameterName(int position) {
 		return targetMethodMetadata.getParameterName(position);
 	}
 
-	public void addParameter(ParameterSpec parameter) {
-		this.targetMethodMetadata.addParameter(parameter);
-	}
-
+	/**
+	 * @return the parameter name for the {@link org.springframework.data.domain.Sort sort parameter} or {@code null} if
+	 *         the method does not declare a sort parameter.
+	 */
 	@Nullable
 	public String getSortParameterName() {
 		return getParameterName(queryMethod.getParameters().getSortIndex());
 	}
 
+	/**
+	 * @return the parameter name for the {@link org.springframework.data.domain.Pageable pageable parameter} or
+	 *         {@code null} if the method does not declare a pageable parameter.
+	 */
 	@Nullable
 	public String getPageableParameterName() {
 		return getParameterName(queryMethod.getParameters().getPageableIndex());
 	}
 
+	/**
+	 * @return the parameter name for the {@link org.springframework.data.domain.Limit limit parameter} or {@code null} if
+	 *         the method does not declare a limit parameter.
+	 */
 	@Nullable
 	public String getLimitParameterName() {
 		return getParameterName(queryMethod.getParameters().getLimitIndex());

src/main/java/org/springframework/data/repository/aot/generate/AotRepositoryBuilder.java

@@ -52,6 +52,8 @@
  */
 class AotRepositoryBuilder {
 
+	private static final Log logger = LogFactory.getLog(AotRepositoryBuilder.class);
+
 	private final RepositoryInformation repositoryInformation;
 	private final String moduleName;
 	private final ProjectionFactory projectionFactory;
@@ -74,7 +76,7 @@ private AotRepositoryBuilder(RepositoryInformation repositoryInformation, String
 				.initializer("$T.getLog($T.class)", TypeName.get(LogFactory.class), this.generationMetadata.getTargetTypeName())
 				.build());
 
-		this.customizer = (info, metadata, builder) -> {};
+		this.customizer = (info, builder) -> {};
 	}
 
 	/**
@@ -146,15 +148,21 @@ public AotBundle build() {
 					return it.getDeclaringClass().getName();
 				}).thenComparing(Method::getName).thenComparing(Method::getParameterCount).thenComparing(Method::toString))
 				.forEach(method -> {
-					contributeMethod(method, repositoryComposition, methodMetadata, builder);
+					try {
+						contributeMethod(method, repositoryComposition, methodMetadata, builder);
+					} catch (RuntimeException e) {
+						if (logger.isErrorEnabled()) {
+							logger.error("Failed to contribute Repository method [%s.%s]"
+									.formatted(repositoryInformation.getRepositoryInterface().getName(), method.getName()), e);
+						}
+					}
 				});
 
 		// write fields at the end so we make sure to capture things added by methods
 		generationMetadata.getFields().values().forEach(builder::addField);
 
 		// finally customize the file itself
-		this.customizer.customize(repositoryInformation, generationMetadata, builder);
-
+		this.customizer.customize(repositoryInformation, builder);
 		JavaFile javaFile = JavaFile.builder(packageName(), builder.build()).build();
 		AotRepositoryMetadata metadata = getAotRepositoryMetadata(methodMetadata);
 
@@ -273,11 +281,10 @@ public interface ClassCustomizer {
 		/**
 		 * Apply customization ot the AOT repository fragment class after it has been defined.
 		 *
-		 * @param information repository information.
-		 * @param metadata metadata of the AOT repository fragment.
-		 * @param builder the actual builder.
+		 * @param information the repository information that is used for the AOT fragment.
+		 * @param builder the class builder to be customized.
 		 */
-		void customize(RepositoryInformation information, AotRepositoryFragmentMetadata metadata, TypeSpec.Builder builder);
+		void customize(RepositoryInformation information, TypeSpec.Builder builder);
 
 	}
 

src/main/java/org/springframework/data/repository/aot/generate/AotRepositoryConstructorBuilder.java

@@ -33,26 +33,24 @@
  * @author Mark Paluch
  * @since 4.0
  */
-// TODO: extract constructor contributor in a similar way to MethodContributor.
 public class AotRepositoryConstructorBuilder {
 
 	private final RepositoryInformation repositoryInformation;
 	private final AotRepositoryFragmentMetadata metadata;
 
 	private ConstructorCustomizer customizer = (info, builder) -> {};
 
-	AotRepositoryConstructorBuilder(RepositoryInformation repositoryInformation,
-			AotRepositoryFragmentMetadata metadata) {
+	AotRepositoryConstructorBuilder(RepositoryInformation repositoryInformation, AotRepositoryFragmentMetadata metadata) {
 
 		this.repositoryInformation = repositoryInformation;
 		this.metadata = metadata;
 	}
 
 	/**
-	 * Add constructor parameter.
+	 * Add constructor parameter and create a field storing its value.
 	 *
-	 * @param parameterName
-	 * @param type
+	 * @param parameterName name of the parameter.
+	 * @param type parameter type.
 	 */
 	public void addParameter(String parameterName, Class<?> type) {
 
@@ -61,14 +59,15 @@ public void addParameter(String parameterName, Class<?> type) {
 			addParameter(parameterName, TypeName.get(type));
 			return;
 		}
+
 		addParameter(parameterName, ParameterizedTypeName.get(type, resolvableType.resolveGenerics()));
 	}
 
 	/**
-	 * Add constructor parameter and create a field for it.
+	 * Add constructor parameter and create a field storing its value.
 	 *
-	 * @param parameterName
-	 * @param type
+	 * @param parameterName name of the parameter.
+	 * @param type parameter type.
 	 */
 	public void addParameter(String parameterName, TypeName type) {
 		addParameter(parameterName, type, true);
@@ -77,13 +76,15 @@ public void addParameter(String parameterName, TypeName type) {
 	/**
 	 * Add constructor parameter.
 	 *
-	 * @param parameterName
-	 * @param type
+	 * @param parameterName name of the parameter.
+	 * @param type parameter type.
+	 * @param createField whether to create a field for the parameter and assign its value to the field.
 	 */
 	public void addParameter(String parameterName, TypeName type, boolean createField) {
 
 		this.metadata.addConstructorArgument(parameterName, type, createField ? parameterName : null);
-		if(createField) {
+
+		if (createField) {
 			this.metadata.addField(parameterName, type, Modifier.PRIVATE, Modifier.FINAL);
 		}
 	}
@@ -92,7 +93,7 @@ public void addParameter(String parameterName, TypeName type, boolean createFiel
 	 * Add constructor customizer. Customizer is invoked after adding constructor arguments and before assigning
 	 * constructor arguments to fields.
 	 *
-	 * @param customizer
+	 * @param customizer the customizer with direct access to the {@link MethodSpec.Builder constructor builder}.
 	 */
 	public void customize(ConstructorCustomizer customizer) {
 		this.customizer = customizer;
@@ -109,9 +110,8 @@ MethodSpec buildConstructor() {
 		customizer.customize(repositoryInformation, builder);
 
 		for (Entry<String, ConstructorArgument> parameter : this.metadata.getConstructorArguments().entrySet()) {
-			if(parameter.getValue().isForLocalField()) {
-				builder.addStatement("this.$N = $N", parameter.getKey(),
-					parameter.getKey());
+			if (parameter.getValue().isForLocalField()) {
+				builder.addStatement("this.$N = $N", parameter.getKey(), parameter.getKey());
 			}
 		}
 
@@ -123,7 +123,14 @@ MethodSpec buildConstructor() {
 	 */
 	public interface ConstructorCustomizer {
 
+		/**
+		 * Customize the constructor.
+		 *
+		 * @param information the repository information that is used for the AOT fragment.
+		 * @param builder the constructor builder to be customized.
+		 */
 		void customize(RepositoryInformation information, MethodSpec.Builder builder);
+
 	}
 
 }