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
This commit is contained in:
Stephane Nicoll 2022-09-09 16:52:20 +02:00
parent 4e97776969
commit 0d2bfc926f
3 changed files with 111 additions and 10 deletions

View File

@ -2167,10 +2167,11 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto
@Nullable @Nullable
public Object getOrderSource(Object obj) { public Object getOrderSource(Object obj) {
String beanName = this.instancesToBeanNames.get(obj); String beanName = this.instancesToBeanNames.get(obj);
if (beanName == null || !containsBeanDefinition(beanName)) { if (beanName == null) {
return null; return null;
} }
RootBeanDefinition beanDefinition = getMergedLocalBeanDefinition(beanName); try {
RootBeanDefinition beanDefinition = (RootBeanDefinition) getMergedBeanDefinition(beanName);
List<Object> sources = new ArrayList<>(2); List<Object> sources = new ArrayList<>(2);
Method factoryMethod = beanDefinition.getResolvedFactoryMethod(); Method factoryMethod = beanDefinition.getResolvedFactoryMethod();
if (factoryMethod != null) { if (factoryMethod != null) {
@ -2182,6 +2183,10 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto
} }
return sources.toArray(); return sources.toArray();
} }
catch (NoSuchBeanDefinitionException ex) {
return null;
}
}
} }
} }

View File

@ -1982,6 +1982,21 @@ class DefaultListableBeanFactoryTests {
assertThat(bean.getSpouse()).isEqualTo(lbf.getBean("spouse")); 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<Class<?>> orderedTypes = lbf.getBeanProvider(TestBean.class).orderedStream()
.map(Object::getClass).collect(Collectors.toList());
assertThat(orderedTypes).containsExactly(
HighPriorityTestBean.class, LowPriorityTestBean.class, TestBean.class);
}
@Test @Test
void autowireExistingBeanByName() { void autowireExistingBeanByName() {
RootBeanDefinition bd = new RootBeanDefinition(TestBean.class); RootBeanDefinition bd = new RootBeanDefinition(TestBean.class);

View File

@ -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<Class<?>> 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();
}
}
}