Support @scope for @ConfigurationProperties beans

gh-41668

Author: nosan

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationPropertiesBeanRegistrar.java

@@ -16,12 +16,18 @@
 
 package org.springframework.boot.context.properties;
 
+import org.springframework.aop.scope.ScopedProxyUtils;
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.ListableBeanFactory;
-import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.annotation.AnnotatedGenericBeanDefinition;
+import org.springframework.beans.factory.config.BeanDefinitionHolder;
+import org.springframework.beans.factory.support.BeanDefinitionReaderUtils;
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
-import org.springframework.beans.factory.support.RootBeanDefinition;
 import org.springframework.boot.context.properties.bind.BindMethod;
+import org.springframework.context.annotation.AnnotationScopeMetadataResolver;
+import org.springframework.context.annotation.ScopeMetadata;
+import org.springframework.context.annotation.ScopeMetadataResolver;
+import org.springframework.context.annotation.ScopedProxyMode;
 import org.springframework.core.annotation.MergedAnnotation;
 import org.springframework.core.annotation.MergedAnnotations;
 import org.springframework.core.annotation.MergedAnnotations.SearchStrategy;
@@ -42,6 +48,8 @@ final class ConfigurationPropertiesBeanRegistrar {
 
 	private final BeanFactory beanFactory;
 
+	private static final ScopeMetadataResolver scopeMetadataResolver = new AnnotationScopeMetadataResolver();
+
 	ConfigurationPropertiesBeanRegistrar(BeanDefinitionRegistry registry) {
 		this.registry = registry;
 		this.beanFactory = (BeanFactory) this.registry;
@@ -75,17 +83,25 @@ private void registerBeanDefinition(String beanName, Class<?> type,
 			MergedAnnotation<ConfigurationProperties> annotation) {
 		Assert.state(annotation.isPresent(), () -> "No " + ConfigurationProperties.class.getSimpleName()
 				+ " annotation found on  '" + type.getName() + "'.");
-		this.registry.registerBeanDefinition(beanName, createBeanDefinition(beanName, type));
+		BeanDefinitionReaderUtils.registerBeanDefinition(createBeanDefinition(beanName, type), this.registry);
 	}
 
-	private BeanDefinition createBeanDefinition(String beanName, Class<?> type) {
+	private BeanDefinitionHolder createBeanDefinition(String beanName, Class<?> type) {
 		BindMethod bindMethod = ConfigurationPropertiesBean.deduceBindMethod(type);
-		RootBeanDefinition definition = new RootBeanDefinition(type);
+		AnnotatedGenericBeanDefinition definition = new AnnotatedGenericBeanDefinition(type);
 		BindMethodAttribute.set(definition, bindMethod);
 		if (bindMethod == BindMethod.VALUE_OBJECT) {
 			definition.setInstanceSupplier(() -> ConstructorBound.from(this.beanFactory, beanName, type));
 		}
-		return definition;
+		ScopeMetadata metadata = scopeMetadataResolver.resolveScopeMetadata(definition);
+		definition.setScope(metadata.getScopeName());
+		BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(definition, beanName);
+		ScopedProxyMode scopedProxyMode = metadata.getScopedProxyMode();
+		if (scopedProxyMode.equals(ScopedProxyMode.NO)) {
+			return definitionHolder;
+		}
+		boolean proxyTargetClass = scopedProxyMode.equals(ScopedProxyMode.TARGET_CLASS);
+		return ScopedProxyUtils.createScopedProxy(definitionHolder, this.registry, proxyTargetClass);
 	}
 
 }

spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/ConfigurationPropertiesBeanRegistrarTests.java

@@ -20,12 +20,15 @@
 
 import org.junit.jupiter.api.Test;
 
+import org.springframework.aop.scope.ScopedProxyFactoryBean;
+import org.springframework.beans.factory.annotation.AnnotatedGenericBeanDefinition;
 import org.springframework.beans.factory.config.BeanDefinition;
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.beans.factory.support.DefaultListableBeanFactory;
 import org.springframework.beans.factory.support.GenericBeanDefinition;
-import org.springframework.beans.factory.support.RootBeanDefinition;
 import org.springframework.boot.context.properties.bind.BindMethod;
+import org.springframework.context.annotation.Scope;
+import org.springframework.context.annotation.ScopedProxyMode;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
@@ -44,6 +47,31 @@ class ConfigurationPropertiesBeanRegistrarTests {
 	private final ConfigurationPropertiesBeanRegistrar registrar = new ConfigurationPropertiesBeanRegistrar(
 			this.registry);
 
+	@Test
+	void registerScopedBeanDefinition() {
+		String beanName = "scopedbeancp-" + ScopedBeanConfigurationProperties.class.getName();
+		this.registrar.register(ScopedBeanConfigurationProperties.class);
+		BeanDefinition beanDefinition = this.registry.getBeanDefinition(beanName);
+		assertThat(beanDefinition).isNotNull();
+		assertThat(beanDefinition.getBeanClassName()).isEqualTo(ScopedBeanConfigurationProperties.class.getName());
+		assertThat(beanDefinition.getScope()).isEqualTo(BeanDefinition.SCOPE_PROTOTYPE);
+	}
+
+	@Test
+	void registerScopedBeanDefinitionWithProxyMode() {
+		String beanName = "scopedbeancp-" + ProxyScopedBeanConfigurationProperties.class.getName();
+		this.registrar.register(ProxyScopedBeanConfigurationProperties.class);
+		BeanDefinition proxiedBeanDefinition = this.registry.getBeanDefinition(beanName);
+		assertThat(proxiedBeanDefinition).isNotNull();
+		assertThat(proxiedBeanDefinition.getBeanClassName()).isEqualTo(ScopedProxyFactoryBean.class.getName());
+		String targetBeanName = (String) proxiedBeanDefinition.getPropertyValues().get("targetBeanName");
+		assertThat(targetBeanName).isNotNull();
+		BeanDefinition beanDefinition = this.registry.getBeanDefinition(targetBeanName);
+		assertThat(beanDefinition).isNotNull();
+		assertThat(beanDefinition.getBeanClassName()).isEqualTo(ProxyScopedBeanConfigurationProperties.class.getName());
+		assertThat(beanDefinition.getScope()).isEqualTo(BeanDefinition.SCOPE_PROTOTYPE);
+	}
+
 	@Test
 	void registerWhenNotAlreadyRegisteredAddBeanDefinition() {
 		String beanName = "beancp-" + BeanConfigurationProperties.class.getName();
@@ -88,7 +116,7 @@ void registerWhenNotValueObjectRegistersRootBeanDefinitionWithJavaBeanBindMethod
 
 	private Consumer<BeanDefinition> configurationPropertiesBeanDefinition(BindMethod bindMethod) {
 		return (definition) -> {
-			assertThat(definition).isExactlyInstanceOf(RootBeanDefinition.class);
+			assertThat(definition).isExactlyInstanceOf(AnnotatedGenericBeanDefinition.class);
 			assertThat(definition.hasAttribute(BindMethod.class.getName())).isTrue();
 			assertThat(definition.getAttribute(BindMethod.class.getName())).isEqualTo(bindMethod);
 		};
@@ -99,6 +127,18 @@ static class BeanConfigurationProperties {
 
 	}
 
+	@ConfigurationProperties(prefix = "scopedbeancp")
+	@Scope("prototype")
+	static class ScopedBeanConfigurationProperties {
+
+	}
+
+	@ConfigurationProperties(prefix = "scopedbeancp")
+	@Scope(proxyMode = ScopedProxyMode.TARGET_CLASS, value = "prototype")
+	static class ProxyScopedBeanConfigurationProperties {
+
+	}
+
 	static class NoAnnotationConfigurationProperties {
 
 	}