Improve searching for qualified beans. Clean up RestClient-based implementation. Make autoconfiguration conditional on property.

Author: OlgaMaciaszek

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

@@ -18,7 +18,6 @@
 
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.FactoryBean;
-import org.springframework.beans.factory.InitializingBean;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ApplicationContextAware;
 import org.springframework.context.ConfigurableApplicationContext;
@@ -27,8 +26,7 @@
 /**
  * @author Olga Maciaszek-Sharma
  */
-public abstract class AbstractInterfaceClientsFactoryBean
-		implements FactoryBean<Object>, ApplicationContextAware, InitializingBean {
+public abstract class AbstractInterfaceClientsFactoryBean implements FactoryBean<Object>, ApplicationContextAware {
 
 	protected Class<?> type;
 
@@ -38,20 +36,6 @@ public abstract class AbstractInterfaceClientsFactoryBean
 
 	protected ConfigurableApplicationContext applicationContext;
 
-	public AbstractInterfaceClientsFactoryBean() {
-	}
-
-	// TODO
-	@Override
-	public Object getObject() throws Exception {
-		throw new UnsupportedOperationException("Please, implement me.");
-	}
-
-	@Override
-	public void afterPropertiesSet() throws Exception {
-		Assert.notNull(this.type, "Type must not be null");
-	}
-
 	@Override
 	public Class<?> getObjectType() {
 		return this.type;

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

@@ -22,8 +22,6 @@
 import java.util.List;
 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;
@@ -49,6 +47,7 @@
 import org.springframework.util.ObjectUtils;
 
 /**
+ * @author Josh Long
  * @author Olga Maciaszek-Sharma
  */
 // TODO: Handle AOT
@@ -91,21 +90,9 @@ private void registerInterfaceClient(BeanDefinitionRegistry registry, AnnotatedB
 				getAnnotation().getSimpleName() + "can only be placed on an interface.");
 		MergedAnnotation<? extends Annotation> annotation = annotatedBeanMetadata.getAnnotations().get(getAnnotation());
 		String beanClassName = annotatedBeanMetadata.getClassName();
-		// Class<?> beanClass;
-		// try {
-		// beanClass = Class.forName(beanClassName);
-		// }
-		// catch (ClassNotFoundException e) {
-		// if (logger.isDebugEnabled()) {
-		// logger.debug("Class not found for interface client " + beanClassName + ": " +
-		// e.getMessage());
-		// }
-		// throw new RuntimeException(e);
-		// }
-		// 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
+		// The value of the annotation is the qualifier to look for related beans
+		// while the default beanName corresponds to the simple class name suffixed with
+		// `InterfaceClient`
 		String clientId = annotation.getString(MergedAnnotation.VALUE);
 		String beanName = !ObjectUtils.isEmpty(annotation.getString(BEAN_NAME_ATTRIBUTE_NAME))
 				? annotation.getString(BEAN_NAME_ATTRIBUTE_NAME) : buildBeanName(clientId);

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

@@ -37,14 +37,9 @@
 @AutoConfiguration(after = { RestTemplateAutoConfiguration.class, RestClientAutoConfiguration.class,
 		WebClientAutoConfiguration.class })
 @EnableConfigurationProperties(HttpInterfaceClientsProperties.class)
+@ConditionalOnProperty(value = "spring.interfaceclients.enabled", havingValue = "true")
 public class HttpInterfaceClientsAutoConfiguration {
 
-	// @Bean
-	// HttpInterfaceClientsAdapter httpInterfaceClientAdapter(HttpExchangeAdapterProvider
-	// adapterProvider) {
-	// return new HttpInterfaceClientsAdapter(adapterProvider);
-	// }
-
 	@Configuration(proxyBeanMethods = false)
 	@ConditionalOnClass({ RestClient.class, RestClientAdapter.class, HttpServiceProxyFactory.class })
 	@Conditional(NotReactiveWebApplicationCondition.class)

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

@@ -24,13 +24,8 @@
 
 import org.springframework.beans.factory.BeanFactoryUtils;
 import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
-import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition;
 import org.springframework.beans.factory.annotation.Qualifier;
-import org.springframework.beans.factory.config.BeanDefinition;
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
-import org.springframework.core.annotation.AnnotationAttributes;
-import org.springframework.core.annotation.MergedAnnotation;
-import org.springframework.core.type.MethodMetadata;
 
 /**
  * @author Olga Maciaszek-Sharma
@@ -67,20 +62,9 @@ private static <T> Map<String, T> getQualifiedBeansOfType(ConfigurableListableBe
 		Map<String, T> beansOfType = BeanFactoryUtils.beansOfTypeIncludingAncestors(beanFactory, type);
 		Map<String, T> matchingClientBeans = new HashMap<>();
 		for (String beanName : beansOfType.keySet()) {
-			BeanDefinition beanDefinition = beanFactory.getBeanDefinition(beanName);
-			if (beanDefinition instanceof AnnotatedBeanDefinition definition) {
-				// TODO: try refactoring this
-				// TODO: beans defined in a different way
-				// AnnotationAttributes annotationAttributes = AnnotationAttributes
-				// .fromMap(definition.getMetadata().getAnnotationAttributes(Qualifier.class.getName()));
-				MethodMetadata methodMetadata = definition.getFactoryMethodMetadata();
-				AnnotationAttributes annotationAttributes = methodMetadata != null ? AnnotationAttributes
-					.fromMap(methodMetadata.getAnnotationAttributes(Qualifier.class.getName())) : null;
-				if (annotationAttributes != null
-						&& clientId.equals(annotationAttributes.getString(MergedAnnotation.VALUE))) {
-					matchingClientBeans.put(beanName, beansOfType.get(beanName));
-				}
-
+			Qualifier qualifier = (beanFactory.findAnnotationOnBean(beanName, Qualifier.class));
+			if (qualifier != null && clientId.equals(qualifier.value())) {
+				matchingClientBeans.put(beanName, beanFactory.getBean(beanName, type));
 			}
 		}
 		return matchingClientBeans;

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

@@ -16,10 +16,19 @@
 
 package org.springframework.boot.autoconfigure.interfaceclients.http;
 
+import java.lang.annotation.Annotation;
+
+import org.springframework.boot.autoconfigure.interfaceclients.AbstractInterfaceClientsImportRegistrar;
+
 /**
  * @author Olga Maciaszek-Sharma
  */
-public class RestClientInterfaceClientsImportRegistrar extends HttpInterfaceClientsImportRegistrar {
+public class RestClientInterfaceClientsImportRegistrar extends AbstractInterfaceClientsImportRegistrar {
+
+	@Override
+	protected Class<? extends Annotation> getAnnotation() {
+		return HttpClient.class;
+	}
 
 	@Override
 	protected Class<?> getFactoryBeanClass() {

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

@@ -1611,6 +1611,12 @@
       "name": "spring.info.git.location",
       "defaultValue": "classpath:git.properties"
     },
+    {
+      "name": "spring.interfaceclients.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Whether to automatically instantiate client beans from annotated interfaces.",
+      "defaultValue": true
+    },
     {
       "name": "spring.interfaceclients.resttemplate.enabled",
       "type": "java.lang.Boolean",