【Spring註解驅動開發】在@Import註解中使用ImportSelector介面匯入bean

冰河團隊發表於2020-06-12
SpringImportBean

寫在前面

在上一篇關於Spring的@Import註解的文章《【Spring註解驅動開發】使用@Import註解給容器中快速匯入一個元件》中，我們簡單介紹瞭如何使用@Import註解給容器中快速匯入一個元件，而我們知道，@Import註解總共包含三種使用方法，分別為：直接填class陣列方式；ImportSelector方法（重點）；ImportBeanDefinitionRegistrar方式。那麼，今天，我們就一起來學習關於@Import註解非常重要的第二種方式：ImportSelector方式。

專案工程原始碼已經提交到GitHub：https://github.com/sunshinelyz/spring-annotation

ImportSelector介面概述

ImportSelector介面是至spring中匯入外部配置的核心介面，在SpringBoot的自動化配置和@EnableXXX(功能性註解)都有它的存在。我們先來看一下ImportSelector介面的原始碼，如下所示。

package org.springframework.context.annotation;

import java.util.function.Predicate;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.lang.Nullable;

public interface ImportSelector {
	String[] selectImports(AnnotationMetadata importingClassMetadata);
	@Nullable
	default Predicate<String> getExclusionFilter() {
		return null;
	}
}

該介面文件上說的明明白白，其主要作用是收集需要匯入的配置類，selectImports()方法的返回值就是我們向Spring容器中匯入的類的全類名。如果該介面的實現類同時實現EnvironmentAware， BeanFactoryAware ，BeanClassLoaderAware或者ResourceLoaderAware，那麼在呼叫其selectImports方法之前先呼叫上述介面中對應的方法，如果需要在所有的@Configuration處理完在匯入時可以實現DeferredImportSelector介面。

在ImportSelector介面的selectImports()方法中，存在一個AnnotationMetadata型別的引數，這個引數能夠獲取到當前標註@Import註解的類的所有註解資訊。

注意：如果ImportSelector介面展開講的話，可以單獨寫一篇文章，那我就放在下一篇文章中講吧，這裡就不贅述了，嘿嘿。

ImportSelector介面例項

首先，我們建立一個MyImportSelector類實現ImportSelector介面，如下所示。

package io.mykit.spring.plugins.register.selector;

import org.springframework.context.annotation.ImportSelector;
import org.springframework.core.type.AnnotationMetadata;
/**
 * @author binghe
 * @version 1.0.0
 * @description 測試@Import註解中使用ImportSelector
 *              自定義邏輯，返回需要匯入的元件
 */
public class MyImportSelector implements ImportSelector {
    /**
     * 返回值為需要匯入到容器中的bean的全類名陣列
     * AnnotationMetadata：當前標註@Import註解的類的所有註解資訊
     */
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[0];
    }
}

接下來，我們在PersonConfig2類的@Import註解中，匯入MyImportSelector類，如下所示。

@Configuration
@Import({Department.class, Employee.class, MyImportSelector.class})
public class PersonConfig2 {

至於使用MyImportSelector匯入哪些bean，就需要在MyImportSelector類的selectImports()方法中進行設定了，只要在MyImportSelector類的selectImports()方法中返回要匯入的類的全類名（包名+類名）即可。

我們繼承建立兩個Java bean物件，分別為User和Role，如下所示。

  • User類
package io.mykit.spring.plugins.register.bean;
/**
 * @author binghe
 * @version 1.0.0
 * @description 測試ImportSelector
 */
public class User {
}
  • Role類
package io.mykit.spring.plugins.register.bean;
/**
 * @author binghe
 * @version 1.0.0
 * @description 測試ImportSelector
 */
public class Role {
}

接下來，我們將User類和Role類的全類名返回到MyImportSelector類的selectImports()方法中，此時，MyImportSelector類的selectImports()方法如下所示。

/**
 * 返回值為需要匯入到容器中的bean的全類名陣列
 * AnnotationMetadata：當前標註@Import註解的類的所有註解資訊
 */
@Override
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
    return new String[]{
        User.class.getName(),
        Role.class.getName()
    };
}

接下來，我們執行SpringBeanTest類的testAnnotationConfig7()方法，輸出的結果資訊如下所示。

org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
personConfig2
io.mykit.spring.plugins.register.bean.Department
io.mykit.spring.plugins.register.bean.Employee
io.mykit.spring.plugins.register.bean.User
io.mykit.spring.plugins.register.bean.Role
person
binghe001

可以看到，輸出結果中多出了io.mykit.spring.plugins.register.bean.User和io.mykit.spring.plugins.register.bean.Role。

說明使用ImportSelector已經成功將User類和Role類匯入到了Spring容器中。

好了，我們們今天就聊到這兒吧！別忘了給個在看和轉發，讓更多的人看到，一起學習一起進步！！

專案工程原始碼已經提交到GitHub：https://github.com/sunshinelyz/spring-annotation

寫在最後

如果覺得文章對你有點幫助，請微信搜尋並關注「 冰河技術 」微信公眾號，跟冰河學習Spring註解驅動開發。公眾號回覆“spring註解”關鍵字，領取Spring註解驅動開發核心知識圖，讓Spring註解驅動開發不再迷茫。

相關文章