Merge pull request #17020 from nosan

* gh-17020:
  Polish "Allow depended on beans to be identified by type"
  Allow depended on beans to be identified by type

Closes gh-17020

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

@@ -18,7 +18,10 @@ package org.springframework.boot.autoconfigure;
 
 import java.util.Arrays;
 import java.util.HashSet;
+import java.util.LinkedHashSet;
 import java.util.Set;
+import java.util.function.Function;
+import java.util.stream.Collectors;
 
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.BeanFactoryUtils;
@@ -32,13 +35,14 @@ import org.springframework.util.StringUtils;
 
 /**
  * Abstract base class for a {@link BeanFactoryPostProcessor} that can be used to
- * dynamically declare that all beans of a specific type should depend on one or more
- * specific beans.
+ * dynamically declare that all beans of a specific type should depend on specific other
+ * beans identified by name or type.
  *
  * @author Marcel Overdijk
  * @author Dave Syer
  * @author Phillip Webb
  * @author Andy Wilkinson
+ * @author Dmytro Nosan
  * @since 1.3.0
  * @see BeanDefinition#setDependsOn(String[])
  */
@@ -48,13 +52,29 @@ public abstract class AbstractDependsOnBeanFactoryPostProcessor implements BeanF
 
 	private final Class<? extends FactoryBean<?>> factoryBeanClass;
 
-	private final String[] dependsOn;
+	private final Function<ListableBeanFactory, Set<String>> dependsOn;
 
 	protected AbstractDependsOnBeanFactoryPostProcessor(Class<?> beanClass,
 			Class<? extends FactoryBean<?>> factoryBeanClass, String... dependsOn) {
 		this.beanClass = beanClass;
 		this.factoryBeanClass = factoryBeanClass;
-		this.dependsOn = dependsOn;
+		this.dependsOn = (beanFactory) -> new HashSet<>(Arrays.asList(dependsOn));
+	}
+
+	/**
+	 * Create an instance with target bean and factory bean classes and dependency types.
+	 * @param beanClass target bean class
+	 * @param factoryBeanClass target factory bean class
+	 * @param dependencyTypes dependency types
+	 * @since 2.1.7
+	 */
+	protected AbstractDependsOnBeanFactoryPostProcessor(Class<?> beanClass,
+			Class<? extends FactoryBean<?>> factoryBeanClass, Class<?>... dependencyTypes) {
+		this.beanClass = beanClass;
+		this.factoryBeanClass = factoryBeanClass;
+		this.dependsOn = (beanFactory) -> Arrays.stream(dependencyTypes)
+				.flatMap((dependencyType) -> getBeanNames(beanFactory, dependencyType).stream())
+				.collect(Collectors.toSet());
 	}
 
 	/**
@@ -67,31 +87,42 @@ public abstract class AbstractDependsOnBeanFactoryPostProcessor implements BeanF
 		this(beanClass, null, dependsOn);
 	}
 
+	/**
+	 * Create an instance with target bean class and dependency types.
+	 * @param beanClass target bean class
+	 * @param dependencyTypes dependency types
+	 * @since 2.1.7
+	 */
+	protected AbstractDependsOnBeanFactoryPostProcessor(Class<?> beanClass, Class<?>... dependencyTypes) {
+		this(beanClass, null, dependencyTypes);
+	}
+
 	@Override
 	public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {
 		for (String beanName : getBeanNames(beanFactory)) {
 			BeanDefinition definition = getBeanDefinition(beanName, beanFactory);
 			String[] dependencies = definition.getDependsOn();
-			for (String bean : this.dependsOn) {
-				dependencies = StringUtils.addStringToArray(dependencies, bean);
+			for (String dependencyName : this.dependsOn.apply(beanFactory)) {
+				dependencies = StringUtils.addStringToArray(dependencies, dependencyName);
 			}
 			definition.setDependsOn(dependencies);
 		}
 	}
 
-	private Iterable<String> getBeanNames(ListableBeanFactory beanFactory) {
-		Set<String> names = new HashSet<>();
-		names.addAll(Arrays
-				.asList(BeanFactoryUtils.beanNamesForTypeIncludingAncestors(beanFactory, this.beanClass, true, false)));
+	private Set<String> getBeanNames(ListableBeanFactory beanFactory) {
+		Set<String> names = getBeanNames(beanFactory, this.beanClass);
 		if (this.factoryBeanClass != null) {
-			for (String factoryBeanName : BeanFactoryUtils.beanNamesForTypeIncludingAncestors(beanFactory,
-					this.factoryBeanClass, true, false)) {
-				names.add(BeanFactoryUtils.transformedBeanName(factoryBeanName));
-			}
+			names.addAll(getBeanNames(beanFactory, this.factoryBeanClass));
 		}
 		return names;
 	}
 
+	private static Set<String> getBeanNames(ListableBeanFactory beanFactory, Class<?> beanClass) {
+		String[] names = BeanFactoryUtils.beanNamesForTypeIncludingAncestors(beanFactory, beanClass, true, false);
+		return Arrays.stream(names).map(BeanFactoryUtils::transformedBeanName)
+				.collect(Collectors.toCollection(LinkedHashSet::new));
+	}
+
 	private static BeanDefinition getBeanDefinition(String beanName, ConfigurableListableBeanFactory beanFactory) {
 		try {
 			return beanFactory.getBeanDefinition(beanName);

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

+/*
+ * Copyright 2012-2019 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
+ *
+ *      https://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;
+
+import org.junit.Test;
+
+import org.springframework.beans.factory.BeanFactory;
+import org.springframework.beans.factory.FactoryBean;
+import org.springframework.beans.factory.NoSuchBeanDefinitionException;
+import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
+import org.springframework.boot.test.context.assertj.AssertableApplicationContext;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link AbstractDependsOnBeanFactoryPostProcessor}.
+ *
+ * @author Dmytro Nosan
+ */
+public class AbstractDependsOnBeanFactoryPostProcessorTests {
+
+	private ApplicationContextRunner contextRunner = new ApplicationContextRunner()
+			.withUserConfiguration(FooBarConfiguration.class);
+
+	@Test
+	public void fooBeansShouldDependOnBarBeanNames() {
+		this.contextRunner
+				.withUserConfiguration(FooDependsOnBarNamePostProcessor.class, FooBarFactoryBeanConfiguration.class)
+				.run(this::assertThatFooDependsOnBar);
+	}
+
+	@Test
+	public void fooBeansShouldDependOnBarBeanTypes() {
+		this.contextRunner
+				.withUserConfiguration(FooDependsOnBarTypePostProcessor.class, FooBarFactoryBeanConfiguration.class)
+				.run(this::assertThatFooDependsOnBar);
+	}
+
+	@Test
+	public void fooBeansShouldDependOnBarBeanNamesParentContext() {
+		try (AnnotationConfigApplicationContext parentContext = new AnnotationConfigApplicationContext(
+				FooBarFactoryBeanConfiguration.class)) {
+			this.contextRunner.withUserConfiguration(FooDependsOnBarNamePostProcessor.class).withParent(parentContext)
+					.run(this::assertThatFooDependsOnBar);
+		}
+	}
+
+	@Test
+	public void fooBeansShouldDependOnBarBeanTypesParentContext() {
+		try (AnnotationConfigApplicationContext parentContext = new AnnotationConfigApplicationContext(
+				FooBarFactoryBeanConfiguration.class)) {
+			this.contextRunner.withUserConfiguration(FooDependsOnBarTypePostProcessor.class).withParent(parentContext)
+					.run(this::assertThatFooDependsOnBar);
+		}
+	}
+
+	private void assertThatFooDependsOnBar(AssertableApplicationContext context) {
+		ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
+		assertThat(getBeanDefinition("foo", beanFactory).getDependsOn()).containsExactly("bar", "barFactoryBean");
+		assertThat(getBeanDefinition("fooFactoryBean", beanFactory).getDependsOn()).containsExactly("bar",
+				"barFactoryBean");
+	}
+
+	private BeanDefinition getBeanDefinition(String beanName, ConfigurableListableBeanFactory beanFactory) {
+		try {
+			return beanFactory.getBeanDefinition(beanName);
+		}
+		catch (NoSuchBeanDefinitionException ex) {
+			BeanFactory parentBeanFactory = beanFactory.getParentBeanFactory();
+			if (parentBeanFactory instanceof ConfigurableListableBeanFactory) {
+				return getBeanDefinition(beanName, (ConfigurableListableBeanFactory) parentBeanFactory);
+			}
+			throw ex;
+		}
+	}
+
+	static class Foo {
+
+	}
+
+	static class Bar {
+
+	}
+
+	@Configuration
+	static class FooBarFactoryBeanConfiguration {
+
+		@Bean
+		public FooFactoryBean fooFactoryBean() {
+			return new FooFactoryBean();
+		}
+
+		@Bean
+		public BarFactoryBean barFactoryBean() {
+			return new BarFactoryBean();
+		}
+
+	}
+
+	@Configuration
+	static class FooBarConfiguration {
+
+		@Bean
+		public Bar bar() {
+			return new Bar();
+		}
+
+		@Bean
+		public Foo foo() {
+			return new Foo();
+		}
+
+	}
+
+	static class FooDependsOnBarTypePostProcessor extends AbstractDependsOnBeanFactoryPostProcessor {
+
+		protected FooDependsOnBarTypePostProcessor() {
+			super(Foo.class, FooFactoryBean.class, Bar.class, BarFactoryBean.class);
+		}
+
+	}
+
+	static class FooDependsOnBarNamePostProcessor extends AbstractDependsOnBeanFactoryPostProcessor {
+
+		protected FooDependsOnBarNamePostProcessor() {
+			super(Foo.class, FooFactoryBean.class, "bar", "barFactoryBean");
+		}
+
+	}
+
+	static class FooFactoryBean implements FactoryBean<Foo> {
+
+		@Override
+		public Foo getObject() {
+			return new Foo();
+		}
+
+		@Override
+		public Class<?> getObjectType() {
+			return Foo.class;
+		}
+
+	}
+
+	static class BarFactoryBean implements FactoryBean<Bar> {
+
+		@Override
+		public Bar getObject() {
+			return new Bar();
+		}
+
+		@Override
+		public Class<?> getObjectType() {
+			return Bar.class;
+		}
+
+	}
+
+}