Browse Source

Support @⁠Import on interfaces

See gh-34805
Closes gh-34820

Signed-off-by: Daeho Kwon <trewq231@naver.com>
pull/34989/head
Daeho Kwon 11 months ago committed by Sam Brannen
parent
commit
a4d5800a6c
  1. 7
      spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassParser.java
  2. 68
      spring-context/src/test/java/org/springframework/context/annotation/ImportSelectorTests.java

7
spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassParser.java

@ -98,6 +98,7 @@ import org.springframework.util.StringUtils;
* @author Phillip Webb * @author Phillip Webb
* @author Sam Brannen * @author Sam Brannen
* @author Stephane Nicoll * @author Stephane Nicoll
* @author Daeho Kwon
* @since 3.0 * @since 3.0
* @see ConfigurationClassBeanDefinitionReader * @see ConfigurationClassBeanDefinitionReader
*/ */
@ -549,6 +550,9 @@ class ConfigurationClassParser {
* <p>For example, it is common for a {@code @Configuration} class to declare direct * <p>For example, it is common for a {@code @Configuration} class to declare direct
* {@code @Import}s in addition to meta-imports originating from an {@code @Enable} * {@code @Import}s in addition to meta-imports originating from an {@code @Enable}
* annotation. * annotation.
* <p>As of Spring Framework 7.0, {@code @Import} annotations declared on interfaces implemented by
* the configuration class are also considered. This allows imports to be triggered
* indirectly via marker interfaces or shared base interfaces.
* @param sourceClass the class to search * @param sourceClass the class to search
* @param imports the imports collected so far * @param imports the imports collected so far
* @param visited used to track visited classes to prevent infinite recursion * @param visited used to track visited classes to prevent infinite recursion
@ -558,6 +562,9 @@ class ConfigurationClassParser {
throws IOException { throws IOException {
if (visited.add(sourceClass)) { if (visited.add(sourceClass)) {
for (SourceClass ifc : sourceClass.getInterfaces()) {
collectImports(ifc, imports, visited);
}
for (SourceClass annotation : sourceClass.getAnnotations()) { for (SourceClass annotation : sourceClass.getAnnotations()) {
String annName = annotation.getMetadata().getClassName(); String annName = annotation.getMetadata().getClassName();
if (!annName.equals(Import.class.getName())) { if (!annName.equals(Import.class.getName())) {

68
spring-context/src/test/java/org/springframework/context/annotation/ImportSelectorTests.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2024 the original author or authors. * Copyright 2002-2025 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -62,6 +62,7 @@ import static org.mockito.Mockito.spy;
* *
* @author Phillip Webb * @author Phillip Webb
* @author Stephane Nicoll * @author Stephane Nicoll
* @author Daeho Kwon
*/ */
@SuppressWarnings("resource") @SuppressWarnings("resource")
public class ImportSelectorTests { public class ImportSelectorTests {
@ -203,6 +204,71 @@ public class ImportSelectorTests {
assertThat(TestImportGroup.environment).isEqualTo(context.getEnvironment()); assertThat(TestImportGroup.environment).isEqualTo(context.getEnvironment());
} }
@Test
void importAnnotationOnImplementedInterfaceIsRespected() {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(
InterfaceBasedConfig.class);
assertThat(context.getBean(ImportedConfig.class)).isNotNull();
assertThat(context.getBean(ImportedBean.class)).isNotNull();
assertThat(context.getBean(ImportedBean.class).name()).isEqualTo("imported");
}
@Test
void localImportShouldOverrideInterfaceImport() {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(
OverridingConfig.class);
assertThat(context.getBean(ImportedConfig.class)).isNotNull();
assertThat(context.getBean(ImportedBean.class)).isNotNull();
assertThat(context.getBean(ImportedBean.class).name()).isEqualTo("from class");
}
@Import(ImportedConfig.class)
interface ConfigImportMarker {
}
@Configuration
static class InterfaceBasedConfig implements ConfigImportMarker {
}
@Configuration
@Import(OverridingImportedConfig.class)
static class OverridingConfig implements ConfigImportMarker {
}
@Configuration
static class OverridingImportedConfig {
@Bean
ImportedBean importedBean() {
return new ImportedBean("from class");
}
}
static class ImportedBean {
private final String name;
ImportedBean() {
this.name = "imported";
}
ImportedBean(String name) {
this.name = name;
}
String name() {
return name;
}
}
@Configuration
static class ImportedConfig {
@Bean
ImportedBean importedBean() {
return new ImportedBean();
}
}
@Configuration @Configuration
@Import(SampleImportSelector.class) @Import(SampleImportSelector.class)

Loading…
Cancel
Save