Skip to content

Honor @Order for Map injection sorting order #34701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Honor @Order for Map injection sorting order #34701

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions ...s/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@
* @author Phillip Webb
* @author Stephane Nicoll
* @author Sebastien Deleuze
* @author Yanming Zhou
* @since 16 April 2001
* @see #registerBeanDefinition
* @see #addBeanPostProcessor
Expand Down Expand Up @@ -1806,6 +1807,10 @@ else if (Map.class.isAssignableFrom(type) && type.isInterface()) {
if (autowiredBeanNames != null) {
autowiredBeanNames.addAll(matchingBeans.keySet());
}
Comparator<Object> comparator = adaptDependencyComparator(matchingBeans);
if (comparator != null) {
matchingBeans = sortMatchingBeans(matchingBeans, comparator);
}
TypeConverter converter = (typeConverter != null ? typeConverter : getTypeConverter());
return converter.convertIfNecessary(matchingBeans, descriptor.getDependencyType());
}
Expand All @@ -1819,6 +1824,16 @@ private boolean isRequired(DependencyDescriptor descriptor) {
return getAutowireCandidateResolver().isRequired(descriptor);
}

private <T> Map<String, T> sortMatchingBeans(Map<String, T> matchingBeans, Comparator<Object> comparator) {
List<Map.Entry<String, T>> list = new ArrayList<>(matchingBeans.entrySet());
list.sort(Map.Entry.comparingByValue(comparator));
Map<String, T> result = CollectionUtils.newLinkedHashMap(list.size());
for(Map.Entry<String, T> entry : list) {
result.put(entry.getKey(), entry.getValue());
}
return result;
}

private @Nullable Comparator<Object> adaptDependencyComparator(Map<String, ?> matchingBeans) {
Comparator<Object> comparator = getDependencyComparator();
if (comparator instanceof OrderComparator orderComparator) {
Expand Down
28 changes: 28 additions & 0 deletions ...g/springframework/beans/factory/annotation/AutowiredAnnotationBeanPostProcessorTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.config.TypedStringValue;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.AutowireCandidateQualifier;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.beans.factory.support.GenericBeanDefinition;
Expand Down Expand Up @@ -93,6 +94,7 @@
* @author Sam Brannen
* @author Chris Beams
* @author Stephane Nicoll
* @author Yanming Zhou
*/
class AutowiredAnnotationBeanPostProcessorTests {

Expand Down Expand Up @@ -1297,6 +1299,32 @@ void methodInjectionWithMap() {
assertThat(bean.getTestBean()).isSameAs(tb);
}

@Test
void mapInjectionShouldHonorTheSortingOrder() {
RootBeanDefinition bd = new RootBeanDefinition(MapMethodInjectionBean.class);
bf.registerBeanDefinition("annotatedBean", bd);
RootBeanDefinition bd1 = new RootBeanDefinition();
bd1.setBeanClass(TestBean.class);
bd1.setAttribute(AbstractBeanDefinition.ORDER_ATTRIBUTE, Ordered.LOWEST_PRECEDENCE);
bf.registerBeanDefinition("bean1", bd1);
RootBeanDefinition bd2 = new RootBeanDefinition();
bd2.setBeanClass(DerivedTestBean.class);
bd2.setAttribute(AbstractBeanDefinition.ORDER_ATTRIBUTE, Ordered.HIGHEST_PRECEDENCE);
bd2.setPrimary(true);
bf.registerBeanDefinition("bean2", bd2);
RootBeanDefinition bd3 = new RootBeanDefinition();
bd3.setBeanClass(TestBean.class);
bd3.setAttribute(AbstractBeanDefinition.ORDER_ATTRIBUTE, Ordered.HIGHEST_PRECEDENCE + 1);
bf.registerBeanDefinition("bean3", bd3);
RootBeanDefinition bd4 = new RootBeanDefinition();
bd4.setBeanClass(TestBean.class);
bd4.setAttribute(AbstractBeanDefinition.ORDER_ATTRIBUTE, Ordered.LOWEST_PRECEDENCE - 1);
bf.registerBeanDefinition("bean4", bd4);

MapMethodInjectionBean bean = bf.getBean("annotatedBean", MapMethodInjectionBean.class);
assertThat(bean.getTestBeanMap().keySet()).containsExactly("bean2", "bean3", "bean4", "bean1");
}

@Test
void methodInjectionWithMapAndMultipleMatches() {
bf.registerBeanDefinition("annotatedBean", new RootBeanDefinition(MapMethodInjectionBean.class));
Expand Down
Loading