Fix client bean naming.

Author: OlgaMaciaszek

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/AbstractInterfaceClientsImportRegistrar.java

@@ -18,19 +18,20 @@
 
 import java.lang.annotation.Annotation;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
 
+import org.springframework.beans.factory.ListableBeanFactory;
 import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition;
 import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.boot.autoconfigure.AutoConfigurationPackages;
 import org.springframework.context.EnvironmentAware;
 import org.springframework.context.ResourceLoaderAware;
 import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider;
 import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
 import org.springframework.core.env.Environment;
 import org.springframework.core.io.ResourceLoader;
-import org.springframework.core.type.AnnotationMetadata;
 import org.springframework.core.type.filter.AnnotationTypeFilter;
-import org.springframework.util.ClassUtils;
 
 /**
  * @author Olga Maciaszek-Sharma
@@ -43,12 +44,12 @@ public abstract class AbstractInterfaceClientsImportRegistrar
 
 	private ResourceLoader resourceLoader;
 
-	protected Set<BeanDefinition> discoverCandidateComponents(AnnotationMetadata metadata) {
+	protected Set<BeanDefinition> discoverCandidateComponents(ListableBeanFactory beanFactory) {
 		Set<BeanDefinition> candidateComponents = new HashSet<>();
 		ClassPathScanningCandidateComponentProvider scanner = getScanner();
 		scanner.setResourceLoader(this.resourceLoader);
 		scanner.addIncludeFilter(new AnnotationTypeFilter(getAnnotation()));
-		Set<String> basePackages = Set.of(ClassUtils.getPackageName(metadata.getClassName()));
+		List<String> basePackages = AutoConfigurationPackages.get(beanFactory);
 		for (String basePackage : basePackages) {
 			candidateComponents.addAll(scanner.findCandidateComponents(basePackage));
 		}

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/HttpClient.java

@@ -30,6 +30,8 @@
 @Documented
 public @interface HttpClient {
 
-	String value() default "";
+	String value();
+
+	String beanName() default "";
 
 }

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/HttpInterfaceClientsImportRegistrar.java

@@ -17,10 +17,12 @@
 package org.springframework.boot.autoconfigure.interfaceclients.http;
 
 import java.lang.annotation.Annotation;
+import java.text.Normalizer;
 import java.util.Set;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.apache.commons.text.CaseUtils;
 
 import org.springframework.beans.factory.ListableBeanFactory;
 import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition;
@@ -33,7 +35,6 @@
 import org.springframework.core.type.AnnotationMetadata;
 import org.springframework.util.Assert;
 import org.springframework.util.ObjectUtils;
-import org.springframework.util.StringUtils;
 
 /**
  * @author Olga Maciaszek-Sharma
@@ -43,19 +44,24 @@ public class HttpInterfaceClientsImportRegistrar extends AbstractInterfaceClient
 
 	private static final Log logger = LogFactory.getLog(HttpInterfaceClientsImportRegistrar.class);
 
+	private static final String INTERFACE_CLIENT_SUFFIX = "InterfaceClient";
+
+	private static final String BEAN_NAME_ATTRIBUTE_NAME = "beanName";
+
 	@Override
 	public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
 		Assert.isInstanceOf(ListableBeanFactory.class, registry,
 				"Registry must be an instance of " + ListableBeanFactory.class.getSimpleName());
-		Set<BeanDefinition> candidateComponents = discoverCandidateComponents(metadata);
+		ListableBeanFactory beanFactory = (ListableBeanFactory) registry;
+		Set<BeanDefinition> candidateComponents = discoverCandidateComponents(beanFactory);
 		for (BeanDefinition candidateComponent : candidateComponents) {
 			if (candidateComponent instanceof AnnotatedBeanDefinition beanDefinition) {
-				AnnotationMetadata annotationMetadata = beanDefinition.getMetadata();
-				Assert.isTrue(annotationMetadata.isInterface(),
+				AnnotationMetadata annotatedBeanMetadata = beanDefinition.getMetadata();
+				Assert.isTrue(annotatedBeanMetadata.isInterface(),
 						getAnnotation().getSimpleName() + "can only be placed on an interface.");
-				MergedAnnotation<? extends Annotation> annotation = annotationMetadata.getAnnotations()
+				MergedAnnotation<? extends Annotation> annotation = annotatedBeanMetadata.getAnnotations()
 					.get(getAnnotation());
-				String beanClassName = annotationMetadata.getClassName();
+				String beanClassName = annotatedBeanMetadata.getClassName();
 				Class<?> beanClass;
 				try {
 					beanClass = Class.forName(beanClassName);
@@ -66,20 +72,31 @@ public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionR
 					}
 					throw new RuntimeException(e);
 				}
-				String clientName = !ObjectUtils.isEmpty(annotation.getString(MergedAnnotation.VALUE))
-						? annotation.getString(MergedAnnotation.VALUE) : StringUtils.uncapitalize(beanClassName);
-				ListableBeanFactory beanFactory = (ListableBeanFactory) registry;
+				// TODO: consider naming conventions: value of the annotation is the
+				// qualifier to look for related beans
+				// TODO: while the actual beanName corresponds to the simple class name
+				// suffixed with InterfaceClient
+				String clientQualifier = annotation.getString(MergedAnnotation.VALUE);
+				String beanName = !ObjectUtils.isEmpty(annotation.getString(BEAN_NAME_ATTRIBUTE_NAME))
+						? annotation.getString(BEAN_NAME_ATTRIBUTE_NAME) : buildBeanName(clientQualifier);
 				HttpInterfaceClientAdapter adapter = beanFactory.getBean(HttpInterfaceClientAdapter.class);
 				BeanDefinition definition = BeanDefinitionBuilder
 					.rootBeanDefinition(ResolvableType.forClass(beanClass),
-							() -> adapter.createClient(beanFactory, clientName, beanClass))
+							() -> adapter.createClient(beanFactory, clientQualifier, beanClass))
 					.getBeanDefinition();
-				registry.registerBeanDefinition(clientName, definition);
+				registry.registerBeanDefinition(beanName, definition);
 
 			}
 		}
 	}
 
+	private String buildBeanName(String clientQualifier) {
+		// TODO: research Normalizer form types
+		String normalised = Normalizer.normalize(clientQualifier, Normalizer.Form.NFD);
+		String camelCased = CaseUtils.toCamelCase(normalised, false, '-', '_');
+		return camelCased + INTERFACE_CLIENT_SUFFIX;
+	}
+
 	@Override
 	protected Class<? extends Annotation> getAnnotation() {
 		return HttpClient.class;