@Import 、@Conditional 处理过程源码解析

@Import@Conditional 在 Spring Boot 实现 auto-configuratin 过程中有着至关重要的作用。今天就来梳理一下这两个基础注解。

@Import 注解用来导入更多的类,这个注解等价于XML配置中的 <import/>。典型的就是导入一个 @Configuration 标记的配置类。

注解参数可以是:

  • @Configuration注解标记的类,@Configuration注解本质上是个@Component,源码的处理上也是判断是否注解了@Component,因此标记了@Componnet也是可以的。
  • ImportSelector接口的子类,此接口重点实现 selectImports方法 返回需要倒入类的名称。
  • ImportBeanDefinitionRegistrar接口的子类,此接口重点实现 registerBeanDefinitions方法 通过方法参数 BeanDefinitionRegistry registry 直接注册bean定义。

ImportSelector为例写个测试Demo,源码分析一下:

public static void main(String[] args) {
    //这里需要 Spring 托管 @Import 注解的类
    AnnotationConfigApplicationContext applicationContext =
            new AnnotationConfigApplicationContext(WithImportAnnotationClass.class);
    System.out.println(applicationContext.getBean(BeanA.class));
}

@Import({CustomBeanImportSelector.class})
static class WithImportAnnotationClass {
}

static class CustomBeanImportSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{BeanA.class.getName()};
    }
}

static class BeanA {
}

简单几行代码,启动调试,直接公布调用过程答案:

  1. Spring Ioc 加载 @Import注解的类定义,Spring Boot也是类似逻辑,通过
  2. ApplicationContext 在创建过程中,通过 refresh()方法 完成 Ioc 容器的初始化工作。这个方法基本包含了 Ioc 的生命周期和重要扩张点。
  3. refresh 方法中,invokeBeanFactoryPostProcessors() 方法实现中会先后调用 BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry)BeanFactoryPostProcesser#postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) 两个扩展点方法。本质上 BeanDefinitionRegistryPostProcessorBeanFactoryPostProcesser 的子类,但他们的侧重点不同,前者侧重BeanDefinition的注册,后者侧重对BeanFactory处理。
  4. 针对 AnnotationConfigApplicationContext 它在启动时默认就会注册了一个 BeanDefinitionRegistryPostProcessor,具体对应实现类ConfigurationClassPostProcessor
  5. 通过 ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry 方法,1. 明确需要额外处理的 BeanDefinition,2. 解释这些 BeanDefinition 产生额外配置的 BeanDefinition 。3. 将这些额外配置的 BeanDefinition 注册到 BeanDefinitionRegistry 中,后期产生实例。

第五步中,有三点强调:

  1. 明确需要额外处理的 BeanDefinition,是通过 ConfigurationClassUtils#isConfigurationCandidate方法,判断是否被 [@Component, @ComponentScan, @Import, @ImportResource]标记,然后给BeanDefinition 增加 attribution 来实现的(后续会判断这点)。
  2. 解释这些 BeanDefinition 产生额外配置的 BeanDefinition,是通过 ConfigurationClassParser#parser方法,它根据不通注解和注解配置,来实现产生需要被倒入的 BeanDefinition。当然这个过程涉及到递归,比如说我 Import了一个新的 Import注解的类。
  3. ConfigurationClassParser#parser会对@Conditional注解进行处理。它在处理开始时,会通过 ConditionEvaluator 来判断配置类上是否有 Conditional 注解,并根据注解的参数,来判断是否跳过这个配置类。
852F3B5B-ED0A-445B-8876-863718B75F0E.png

以上讲完了@Import注解,有了上面的基础,接下来直接搞 @Conditional

  1. 首先,使用 @Conditional 注解需要指明一个实现了 Condition 接口的类,如 @Conditional(OnBeanCondition.class) 这样子。
  2. ApplicationContext 在初始化时,会创建一个 ConditionEvaluator,它负责对注解的解释工作。
  3. 在关键点(比如说上面讲的配置类解析过程),ConditionEvaluator#shouldSkip 返回的Boolean值来跳过某些Bean定义。

第三步中,具体流程其实就是:

获取到Bean定义中的@Conditional注解,得到配置的Conditon的实现类,执行实现类的matches方法。

像Spring Boot中有一些自带的 Condition 的实现类如:

OnBeanCondition => @ConditionalOnBean
OnClassCondition => @ConditionalOnClass

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,874评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,102评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,676评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,911评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,937评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,935评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,860评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,660评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,113评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,363评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,506评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,238评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,861评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,486评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,674评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,513评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,426评论 2 352

推荐阅读更多精彩内容