@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));

    }

}

输出结果:

@Eable*注解原理以及三种方式_第1张图片

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

@Eable*注解原理以及三种方式_第2张图片

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));

    }

}

结果:

@Eable*注解原理以及三种方式_第3张图片

注释测试类第五行,可以发现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();

} }

你可能感兴趣的:(@Eable*注解原理以及三种方式)