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