Force user-defined member beans instantiation.

OlgaMaciaszek · OlgaMaciaszek · commit 305e39a0e6f8 · 2024-08-14T20:50:14.000+02:00
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/AbstractInterfaceClientsFactoryBean.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/AbstractInterfaceClientsFactoryBean.java
@@ -21,6 +21,7 @@
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ApplicationContextAware;
+import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.util.Assert;
 
 /**
@@ -35,7 +36,7 @@ public abstract class AbstractInterfaceClientsFactoryBean
 
 	protected String clientId;
 
-	protected ApplicationContext applicationContext;
+	protected ConfigurableApplicationContext applicationContext;
 
 	public AbstractInterfaceClientsFactoryBean() {
 	}
@@ -58,7 +59,9 @@ public Class<?> getObjectType() {
 
 	@Override
 	public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
-		this.applicationContext = applicationContext;
+		Assert.isInstanceOf(ConfigurableApplicationContext.class, applicationContext,
+				"ApplicationContext must be an instance of " + ConfigurableApplicationContext.class.getSimpleName());
+		this.applicationContext = (ConfigurableApplicationContext) applicationContext;
 
 	}
 
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/AbstractInterfaceClientsImportRegistrar.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/AbstractInterfaceClientsImportRegistrar.java
@@ -58,7 +58,6 @@ public abstract class AbstractInterfaceClientsImportRegistrar
 
 	// TODO: work on IntelliJ plugin /other plugins/ to show that the client beans are
 	// autoconfigured
-	private static final Log logger = LogFactory.getLog(AbstractInterfaceClientsImportRegistrar.class);
 
 	private static final String INTERFACE_CLIENT_SUFFIX = "InterfaceClient";
 
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/InterfaceClientsAdapter.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/InterfaceClientsAdapter.java
@@ -17,6 +17,7 @@
 package org.springframework.boot.autoconfigure.interfaceclients;
 
 import org.springframework.beans.factory.ListableBeanFactory;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.core.Ordered;
 
 /**
@@ -27,6 +28,6 @@ public interface InterfaceClientsAdapter extends Ordered {
 
 	String DEFAULT_QUALIFIER = "interfaceClients";
 
-	<T> T createClient(ListableBeanFactory beanFactory, String clientId, Class<T> type);
+	<T> T createClient(ConfigurableListableBeanFactory beanFactory, String clientId, Class<T> type);
 
 }
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/AbstractHttpInterfaceClientsFactoryBean.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/AbstractHttpInterfaceClientsFactoryBean.java
@@ -37,8 +37,8 @@ public Object getObject() throws Exception {
 	}
 
 	private HttpServiceProxyFactory proxyFactory() {
-		HttpServiceProxyFactory userProvidedProxyFactory = QualifiedBeanProvider.qualifiedBean(this.applicationContext,
-				HttpServiceProxyFactory.class, this.clientId);
+		HttpServiceProxyFactory userProvidedProxyFactory = QualifiedBeanProvider
+			.qualifiedBean(this.applicationContext.getBeanFactory(), HttpServiceProxyFactory.class, this.clientId);
 		if (userProvidedProxyFactory != null) {
 			return userProvidedProxyFactory;
 		}
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/HttpExchangeAdapterProvider.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/HttpExchangeAdapterProvider.java
@@ -16,7 +16,7 @@
 
 package org.springframework.boot.autoconfigure.interfaceclients.http;
 
-import org.springframework.beans.factory.ListableBeanFactory;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.web.service.invoker.HttpExchangeAdapter;
 
 /**
@@ -26,6 +26,6 @@
 public interface HttpExchangeAdapterProvider {
 
 	// TODO: try a less specific type for the beanFactory
-	HttpExchangeAdapter get(ListableBeanFactory beanFactory, String clientId);
+	HttpExchangeAdapter get(ConfigurableListableBeanFactory beanFactory, String clientId);
 
 }
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/HttpInterfaceClientsAdapter.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/HttpInterfaceClientsAdapter.java
@@ -20,6 +20,7 @@
 import org.apache.commons.logging.LogFactory;
 
 import org.springframework.beans.factory.ListableBeanFactory;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.boot.autoconfigure.interfaceclients.InterfaceClientsAdapter;
 import org.springframework.web.service.invoker.HttpExchangeAdapter;
 import org.springframework.web.service.invoker.HttpServiceProxyFactory;
@@ -38,13 +39,13 @@ public HttpInterfaceClientsAdapter(HttpExchangeAdapterProvider adapterProvider)
 	}
 
 	@Override
-	public <T> T createClient(ListableBeanFactory beanFactory, String clientId, Class<T> type) {
+	public <T> T createClient(ConfigurableListableBeanFactory beanFactory, String clientId, Class<T> type) {
 		HttpServiceProxyFactory proxyFactory = proxyFactory(beanFactory, clientId);
 
 		return proxyFactory.createClient(type);
 	}
 
-	private HttpServiceProxyFactory proxyFactory(ListableBeanFactory beanFactory, String clientId) {
+	private HttpServiceProxyFactory proxyFactory(ConfigurableListableBeanFactory beanFactory, String clientId) {
 		HttpServiceProxyFactory userProvidedProxyFactory = QualifiedBeanProvider.qualifiedBean(beanFactory,
 				HttpServiceProxyFactory.class, clientId);
 		if (userProvidedProxyFactory != null) {
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/QualifiedBeanProvider.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/QualifiedBeanProvider.java
@@ -16,15 +16,21 @@
 
 package org.springframework.boot.autoconfigure.interfaceclients.http;
 
+import java.util.HashMap;
 import java.util.Map;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
-import org.springframework.beans.factory.ListableBeanFactory;
+import org.springframework.beans.factory.BeanFactoryUtils;
 import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
-
-import static org.springframework.beans.factory.annotation.BeanFactoryAnnotationUtils.qualifiedBeansOfType;
+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
@@ -33,16 +39,16 @@ final class QualifiedBeanProvider {
 
 	private static final Log logger = LogFactory.getLog(QualifiedBeanProvider.class);
 
-	static <T> T qualifiedBean(ListableBeanFactory beanFactory, Class<T> type, String clientId) {
-		Map<String, T> matchingClientBeans = qualifiedBeansOfType(beanFactory, type, clientId);
+	static <T> T qualifiedBean(ConfigurableListableBeanFactory beanFactory, Class<T> type, String clientId) {
+		Map<String, T> matchingClientBeans = getQualifiedBeansOfType(beanFactory, type, clientId);
 		if (matchingClientBeans.size() > 1) {
 			throw new NoUniqueBeanDefinitionException(type, matchingClientBeans.keySet());
 		}
 		if (matchingClientBeans.isEmpty()) {
 			if (logger.isDebugEnabled()) {
 				logger.debug("No qualified bean of type " + type + " found for " + clientId);
 			}
-			Map<String, T> matchingDefaultBeans = qualifiedBeansOfType(beanFactory, type, clientId);
+			Map<String, T> matchingDefaultBeans = getQualifiedBeansOfType(beanFactory, type, clientId);
 			if (matchingDefaultBeans.size() > 1) {
 				throw new NoUniqueBeanDefinitionException(type, matchingDefaultBeans.keySet());
 			}
@@ -56,4 +62,28 @@ static <T> T qualifiedBean(ListableBeanFactory beanFactory, Class<T> type, Strin
 		return matchingClientBeans.values().iterator().next();
 	}
 
+	private static <T> Map<String, T> getQualifiedBeansOfType(ConfigurableListableBeanFactory beanFactory,
+			Class<T> type, String clientId) {
+		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));
+				}
+
+			}
+		}
+		return matchingClientBeans;
+	}
+
 }
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/RestClientAdapterProvider.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/RestClientAdapterProvider.java
@@ -21,6 +21,7 @@
 
 import org.springframework.beans.factory.ListableBeanFactory;
 import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.web.client.RestClient;
 import org.springframework.web.client.support.RestClientAdapter;
 import org.springframework.web.service.invoker.HttpExchangeAdapter;
@@ -43,7 +44,7 @@ public RestClientAdapterProvider(RestClient.Builder builder,
 	}
 
 	@Override
-	public HttpExchangeAdapter get(ListableBeanFactory beanFactory, String clientId) {
+	public HttpExchangeAdapter get(ConfigurableListableBeanFactory beanFactory, String clientId) {
 		RestClient userProvidedRestClient = QualifiedBeanProvider.qualifiedBean(beanFactory, RestClient.class,
 				clientId);
 		if (userProvidedRestClient != null) {
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/RestClientInterfaceClientsFactoryBean.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/RestClientInterfaceClientsFactoryBean.java
@@ -38,17 +38,17 @@ protected HttpExchangeAdapter exchangeAdapter() {
 		// it should not be set in properties.
 		String baseUrl = properties.getProperties(this.clientId).getBaseUrl();
 
-		RestClient userProvidedRestClient = QualifiedBeanProvider.qualifiedBean(this.applicationContext,
-				RestClient.class, this.clientId);
+		RestClient userProvidedRestClient = QualifiedBeanProvider
+			.qualifiedBean(this.applicationContext.getBeanFactory(), RestClient.class, this.clientId);
 		if (userProvidedRestClient != null) {
 			if (baseUrl != null) {
 				userProvidedRestClient = userProvidedRestClient.mutate().baseUrl(baseUrl).build();
 			}
 			return RestClientAdapter.create(userProvidedRestClient);
 		}
 
-		RestClient.Builder userProvidedRestClientBuilder = QualifiedBeanProvider.qualifiedBean(this.applicationContext,
-				RestClient.Builder.class, this.clientId);
+		RestClient.Builder userProvidedRestClientBuilder = QualifiedBeanProvider
+			.qualifiedBean(this.applicationContext.getBeanFactory(), RestClient.Builder.class, this.clientId);
 		if (userProvidedRestClientBuilder != null) {
 
 			if (baseUrl != null) {
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/RestTemplateAdapterProvider.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/RestTemplateAdapterProvider.java
@@ -19,8 +19,8 @@
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
-import org.springframework.beans.factory.ListableBeanFactory;
 import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.boot.web.client.RestTemplateBuilder;
 import org.springframework.web.client.RestTemplate;
 import org.springframework.web.client.support.RestTemplateAdapter;
@@ -44,7 +44,7 @@ public RestTemplateAdapterProvider(RestTemplateBuilder restTemplateBuilder,
 	}
 
 	@Override
-	public HttpExchangeAdapter get(ListableBeanFactory beanFactory, String clientId) {
+	public HttpExchangeAdapter get(ConfigurableListableBeanFactory beanFactory, String clientId) {
 		RestTemplate userProvidedRestTemplate = QualifiedBeanProvider.qualifiedBean(beanFactory, RestTemplate.class,
 				clientId);
 		if (userProvidedRestTemplate != null) {
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/WebClientAdapterProvider.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/interfaceclients/http/WebClientAdapterProvider.java
@@ -21,6 +21,7 @@
 
 import org.springframework.beans.factory.ListableBeanFactory;
 import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.web.reactive.function.client.WebClient;
 import org.springframework.web.reactive.function.client.support.WebClientAdapter;
 import org.springframework.web.service.invoker.HttpExchangeAdapter;
@@ -43,7 +44,7 @@ public WebClientAdapterProvider(WebClient.Builder builder,
 	}
 
 	@Override
-	public HttpExchangeAdapter get(ListableBeanFactory beanFactory, String clientId) {
+	public HttpExchangeAdapter get(ConfigurableListableBeanFactory beanFactory, String clientId) {
 		WebClient userProvidedWebClient = QualifiedBeanProvider.qualifiedBean(beanFactory, WebClient.class, clientId);
 		if (userProvidedWebClient != null) {
 			return WebClientAdapter.create(userProvidedWebClient);

Original file line number	Diff line number	Diff line change
`@@ -37,8 +37,8 @@ public Object getObject() throws Exception {`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`private HttpServiceProxyFactory proxyFactory() {`
`40`		`- HttpServiceProxyFactory userProvidedProxyFactory = QualifiedBeanProvider.qualifiedBean(this.applicationContext,`
`41`		`- HttpServiceProxyFactory.class, this.clientId);`
	`40`	`+ HttpServiceProxyFactory userProvidedProxyFactory = QualifiedBeanProvider`
	`41`	`+ .qualifiedBean(this.applicationContext.getBeanFactory(), HttpServiceProxyFactory.class, this.clientId);`
`42`	`42`	`if (userProvidedProxyFactory != null) {`
`43`	`43`	`return userProvidedProxyFactory;`
`44`	`44`	`}`