From 0d2bfc926f425c1c1219e38e5f06a5a9dca04e13 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Fri, 9 Sep 2022 16:52:20 +0200 Subject: [PATCH] Apply consistent ordering in hierarchical contexts Previously, if `@Order` is specified on a `@Bean` method, and the candidate bean is defined in a parent context, its order wasn't taken into account when retrieving the bean from a child context. This commit makes sure the metadata of a bean is taken into consideration in all cases. Closes gh-29105 --- .../support/DefaultListableBeanFactory.java | 25 +++--- .../DefaultListableBeanFactoryTests.java | 15 ++++ .../context/annotation/Gh29105Tests.java | 81 +++++++++++++++++++ 3 files changed, 111 insertions(+), 10 deletions(-) create mode 100644 spring-context/src/test/java/org/springframework/context/annotation/Gh29105Tests.java diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java index 53084373a6..1d65384d4a 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java @@ -2167,20 +2167,25 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto @Nullable public Object getOrderSource(Object obj) { String beanName = this.instancesToBeanNames.get(obj); - if (beanName == null || !containsBeanDefinition(beanName)) { + if (beanName == null) { return null; } - RootBeanDefinition beanDefinition = getMergedLocalBeanDefinition(beanName); - List sources = new ArrayList<>(2); - Method factoryMethod = beanDefinition.getResolvedFactoryMethod(); - if (factoryMethod != null) { - sources.add(factoryMethod); + try { + RootBeanDefinition beanDefinition = (RootBeanDefinition) getMergedBeanDefinition(beanName); + List sources = new ArrayList<>(2); + Method factoryMethod = beanDefinition.getResolvedFactoryMethod(); + if (factoryMethod != null) { + sources.add(factoryMethod); + } + Class targetType = beanDefinition.getTargetType(); + if (targetType != null && targetType != obj.getClass()) { + sources.add(targetType); + } + return sources.toArray(); } - Class targetType = beanDefinition.getTargetType(); - if (targetType != null && targetType != obj.getClass()) { - sources.add(targetType); + catch (NoSuchBeanDefinitionException ex) { + return null; } - return sources.toArray(); } } diff --git a/spring-beans/src/test/java/org/springframework/beans/factory/DefaultListableBeanFactoryTests.java b/spring-beans/src/test/java/org/springframework/beans/factory/DefaultListableBeanFactoryTests.java index ce0b36e6e4..bd01ba2df1 100644 --- a/spring-beans/src/test/java/org/springframework/beans/factory/DefaultListableBeanFactoryTests.java +++ b/spring-beans/src/test/java/org/springframework/beans/factory/DefaultListableBeanFactoryTests.java @@ -1982,6 +1982,21 @@ class DefaultListableBeanFactoryTests { assertThat(bean.getSpouse()).isEqualTo(lbf.getBean("spouse")); } + @Test + void beanProviderWithParentBeanFactoryReuseOrder() { + DefaultListableBeanFactory parentBf = new DefaultListableBeanFactory(); + parentBf.setDependencyComparator(AnnotationAwareOrderComparator.INSTANCE); + parentBf.registerBeanDefinition("regular", new RootBeanDefinition(TestBean.class)); + parentBf.registerBeanDefinition("test", new RootBeanDefinition(HighPriorityTestBean.class)); + lbf.setDependencyComparator(AnnotationAwareOrderComparator.INSTANCE); + lbf.setParentBeanFactory(parentBf); + lbf.registerBeanDefinition("low", new RootBeanDefinition(LowPriorityTestBean.class)); + List> orderedTypes = lbf.getBeanProvider(TestBean.class).orderedStream() + .map(Object::getClass).collect(Collectors.toList()); + assertThat(orderedTypes).containsExactly( + HighPriorityTestBean.class, LowPriorityTestBean.class, TestBean.class); + } + @Test void autowireExistingBeanByName() { RootBeanDefinition bd = new RootBeanDefinition(TestBean.class); diff --git a/spring-context/src/test/java/org/springframework/context/annotation/Gh29105Tests.java b/spring-context/src/test/java/org/springframework/context/annotation/Gh29105Tests.java new file mode 100644 index 0000000000..e954f5e989 --- /dev/null +++ b/spring-context/src/test/java/org/springframework/context/annotation/Gh29105Tests.java @@ -0,0 +1,81 @@ +/* + * Copyright 2002-2022 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.context.annotation; + +import java.util.List; +import java.util.stream.Collectors; + +import org.junit.jupiter.api.Test; + +import org.springframework.core.annotation.Order; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for gh-29105. + * + * @author Stephane Nicoll + */ +public class Gh29105Tests { + + @Test + void beanProviderWithParentContextReuseOrder() { + AnnotationConfigApplicationContext parent = new AnnotationConfigApplicationContext(); + parent.register(DefaultConfiguration.class); + parent.register(CustomConfiguration.class); + parent.refresh(); + + AnnotationConfigApplicationContext child = new AnnotationConfigApplicationContext(); + child.setParent(parent); + child.register(DefaultConfiguration.class); + child.refresh(); + + List> orderedTypes = child.getBeanProvider(MyService.class) + .orderedStream().map(Object::getClass).collect(Collectors.toList()); + assertThat(orderedTypes).containsExactly(CustomService.class, DefaultService.class); + } + + + interface MyService {} + + static class CustomService implements MyService {} + + static class DefaultService implements MyService {} + + + @Configuration + static class CustomConfiguration { + + @Bean + @Order(-1) + CustomService customService() { + return new CustomService(); + } + + } + + @Configuration + static class DefaultConfiguration { + + @Bean + @Order(0) + DefaultService defaultService() { + return new DefaultService(); + } + + } +}