spring源码 - 理解@Import原理及运用
创始人
2024-02-08 19:23:40

先看@Import解析代码

         for (SourceClass candidate : importCandidates) {           if (candidate.isAssignable(ImportSelector.class)) {            Class candidateClass = candidate.loadClass();ImportSelector selector = ParserStrategyUtils.instantiateClass(candidateClass, ImportSelector.class, this.environment, this.resourceLoader, this.registry);            if (selectorFilter != null) {exclusionFilter = exclusionFilter.or(selectorFilter);}    if (selector instanceof DeferredImportSelector) {this.deferredImportSelectorHandler.handle(configClass, (DeferredImportSelector) selector);} else {                   String[] importClassNames = selector.selectImports(currentSourceClass.getMetadata());                 Collection importSourceClasses = asSourceClasses(importClassNames, exclusionFilter);processImports(configClass, currentSourceClass, importSourceClasses, exclusionFilter, false);}}   else if (candidate.isAssignable(ImportBeanDefinitionRegistrar.class)) {Class candidateClass = candidate.loadClass();ImportBeanDefinitionRegistrar registrar =ParserStrategyUtils.instantiateClass(candidateClass, ImportBeanDefinitionRegistrar.class,this.environment, this.resourceLoader, this.registry);configClass.addImportBeanDefinitionRegistrar(registrar, currentSourceClass.getMetadata());} else {                this.importStack.registerImport(currentSourceClass.getMetadata(), candidate.getMetadata().getClassName());               processConfigurationClass(candidate.asConfigClass(configClass), exclusionFilter);}}  
}

看代码得到的可引入哪些class

从以上代码我们可以看出在@Import注解中可以看出import可以引入四种类型的class

1.普通类

主要是通过调用processConfigurationClass方法处理

2.实现ImportSelector接口的类

主要实现selectImports方法,返回字符串数组,数组内容须名class全名,包括package部分

   public interface ImportSelector {String[] selectImports(AnnotationMetadata importingClassMetadata);@Nullabledefault Predicate getExclusionFilter() {return null;}
}

3.实现DeferredImportSelector接口类

从下面的代码可以看出DeferredImportSelector接口是继承ImportSelector ,所以实现类需要实现getImportGroup方法,面且还需要实现其中内部接口类Group

另外如果getImportGroup返回null的值,需要实现其父接口ImportSelector 的selectImports方法,要不然会出现异常

 public interface DeferredImportSelector extends ImportSelector {@Nullabledefault Class getImportGroup() {return null;}interface Group {void process(AnnotationMetadata metadata, DeferredImportSelector selector);Iterable selectImports();    class Entry {private final AnnotationMetadata metadata;private final String importClassName;public Entry(AnnotationMetadata metadata, String importClassName) {this.metadata = metadata;this.importClassName = importClassName;}public AnnotationMetadata getMetadata() {return this.metadata;}public String getImportClassName() {return this.importClassName;}@Overridepublic boolean equals(@Nullable Object other) {if (this == other) {return true;}if (other == null || getClass() != other.getClass()) {return false;}Entry entry = (Entry) other;return (this.metadata.equals(entry.metadata) && this.importClassName.equals(entry.importClassName));}@Overridepublic int hashCode() {return (this.metadata.hashCode() * 31 + this.importClassName.hashCode());}@Overridepublic String toString() {return this.importClassName;}}}}

4.实现ImportBeanDefinitionRegistrar接口类 

public interface ImportBeanDefinitionRegistrar {  default void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry,BeanNameGenerator importBeanNameGenerator) {registerBeanDefinitions(importingClassMetadata, registry);} default void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {}
}

引入实现ImportSelector接口类样例

在这里我们实现一个EnableMyImportClass注解,根据其值自动引入class,其实和@Iimport指定普通类一个意思,但是我们这里也可以将其作为条件来决定引入哪一个类,比如根据DB名字引名具体DB连接类,这里只是一个简单实现

1.准备EnableMyImportClass类 

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(MyDeferredImportSelector.class)
public @interface EnableMyImportClass {String[]  value();
}

2.准备实现ImportSelectoor类

这里最为重要的逻辑是selectImports的内容,主要逻辑取到EnableMyImportClass里指定的具体值,其中这里内容其实是让EnableMyImportClass的值指定为具体的类名

public class MyImportSelector implements ImportSelector {@Overridepublic String[] selectImports(AnnotationMetadata importingClassMetadata) {Set set= importingClassMetadata.getAnnotationTypes();String[] a=null;if (set.contains(EnableMyImportClass.class.getName())){MultiValueMap valueMap=    importingClassMetadata.getAllAnnotationAttributes(EnableMyImportClass.class.getName());Object o=valueMap.get("value");if (o instanceof ArrayList){ArrayList arrayList=(ArrayList)o;if (arrayList.size()==1){Object o1=arrayList.get(0);a=new String[Array.getLength(o1)];for(int i=0;i getExclusionFilter() {return ImportSelector.super.getExclusionFilter();}
}

3.在@Configuration或@Component类中以下方式引入

@EnableMyImportClass({"com.extions.Person"})

如指定的类名不存在框将会报错,找不到引用类,比如如下

如果@EnableMyImportClass({"testme"}),其中testmes是不存在的,运行时会报如下错误

十一月 22, 2022 3:02:02 下午 org.springframework.context.support.AbstractApplicationContext refresh

警告: Exception encountered during context initialization - cancelling refresh attempt: org.springframework.beans.factory.BeanDefinitionStoreException: Failed to process import candidates for configuration class [com.zhouyu.AppConfig]; nested exception is java.io.FileNotFoundException: class path resource [testme.class] cannot be opened because it does not exist

Exception in thread "main" org.springframework.beans.factory.BeanDefinitionStoreException: Failed to process import candidates for configuration class [com.zhouyu.AppConfig]; nested exception is java.io.FileNotFoundException: class path resource [testme.class] cannot be opened because it does not exist

at org.springframework.context.annotation.ConfigurationClassParser.processImports(ConfigurationClassParser.java:646)

引入实现DeferredImportSelector接口类样例

以下代码最为关键的是内部类MyGroup及getImportGroup方法

public class MyDeferredImportSelector implements DeferredImportSelector {static class  MyGroup implements Group{private  AnnotationMetadata metadata;@Overridepublic void process(AnnotationMetadata metadata, DeferredImportSelector selector) {this.metadata=metadata;}@Overridepublic Iterable selectImports() {List list=new ArrayList();Entry entry=new Entry(this.metadata, Person.class.getName());list.add(entry);return list;}}@Overridepublic Class getImportGroup() {      return MyGroup.class;}public String[] selectImports(AnnotationMetadata importingClassMetadata) {return null;}@Overridepublic Predicate getExclusionFilter() {return DeferredImportSelector.super.getExclusionFilter();}
}

然后在Configuration类或@Compoent、@Service、@Controller中加入@Import(MyDeferredImportSelector.class),可能上面的方法来使用,只不过getGoup的逻辑需要修改

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(MyDeferredImportSelector.class)
public @interface EnableMyImportClass {String[]  value();
}

总结

     @Import注解是一个非常实用的方式,如果我们在系统开发时有非常定制化需要要根据不同条件引入不同的class作为bean,比如我们的系统需要支持不同的mq,但是不同的客户选择的MQ产品不一样,这样的话我们就可以采用这种方式为客户启用不同的mq类。

相关内容

热门资讯

埃菲尔铁塔在哪 中国仿建埃菲尔... 2019年4月26日,广西南宁市,街头惊现一座巨型山寨版埃菲尔铁塔,高约20米,白色塔身,造型逼真,...
苗族的传统节日 贵州苗族节日有... 【岜沙苗族芦笙节】岜沙,苗语叫“分送”,距从江县城7.5公里,是世界上最崇拜树木并以树为神的枪手部落...
北京的名胜古迹 北京最著名的景... 北京从元代开始,逐渐走上帝国首都的道路,先是成为大辽朝五大首都之一的南京城,随着金灭辽,金代从海陵王...
应用未安装解决办法 平板应用未... ---IT小技术,每天Get一个小技能!一、前言描述苹果IPad2居然不能安装怎么办?与此IPad不...
脚上的穴位图 脚面经络图对应的... 人体穴位作用图解大全更清晰直观的标注了各个人体穴位的作用,包括头部穴位图、胸部穴位图、背部穴位图、胳...
长白山自助游攻略 吉林长白山游... 昨天介绍了西坡的景点详细请看链接:一个人的旅行,据说能看到长白山天池全凭运气,您的运气如何?今日介绍...
猫咪吃了塑料袋怎么办 猫咪误食... 你知道吗?塑料袋放久了会长猫哦!要说猫咪对塑料袋的喜爱程度完完全全可以媲美纸箱家里只要一有塑料袋的响...
demo什么意思 demo版本... 618快到了,各位的小金库大概也在准备开闸放水了吧。没有小金库的,也该向老婆撒娇卖萌服个软了,一切只...
世界上最漂亮的人 世界上最漂亮... 此前在某网上,选出了全球265万颜值姣好的女性。从这些数量庞大的女性群体中,人们投票选出了心目中最美...
埃菲尔铁塔在哪 中国仿建埃菲尔... 2019年4月26日,广西南宁市,街头惊现一座巨型山寨版埃菲尔铁塔,高约20米,白色塔身,造型逼真,...
苗族的传统节日 贵州苗族节日有... 【岜沙苗族芦笙节】岜沙,苗语叫“分送”,距从江县城7.5公里,是世界上最崇拜树木并以树为神的枪手部落...
北京的名胜古迹 北京最著名的景... 北京从元代开始,逐渐走上帝国首都的道路,先是成为大辽朝五大首都之一的南京城,随着金灭辽,金代从海陵王...
应用未安装解决办法 平板应用未... ---IT小技术,每天Get一个小技能!一、前言描述苹果IPad2居然不能安装怎么办?与此IPad不...