Support parameterizedContainer in bean conditions

Add a `parameterizedContainer` attribute to `ConditionalOnBean` and
`ConditionalOnMissingBean` which can be used to support generic types
when checking for the presence of beans.

Closes gh-14940

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java

@@ -97,4 +97,14 @@ public @interface ConditionalOnBean {
 	 */
 	SearchStrategy search() default SearchStrategy.ALL;
 
+	/**
+	 * Additional classes that may contain the specified bean types within their generic
+	 * parameters. For example, an annotation declaring {@code value=Name.class} and
+	 * {@code parameterizedContainer=NameRegistration.class} would detect both
+	 * {@code Name} and {@code NameRegistration<Name>}.
+	 * @return the container types
+	 * @since 2.1.0
+	 */
+	Class<?>[] parameterizedContainer() default {};
+
 }

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java

@@ -113,4 +113,14 @@ public @interface ConditionalOnMissingBean {
 	 */
 	SearchStrategy search() default SearchStrategy.ALL;
 
+	/**
+	 * Additional classes that may contain the specified bean types within their generic
+	 * parameters. For example, an annotation declaring {@code value=Name.class} and
+	 * {@code parameterizedContainer=NameRegistration.class} would detect both
+	 * {@code Name} and {@code NameRegistration<Name>}.
+	 * @return the container types
+	 * @since 2.1.0
+	 */
+	Class<?>[] parameterizedContainer() default {};
+
 }

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBeanTests.java

@@ -22,6 +22,7 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 import java.util.Date;
+import java.util.function.Consumer;
 
 import org.junit.Test;
 
@@ -30,6 +31,7 @@ import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.beans.factory.support.RootBeanDefinition;
 import org.springframework.boot.test.context.assertj.AssertableApplicationContext;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
@@ -38,6 +40,7 @@ import org.springframework.context.annotation.ImportResource;
 import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
 import org.springframework.core.type.AnnotationMetadata;
 import org.springframework.scheduling.annotation.EnableScheduling;
+import org.springframework.util.StringUtils;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -149,6 +152,89 @@ public class ConditionalOnBeanTests {
 				});
 	}
 
+	@Test
+	public void parameterizedContainerWhenValueIsOfMissingBeanDoesNotMatch() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithoutCustomConfig.class,
+						ParmeterizedConditionWithValueConfig.class)
+				.run((context) -> assertThat(context)
+						.satisfies(exampleBeanRequirement("otherExampleBean")));
+	}
+
+	@Test
+	public void parameterizedContainerWhenValueIsOfExistingBeanMatches() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithCustomConfig.class,
+						ParmeterizedConditionWithValueConfig.class)
+				.run((context) -> assertThat(context).satisfies(exampleBeanRequirement(
+						"customExampleBean", "conditionalCustomExampleBean")));
+	}
+
+	@Test
+	public void parameterizedContainerWhenValueIsOfMissingBeanRegistrationDoesNotMatch() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithoutCustomContainerConfig.class,
+						ParmeterizedConditionWithValueConfig.class)
+				.run((context) -> assertThat(context)
+						.satisfies(exampleBeanRequirement("otherExampleBean")));
+	}
+
+	@Test
+	public void parameterizedContainerWhenValueIsOfExistingBeanRegistrationMatches() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithCustomContainerConfig.class,
+						ParmeterizedConditionWithValueConfig.class)
+				.run((context) -> assertThat(context).satisfies(exampleBeanRequirement(
+						"customExampleBean", "conditionalCustomExampleBean")));
+	}
+
+	@Test
+	public void parameterizedContainerWhenReturnTypeIsOfExistingBeanMatches() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithCustomConfig.class,
+						ParmeterizedConditionWithReturnTypeConfig.class)
+				.run((context) -> assertThat(context).satisfies(exampleBeanRequirement(
+						"customExampleBean", "conditionalCustomExampleBean")));
+	}
+
+	@Test
+	public void parameterizedContainerWhenReturnTypeIsOfExistingBeanRegistrationMatches() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithCustomContainerConfig.class,
+						ParmeterizedConditionWithReturnTypeConfig.class)
+				.run((context) -> assertThat(context).satisfies(exampleBeanRequirement(
+						"customExampleBean", "conditionalCustomExampleBean")));
+	}
+
+	@Test
+	public void parameterizedContainerWhenReturnRegistrationTypeIsOfExistingBeanMatches() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithCustomConfig.class,
+						ParmeterizedConditionWithReturnRegistrationTypeConfig.class)
+				.run((context) -> assertThat(context).satisfies(exampleBeanRequirement(
+						"customExampleBean", "conditionalCustomExampleBean")));
+	}
+
+	@Test
+	public void parameterizedContainerWhenReturnRegistrationTypeIsOfExistingBeanRegistrationMatches() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithCustomContainerConfig.class,
+						ParmeterizedConditionWithReturnRegistrationTypeConfig.class)
+				.run((context) -> assertThat(context).satisfies(exampleBeanRequirement(
+						"customExampleBean", "conditionalCustomExampleBean")));
+	}
+
+	private Consumer<ConfigurableApplicationContext> exampleBeanRequirement(
+			String... names) {
+		return (context) -> {
+			String[] beans = context.getBeanNamesForType(ExampleBean.class);
+			String[] containers = context
+					.getBeanNamesForType(TestParameterizedContainer.class);
+			assertThat(StringUtils.concatenateStringArrays(beans, containers))
+					.containsOnly(names);
+		};
+	}
+
 	@Configuration
 	@ConditionalOnBean(name = "foo")
 	protected static class OnBeanNameConfiguration {
@@ -298,57 +384,146 @@ public class ConditionalOnBeanTests {
 
 	}
 
-	@TestAnnotation
-	public static class ExampleBean {
+	@Configuration
+	public static class OriginalDefinition {
 
-		private String value;
+		@Bean
+		public String testBean() {
+			return "test";
+		}
 
-		public ExampleBean(String value) {
-			this.value = value;
+	}
+
+	@Configuration
+	@ConditionalOnBean(String.class)
+	public static class OverridingDefinition {
+
+		@Bean
+		public Integer testBean() {
+			return 1;
 		}
 
-		@Override
-		public String toString() {
-			return this.value;
+	}
+
+	@Configuration
+	@ConditionalOnBean(String.class)
+	public static class ConsumingConfiguration {
+
+		ConsumingConfiguration(String testBean) {
 		}
 
 	}
 
-	@Target(ElementType.TYPE)
-	@Retention(RetentionPolicy.RUNTIME)
-	@Documented
-	public @interface TestAnnotation {
+	@Configuration
+	static class ParmeterizedWithCustomConfig {
+
+		@Bean
+		public CustomExampleBean customExampleBean() {
+			return new CustomExampleBean();
+		}
 
 	}
 
 	@Configuration
-	public static class OriginalDefinition {
+	static class ParmeterizedWithoutCustomConfig {
 
 		@Bean
-		public String testBean() {
-			return "test";
+		public OtherExampleBean otherExampleBean() {
+			return new OtherExampleBean();
 		}
 
 	}
 
 	@Configuration
-	@ConditionalOnBean(String.class)
-	public static class OverridingDefinition {
+	static class ParmeterizedWithoutCustomContainerConfig {
 
 		@Bean
-		public Integer testBean() {
-			return 1;
+		public TestParameterizedContainer<OtherExampleBean> otherExampleBean() {
+			return new TestParameterizedContainer<OtherExampleBean>();
 		}
 
 	}
 
 	@Configuration
-	@ConditionalOnBean(String.class)
-	public static class ConsumingConfiguration {
+	static class ParmeterizedWithCustomContainerConfig {
 
-		ConsumingConfiguration(String testBean) {
+		@Bean
+		public TestParameterizedContainer<CustomExampleBean> customExampleBean() {
+			return new TestParameterizedContainer<CustomExampleBean>();
+		}
+
+	}
+
+	@Configuration
+	static class ParmeterizedConditionWithValueConfig {
+
+		@Bean
+		@ConditionalOnBean(value = CustomExampleBean.class, parameterizedContainer = TestParameterizedContainer.class)
+		public CustomExampleBean conditionalCustomExampleBean() {
+			return new CustomExampleBean();
+		}
+
+	}
+
+	@Configuration
+	static class ParmeterizedConditionWithReturnTypeConfig {
+
+		@Bean
+		@ConditionalOnBean(parameterizedContainer = TestParameterizedContainer.class)
+		public CustomExampleBean conditionalCustomExampleBean() {
+			return new CustomExampleBean();
+		}
+
+	}
+
+	@Configuration
+	static class ParmeterizedConditionWithReturnRegistrationTypeConfig {
+
+		@Bean
+		@ConditionalOnBean(parameterizedContainer = TestParameterizedContainer.class)
+		public TestParameterizedContainer<CustomExampleBean> conditionalCustomExampleBean() {
+			return new TestParameterizedContainer<CustomExampleBean>();
+		}
+
+	}
+
+	@TestAnnotation
+	public static class ExampleBean {
+
+		private String value;
+
+		public ExampleBean(String value) {
+			this.value = value;
+		}
+
+		@Override
+		public String toString() {
+			return this.value;
 		}
 
 	}
 
+	public static class CustomExampleBean extends ExampleBean {
+
+		public CustomExampleBean() {
+			super("custom subclass");
+		}
+
+	}
+
+	public static class OtherExampleBean extends ExampleBean {
+
+		public OtherExampleBean() {
+			super("other subclass");
+		}
+
+	}
+
+	@Target(ElementType.TYPE)
+	@Retention(RetentionPolicy.RUNTIME)
+	@Documented
+	public @interface TestAnnotation {
+
+	}
+
 }

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBeanTests.java

@@ -22,6 +22,7 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 import java.util.Date;
+import java.util.function.Consumer;
 
 import org.junit.Test;
 
@@ -33,6 +34,7 @@ import org.springframework.boot.autoconfigure.condition.scan.ScannedFactoryBeanC
 import org.springframework.boot.autoconfigure.condition.scan.ScannedFactoryBeanWithBeanMethodArgumentsConfiguration;
 import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.ComponentScan.Filter;
@@ -44,6 +46,7 @@ import org.springframework.context.annotation.ImportResource;
 import org.springframework.core.type.AnnotationMetadata;
 import org.springframework.scheduling.annotation.EnableScheduling;
 import org.springframework.util.Assert;
+import org.springframework.util.StringUtils;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -304,6 +307,89 @@ public class ConditionalOnMissingBeanTests {
 				});
 	}
 
+	@Test
+	public void parameterizedContainerWhenValueIsOfMissingBeanMatches() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithoutCustomConfig.class,
+						ParmeterizedConditionWithValueConfig.class)
+				.run((context) -> assertThat(context).satisfies(exampleBeanRequirement(
+						"otherExampleBean", "conditionalCustomExampleBean")));
+	}
+
+	@Test
+	public void parameterizedContainerWhenValueIsOfExistingBeanDoesNotMatch() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithCustomConfig.class,
+						ParmeterizedConditionWithValueConfig.class)
+				.run((context) -> assertThat(context)
+						.satisfies(exampleBeanRequirement("customExampleBean")));
+	}
+
+	@Test
+	public void parameterizedContainerWhenValueIsOfMissingBeanRegistrationMatches() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithoutCustomContainerConfig.class,
+						ParmeterizedConditionWithValueConfig.class)
+				.run((context) -> assertThat(context).satisfies(exampleBeanRequirement(
+						"otherExampleBean", "conditionalCustomExampleBean")));
+	}
+
+	@Test
+	public void parameterizedContainerWhenValueIsOfExistingBeanRegistrationDoesNotMatch() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithCustomContainerConfig.class,
+						ParmeterizedConditionWithValueConfig.class)
+				.run((context) -> assertThat(context)
+						.satisfies(exampleBeanRequirement("customExampleBean")));
+	}
+
+	@Test
+	public void parameterizedContainerWhenReturnTypeIsOfExistingBeanDoesNotMatch() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithCustomConfig.class,
+						ParmeterizedConditionWithReturnTypeConfig.class)
+				.run((context) -> assertThat(context)
+						.satisfies(exampleBeanRequirement("customExampleBean")));
+	}
+
+	@Test
+	public void parameterizedContainerWhenReturnTypeIsOfExistingBeanRegistrationDoesNotMatch() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithCustomContainerConfig.class,
+						ParmeterizedConditionWithReturnTypeConfig.class)
+				.run((context) -> assertThat(context)
+						.satisfies(exampleBeanRequirement("customExampleBean")));
+	}
+
+	@Test
+	public void parameterizedContainerWhenReturnRegistrationTypeIsOfExistingBeanDoesNotMatch() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithCustomConfig.class,
+						ParmeterizedConditionWithReturnRegistrationTypeConfig.class)
+				.run((context) -> assertThat(context)
+						.satisfies(exampleBeanRequirement("customExampleBean")));
+	}
+
+	@Test
+	public void parameterizedContainerWhenReturnRegistrationTypeIsOfExistingBeanRegistrationDoesNotMatch() {
+		this.contextRunner
+				.withUserConfiguration(ParmeterizedWithCustomContainerConfig.class,
+						ParmeterizedConditionWithReturnRegistrationTypeConfig.class)
+				.run((context) -> assertThat(context)
+						.satisfies(exampleBeanRequirement("customExampleBean")));
+	}
+
+	private Consumer<ConfigurableApplicationContext> exampleBeanRequirement(
+			String... names) {
+		return (context) -> {
+			String[] beans = context.getBeanNamesForType(ExampleBean.class);
+			String[] containers = context
+					.getBeanNamesForType(TestParameterizedContainer.class);
+			assertThat(StringUtils.concatenateStringArrays(beans, containers))
+					.containsOnly(names);
+		};
+	}
+
 	@Configuration
 	protected static class OnBeanInAncestorsConfiguration {
 
@@ -584,30 +670,6 @@ public class ConditionalOnMissingBeanTests {
 
 	}
 
-	@TestAnnotation
-	public static class ExampleBean {
-
-		private String value;
-
-		public ExampleBean(String value) {
-			this.value = value;
-		}
-
-		@Override
-		public String toString() {
-			return this.value;
-		}
-
-	}
-
-	public static class CustomExampleBean extends ExampleBean {
-
-		public CustomExampleBean() {
-			super("custom subclass");
-		}
-
-	}
-
 	public static class ExampleFactoryBean implements FactoryBean<ExampleBean> {
 
 		public ExampleFactoryBean(String value) {
@@ -654,6 +716,111 @@ public class ConditionalOnMissingBeanTests {
 
 	}
 
+	@Configuration
+	static class ParmeterizedWithCustomConfig {
+
+		@Bean
+		public CustomExampleBean customExampleBean() {
+			return new CustomExampleBean();
+		}
+
+	}
+
+	@Configuration
+	static class ParmeterizedWithoutCustomConfig {
+
+		@Bean
+		public OtherExampleBean otherExampleBean() {
+			return new OtherExampleBean();
+		}
+
+	}
+
+	@Configuration
+	static class ParmeterizedWithoutCustomContainerConfig {
+
+		@Bean
+		public TestParameterizedContainer<OtherExampleBean> otherExampleBean() {
+			return new TestParameterizedContainer<OtherExampleBean>();
+		}
+
+	}
+
+	@Configuration
+	static class ParmeterizedWithCustomContainerConfig {
+
+		@Bean
+		public TestParameterizedContainer<CustomExampleBean> customExampleBean() {
+			return new TestParameterizedContainer<CustomExampleBean>();
+		}
+
+	}
+
+	@Configuration
+	static class ParmeterizedConditionWithValueConfig {
+
+		@Bean
+		@ConditionalOnMissingBean(value = CustomExampleBean.class, parameterizedContainer = TestParameterizedContainer.class)
+		public CustomExampleBean conditionalCustomExampleBean() {
+			return new CustomExampleBean();
+		}
+
+	}
+
+	@Configuration
+	static class ParmeterizedConditionWithReturnTypeConfig {
+
+		@Bean
+		@ConditionalOnMissingBean(parameterizedContainer = TestParameterizedContainer.class)
+		public CustomExampleBean conditionalCustomExampleBean() {
+			return new CustomExampleBean();
+		}
+
+	}
+
+	@Configuration
+	static class ParmeterizedConditionWithReturnRegistrationTypeConfig {
+
+		@Bean
+		@ConditionalOnMissingBean(parameterizedContainer = TestParameterizedContainer.class)
+		public TestParameterizedContainer<CustomExampleBean> conditionalCustomExampleBean() {
+			return new TestParameterizedContainer<CustomExampleBean>();
+		}
+
+	}
+
+	@TestAnnotation
+	public static class ExampleBean {
+
+		private String value;
+
+		public ExampleBean(String value) {
+			this.value = value;
+		}
+
+		@Override
+		public String toString() {
+			return this.value;
+		}
+
+	}
+
+	public static class CustomExampleBean extends ExampleBean {
+
+		public CustomExampleBean() {
+			super("custom subclass");
+		}
+
+	}
+
+	public static class OtherExampleBean extends ExampleBean {
+
+		public OtherExampleBean() {
+			super("other subclass");
+		}
+
+	}
+
 	@Target(ElementType.TYPE)
 	@Retention(RetentionPolicy.RUNTIME)
 	@Documented

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/TestParameterizedContainer.java

+/*
+ * Copyright 2012-2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.autoconfigure.condition;
+
+/**
+ * Simple parameterized container for testing {@link ConditionalOnBean} and
+ * {@link ConditionalOnMissingBean}.
+ *
+ * @param <T> The bean type
+ * @author Phillip Webb
+ */
+public class TestParameterizedContainer<T> {
+
+}