1.簡介
2.源碼解析
- 2.1 導入配置的三種類型
- 2.2 源碼解釋
3、測試例子
- 3.1 導入普通類
- 3.2 導入帶有@Configuration的配置類
- 3.3 通過ImportSelector 方式導入的類
- 3.4 通過 ImportBeanDefinitionRegistrar 方式導入的類
4. 詳細過程解析
- 4.1 getImports 方法
- 4.2 processImports 方法

1.簡介

在平時看源碼或者很多配置類上面都會出現@Import注解,功能就是和Spring XML 裡面的一樣. @Import注解是用來導入配置類或者一些需要前置加載的類.

2.源碼解析

2.1 導入配置的三種類型

@Import支援三種方式

1.帶有@Configuration的配置類(4.2 版本之前隻可以導入配置類，4.2版本之後也可以導入普通類)

2.ImportSelector 的實作

3.ImportBeanDefinitionRegistrar 的實作

2.2 源碼解釋

/**
 * Indicates one or more {@link Configuration @Configuration} classes to import.
 * 
 *功能類似XML 裡面的 <import/> ,可以導入 @Configuration配置類，ImportSelector、
 * ImportBeanDefinitionRegistrar 的實作,4.2 版本之後可以導入普通類(類似AnnotationConfigApplicationContext#register
 * )
 * <p>Provides functionality equivalent to the {@code <import/>} element in Spring XML.
 * Allows for importing {@code @Configuration} classes, {@link ImportSelector} and
 * {@link ImportBeanDefinitionRegistrar} implementations, as well as regular component
 * classes (as of 4.2; analogous to {@link AnnotationConfigApplicationContext#register}).
 *
 * 可以在類級别聲明或作為元注釋聲明
 * <p>May be declared at the class level or as a meta-annotation.
 * 如需要引入XML或其他類型的檔案，使用@ImportResource注解
 * <p>If XML or other non-{@code @Configuration} bean definition resources need to be
 * imported, use the {@link ImportResource @ImportResource} annotation instead.
 */
 @Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Import {

	/**
	 * {@link Configuration}, {@link ImportSelector}, {@link ImportBeanDefinitionRegistrar}
	 * or regular component classes to import.
	 */
	Class<?>[] value();

}

3、測試例子

3.1 導入普通類

建立一個TestA

public class TestA {

    public void fun(String str) {
        System.out.println(str);
    }

    public void printName() {
        System.out.println("類名 ：" + Thread.currentThread().getStackTrace()[1].getClassName());
    }
}

建立一個ImportConfig,在類上面加上@Configuration，加上@Configuration是為了能讓Spring 掃描到這個類，并且直接通過@Import引入TestA類

@Import({TestA.class})
@Configuration
public class ImportConfig {
}

3.測試結果

TestA 是一個普通的類，現在可以被@Autowired注釋然後調用，就直接說明已經被Spring 注入并管理了，普通的類都是需要先執行個體化

@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = ApplicationMain.class)
public class ImportAnnotionTest {

    @Autowired
    TestA testA;

    @Test
    public void TestA() {
        testA.printName();
    }
}

列印：

類名 ：com.test.importdemo.TestA

3.2 導入帶有@Configuration的配置類

建立TestB

@Configuration
public class TestB {
    public void fun(String str) {
        System.out.println(str);
    }

    public void printName() {
        System.out.println("類名 ：" + Thread.currentThread().getStackTrace()[1].getClassName());
    }
}

在ImportConfig.class裡面直接引入TestB

@Import({TestA.class,TestB.class})
@Configuration
public class ImportConfig {
}

3.測試結果

TestB.class 的類上面已經有了@Configuration注解,本身就會配spring掃到并執行個體，@import引入帶有@Configuration的配置檔案，是需要先執行個體這個配置檔案再進行相關操作

@Autowired
    TestB testB;


    @Test
    public void TestB(){
        testB.printName();
    }

列印：

ImportAnnotionTest in 8.149 seconds (JVM running for 10.104)
類名 ：com.test.importdemo.TestB
2019-01-31 14:12:05.737  INFO 23760 --- [       Thread-2]

3.3 通過ImportSelector 方式導入的類

建立TestC.class

public class TestC {
    public void fun(String str) {
        System.out.println(str);
    }

    public void printName() {
        System.out.println("類名 ：" + Thread.currentThread().getStackTrace()[1].getClassName());
    }
}

2.建立SelfImportSelector.class 實作ImportSelector 接口,注入TestC.class

//TODO ImportSelector 相關解釋

public class SelfImportSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{"com.test.importdemo.TestC"};
    }
}

3.ImportConfig上面引入SelfImportSelector.class

@Import({TestA.class,TestB.class,SelfImportSelector.class})
@Configuration
public class ImportConfig {
}

4.測試結果

@Autowired
    TestC testC;

    @Test
    public void TestC() {
        testC.printName();
    }

列印：

ImportAnnotionTest in 7.23 seconds (JVM running for 9.065)
類名 ：com.test.importdemo.TestC
2019-01-31 14:23:15.330  INFO 1196 --- [

3.4 通過 ImportBeanDefinitionRegistrar 方式導入的類

1.建立TestD.class

public class TestD {
    public void fun(String str) {
        System.out.println(str);
    }

    public void printName() {
        System.out.println("類名 ：" + Thread.currentThread().getStackTrace()[1].getClassName());
    }
}

2.建立SelfImportBeanDefinitionRegistrar.class,實作接口ImportBeanDefinitionRegistrar,注入TestD.class

public class SelfImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        RootBeanDefinition root = new RootBeanDefinition(TestD.class);
        registry.registerBeanDefinition("testD", root);
    }
}

3.ImportConfig類上加上導入SelfImportBeanDefinitionRegistrar.class

@Import({TestA.class,TestB.class,SelfImportSelector.class,
        SelfImportBeanDefinitionRegistrar.class})
@Configuration
public class ImportConfig {
}

4.測試結果

@Autowired
    TestD testD;


    @Test
    public void TestD() {
        testD.printName();
    }

列印：

ImportAnnotionTest in 7.817 seconds (JVM running for 9.874)
類名 ：com.test.importdemo.TestD
2019-01-31 14:30:05.781  INFO 23476 --- [

通過以上幾種方法都是能成功注入Spring.

4. 詳細過程解析

這裡主要看 ConfigurationClassParser.java 裡面的

doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass) 這個方法. 具體定位到源碼的302 行代碼

為啥不從頭梳理，這裡Spring 啟動過程比較複雜，要是從頭梳理，涉及的東西比較多，好多人看了就會累了，放棄了，我們就單個點熟悉，最後再進行彙總

@Import注解的作用1.簡介2.源碼解析3、測試例子4. 詳細過程解析

4.1 getImports 方法

在分析這個方法之前，我們先看一下 getImports 方法，這個方法就是擷取所有的@import 裡面的類

這裡是擷取 @import 裡面的類，大緻流程如下：

1. 定義一個 visited 的集合，用作是否已經判斷過的标志

2. 這裡就是擷取sourceClass 上面的所有的 annotation，并挨個判斷，如果不是 @import ,那就進一步遞歸調用對應的 annotation,直到全部結束

3. 加載sourceClass 裡面的@Import annotation 裡面對應的類名 ,最後傳回

private Set<SourceClass> getImports(SourceClass sourceClass) throws IOException {
		Set<SourceClass> imports = new LinkedHashSet<>();
		Set<SourceClass> visited = new LinkedHashSet<>();
		collectImports(sourceClass, imports, visited);
		return imports;
	}
	// 這裡就是擷取sourceClass 上面的 所有的 annotation， 如果不是 @import ,那就 進一步遞歸 調用 對應的 annotation,直到全部結束
	private void collectImports(SourceClass sourceClass, Set<SourceClass> imports, Set<SourceClass> visited)
			throws IOException {

		if (visited.add(sourceClass)) {
			for (SourceClass annotation : sourceClass.getAnnotations()) {
				String annName = annotation.getMetadata().getClassName();
				if (!annName.equals(Import.class.getName())) {
					collectImports(annotation, imports, visited);
				}
			}
			imports.addAll(sourceClass.getAnnotationAttributes(Import.class.getName(), "value"));
		}
	}

4.2 processImports 方法

processImports 這個方法的代碼邏輯也很清晰，流程圖如下：

@Import注解的作用1.簡介2.源碼解析3、測試例子4. 詳細過程解析

大緻的流程如下:

判斷 importCandidates 是否為空，為空退出
判斷isChainedImportOnStack ，如果為true ,加入 problemReporter 裡面的error ，并退出
把目前的 configClass 加入到 ImportStack裡面，ImportStack 是繼承了 ArrayDeque // TODO 和實作了 ImportRegistry// TODO
對 getImports 裡面擷取到的需要import 的類進行周遊處理

4.1 如果是 ImportSelector 類型，首先執行個體一個 ImportSelector 對象，然後對其進行 Aware 擴充(如果實作了 Aware 接口)

4.1.2 進一步判斷是否是 DeferredImportSelector 類型，如果是，加入到 deferredImportSelectors 裡面，最後處理，這裡可以看一下方法parse(Set configCandidates)，裡面最後一行才調用,這也就是有的時候，如果想最後注入，就可以定義為deferredImportSelectors 類型

4.1.2 如果不是 DeferredImportSelector 類型，那就調用 selectImports 方法，擷取到所有的需要注入的類，這時再次調用 processImports 方法，這裡調用processImports 方法，其實是把這些需要注入的類當成普通的 @Configuration 處理
如果是 ImportBeanDefinitionRegistrar 類型，這裡也是先執行個體一個對象，然後加入到 importBeanDefinitionRegistrars 裡面，後續會在 ConfigurationClassBeanDefinitionReader 這個類裡面的 loadBeanDefinitionsFromRegistrars 方法處理的

6.如果上面兩種類型都不是，那就是當初普通的帶有@Configuration 的類進行處理了

@Import注解的作用1.簡介2.源碼解析3、測試例子4. 詳細過程解析

@Import注解的作用1.簡介2.源碼解析3、測試例子4. 詳細過程解析

目錄

1.簡介

2.源碼解析

2.1 導入配置的三種類型

2.2 源碼解釋

3、測試例子

3.1 導入普通類

3.2 導入帶有@Configuration的配置類

3.3 通過ImportSelector 方式導入的類

3.4 通過 ImportBeanDefinitionRegistrar 方式導入的類

4. 詳細過程解析

4.1 getImports 方法

4.2 processImports 方法

繼續閱讀

關于Gradle配置的小結

Java小案例——随機數猜測随機數猜測

nginx location中斜線的位置的重要性

27 Best Free Eclipse Plug-ins for Java Developer to be ProductiveCode Quality PluginsText Editor PluginsDependency ManagementVersion Control Integration PluginsFramework Development Continuous Integration Related PluginsOther Utility Plugins

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method