【Spring注解驅動開發】在@Import注解中使用ImportSelector接口導入bean

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容器中。