@Eable*注解原理以及三种方式

@enable跟@import注解

参考文章:

讲@import的相关内容:https://blog.csdn.net/u012437781/article/details/78626134

讲为什么registrar没有注入:https://www.cnblogs.com/zzq-include/p/8004506.html

---------------------------------------------------------------

在spring中,我们可以通过@Enable*来开启对一项的支持,从而避免自己配置大量的代码,那么这个神奇的功能是如何实现的呢?

通过查看源码,可以发现这些@Enable*注解都有一个@Import注解,@Import是用来导入配置类的,这也就意味着这些自动开启的实现实际是导入了一些自动配置的Bean。这些导入的配置方式主要分为三类:

1、直接导入配置类

就是直接在类中使用@Import注解,将某个bean的实例注册到spring的ioc容器。例如:

两个空类:

public class Broker {}

public class Customer {}

使用者会将Broker跟Customer的实例注入spring容器(不是使用者的bean中)

/**

 * 使用Import 将指定的类的实例注入到spring 容器中

 */

@Component

@Import({Customer.class,Broker.class})

public class ImportDirect {

    //顶部的@Import注解会将两个类的实例注入到spring IOC容器(注意,不是注入到ImportDirect类的实例中)

}

测试代码:

public class FirstTest {

    public static void main(String[] args) {

        //ImportDirect类 顶部的@Import注解会将两个类的实例注入到spring IOC容器(注意,不是注入到ImportDirect类的实例中)

        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ImportDirect.class);


        System.out.println(context.getBean(Customer.class));

        System.out.println(context.getBean(Broker.class));

    }

}

输出结果:

debug查看context.getBean(ImportDirect.class)可以看到class has no fields字样,说明并没有注入到ImportDirect的实例中。

2、通过实现ImportBeanDefinitionRegistrar接口注入

ImportBeanDefinitionRegistrar接口是spring将bean注册到ioc容器的接口,实现该接口后重写registerBeanDefinitions方法,便可将自己希望的bean注入到ioc容器中,从而实现自动配置。

两个空类:

public class Forwards {}

public class Security {}

ImportBeanDefinitionRegistrar接口是spring将bean注册到ioc容器的接口,实现该接口后重写registerBeanDefinitions方法,便可将自己希望的bean注入到ioc容器中,从而实现自动配置。

/**

 * 通过实现ImportBeanDefinitionRegistrar接口,将bean注入到spring 容器中

 */

public class MyImportRegistrar implements ImportBeanDefinitionRegistrar {

    @Override

    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

        //手动注入实例

        BeanDefinitionBuilder beanDef_forwards = BeanDefinitionBuilder.rootBeanDefinition(Forwards.class);

        registry.registerBeanDefinition("forwards",beanDef_forwards.getBeanDefinition());


        BeanDefinitionBuilder beanDef_security = BeanDefinitionBuilder.rootBeanDefinition(Security.class);

        registry.registerBeanDefinition("security",beanDef_security.getBeanDefinition());


    }

}

类的使用者:

@Component

@Import({MyImportRegistrar.class})

public class App {}

测试代码:

public class SecondTest {

    public static void main(String[] args) {

        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(App.class);

        System.out.println(context.getBean(Security.class));

        System.out.println(context.getBean(Forwards.class));

        System.out.println(context.getBean(MyImportRegistrar.class));

    }

}

执行结果是啥,打出三个对象实例么?然而不是:

最后一个抛异常了,spring中找不到我们的MyImportRegistrar类的实例,为什么会这样,@Import不是会自动注册类到ioc容器么?

这里有个细节,就是spring的@Import会自动引入非ImportBeanDefinitionRegistrar的实例到ioc容器,如果实现了ImportBeanDefinitionRegistrar接口,就不会注册bean到spring容器。相关内容参见:https://www.cnblogs.com/zzq-include/p/8004506.html

3、依据条件,选择配置类

跟2类似,我们还可以通过实现ImportSelector接口来装配我们需要的类的实例。

重写ImportSelector接口的selectImports方法,返回一个字符串数组,字符串数组即为我们要装配到容器的实例类名的全称;该方法中,我们可以通过参数importingClassMetadata获取在@Enable*中设定的name值。示例如下:

两个空类:

public class Market {}

public class Sales {}

Enable注解类

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.TYPE)

@Import({MyImportSelector.class})

public @interface EnableMyTest {

    String[] name();

}

自定义的ImportSelector实现类

public class MyImportSelector implements ImportSelector {

    @Override

    public String[] selectImports(AnnotationMetadata importingClassMetadata) {

        System.out.println(importingClassMetadata.getAnnotationAttributes(EnableMyTest.class.getName()).toString().contains("onlySale"));


        //获取自定的@EnableLogInfo 信息 如果包含 onlySale 则只注入Sales class 否则 注入 Sales 和 Market 两个类

        if (importingClassMetadata.getAnnotationAttributes(EnableMyTest.class.getName()) != null

                && importingClassMetadata.getAnnotationAttributes(EnableMyTest.class.getName()).toString().contains("onlySale")) {

            return new String[] {Sales.class.getName() };

        }


        // 将指定的类

        return new String[] { Market.class.getName(), Sales.class.getName() };

    }

}

@Enable的使用者:

@Component

@EnableMyTest(name="onlySale")

public class App {}

测试类:

public class ThirdTest {

    public static void main(String[] args) {

        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(App.class);

        System.out.println(context.getBean(Sales.class));

        System.out.println(context.getBean(Market.class));

        System.out.println(context.getBean(MyImportSelector.class));

    }

}

结果:

注释测试类第五行,可以发现MyImportSelector也没有注入到容器,这一点上,跟方式2是一致的。

----------------------------------------------------------------------

以上内容在传统spring中就可以使用了,我所使用的版本是4.2.6。理清楚这一部分还是有必要的,因为在spring boot中有很多自动配置,它们的就是基于以上内容实现的。


@Import注解 

public class DemoService { public void doSomething(){ System.out.println("ok"); } }


import org.springframework.context.annotation.Configuration;

import org.springframework.context.annotation.Import;

@Configuration

@Import(DemoService.class)//在spring 4.2之前是不不支持的

public class DemoConfig { }

import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class Main { public static void main(String[] args) {

AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext("com..example");

DemoService ds = context.getBean(DemoService.class); ds.doSomething();

} }

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

推荐阅读更多精彩内容