Spring @Import注解的使用

目录认识@Import注解搭建项目结构用于测试@Import用法最佳搭档 – @Import通用形式总结

认识@Import注解

先看一下源码

@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface Import {/** * {@link Configuration}, {@link ImportSelector}, {@link ImportBeanDefinitionRegistrar} * or regular component classes to import. */Class<?>[] value();}

@Import表示要导入的一个或多个@Configuration类

看注释value通常是一个普通的组件,Configuration,ImportSelector,ImportBeanDefinitionRegistrar。

搭建项目结构用于测试 先创建一个maven工程 加入依赖

<dependencies>    <dependency>        <groupId>org.projectlombok</groupId>        <artifactId>lombok</artifactId>        <version>1.18.18</version>    </dependency>    <dependency>        <groupId>org.springframework</groupId>        <artifactId>spring-context</artifactId>        <version>4.3.24.RELEASE</version>    </dependency></dependencies>

编写测试代码Tom.java

@Datapublic class Tom {    private String color;    private Integer age;}

AppConfig.java

@Configurationpublic class AppConfig {}

App.java

public class App {    public static void main(String[] args) {        // 创建容器        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);        // 获取bean        Tom tom = context.getBean(Tom.class);        System.out.println(tom);    }}

@Import用法

第一种普通组件@Import({ 要导入的容器中的组件 } )

CustomConfiguration.java

@Configurationpublic class CustomConfiguration {    @Bean    public Tom tom() {        Tom tom = new Tom();        tom.setAge(11);        tom.setColor("红色");        return tom;    }}

将AppConfig.java加上@Import({ CustomConfiguration.class })

@Import({ CustomConfiguration.class })@Configurationpublic class AppConfig {}

这个时候运行App已经可以获取到Tom

第二种ImportSelectorCustomSelector.java

public class CustomSelector implements ImportSelector {    @Override    public String[] selectImports(AnnotationMetadata importingClassMetadata) {        return new String[] { "com.moli.pojo.Tom" };    }}

将AppConfig.java加上@Import({ CustomRegistrar.class })

@Import({ CustomRegistrar.class })@Configurationpublic class AppConfig {}

这个时候运行App已经可以获取到Tom

第三种ImportBeanDefinitionRegistrarCustomRegistrar.java

public class CustomRegistrar implements ImportBeanDefinitionRegistrar {    @Override    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {        BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(Tom.class);        builder.setScope(BeanDefinition.SCOPE_SINGLETON);        builder.addPropertyValue("color", "灰色");        builder.addPropertyValue("age", "12");        registry.registerBeanDefinition("tom", builder.getBeanDefinition());    }}

将AppConfig.java加上@Import({ CustomSelector.class })

@Import({ CustomSelector.class })@Configurationpublic class AppConfig {}

这个时候运行App已经可以获取到Tom

最佳搭档 – @Import通用形式

在开源软件中大部分@Import中是伴随着一个@EnableXXX使用的

@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Import({ CustomRegistrar.class })public @interface EnableTom {}

将AppConfig.java加上@EnableTom

@EnableTom@Configurationpublic class AppConfig {}

这样看起来,是不是有那味了。

其实SpringBoot的自动配置就是@Import的一个应用

@SuppressWarnings("deprecation")@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Inherited@AutoConfigurationPackage@Import(EnableAutoConfigurationImportSelector.class)public @interface EnableAutoConfiguration {    ...}

总结

直白一点使用@Import注解可以快速把实例加入Spring的IOC容器中

其实这三种用法也算是一种用法,就是导入一个类到容器,容器根据类的注解类型等信息对不同类进行不同处理;

方法一:导入一个Configuration组件,组件创建了一个Tom类的Bean;

方法二:CustomSelector返回的类的全限定类名,实际上要导入到容器中的组件全类名;

方法三:ImportBeanDefinitionRegistrar类似于第二种ImportSelector用法,只不过这种用法能自定义化注册,往容器内注入一个BeanDefinition,然后BeanDeiniton在容器内转为一个实例bean;

以上就是Spring @Import注解的使用的详细内容,更多关于Spring @Import注解的资料请关注其它相关文章!

你曾经说,你曾经说。走在爱的旅途,我们的脚步多么轻松……

Spring @Import注解的使用

相关文章:

你感兴趣的文章:

标签云: