Spring中@Import注解详解

Spring3.0之前,向容器中注入bean都使用XML配置文件的方式。大家都知道这种方式配置繁琐,因此Spring在3.0版本提供了JavaConfig的方式,以Java代码的方式进行配置描述,然后通过@Configuration与@Bean这两个注解配合使用将原来配置在XML文件里面的bean通过Java代码的方式代替。

@Import功能介绍

@Import注解使注入bean的方式变得更方便、灵活。它的两大基本功能是:

  1. 导入第三方的配置类

类似于xml配置文件中的标签,把分散的多个@Configuration配置类组织在一起。

  1. 注册bean的功能

@Import注解可以将添加的类型直接注册到IOC容器中。

@Import注解的源码如下:

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

从源码注释中可以看到@Import可以配合@Configuration、ImportSelector、ImportBeanDefinitionRegistrar使用。

@Import基本功能导入第三方配置类

下面演示一下导入第三方配置类的功能。

Student.java 一个普通的类。

public class Student {
}

两个配置类,分别是RedisConfig.java、MybatisConfig.java

@Configuration
public class RedisConfig {
}
// 配置类中增加了Student的bean对象
@Configuration
public class MybatisConfig {
    @Bean
    public Student student() {
        return new Student();
    }
}

JavaConfig.java配置类,这里使用@Import注解导入了Mybatis、RedisConfig两个配置类。

@Configuration
@Import(value = {MybatisConfig.class, RedisConfig.class})
public class JavaConfig {
}

测试类,如果我们能够看到Spring容器中包含MybatisConfig、RedisConfig、Student这三个对象,说明@Import注解把另外两个配置都导入了。

public class ImportStudyApplication {

    public static void main(String[] args) {
        ApplicationContext ac = new AnnotationConfigApplicationContext(JavaConfig.class);
        Arrays.stream(ac.getBeanDefinitionNames()).forEach(name -> System.out.println(name));
    }
}

容器中的bean对象

3个配置对象和student对象都导入了,说明@Import注解成功的把MybatisCongfig、RedisConfig配置类都导入了。

@Import直接将类型对象注入到IOC容器

下面的例子是使用@Import把Student对象直接注入到Spring的容器中。

Student.java

public class Student {
}

Java配置类

在配置类中使用@Import导入Student对象。

@Configuration
@Import(value = {Student.class})
public class JavaConfig {
}

测试类

@SpringBootApplication
public class ImportStudyApplication {
    public static void main(String[] args) {
        ApplicationContext ac = new AnnotationConfigApplicationContext(JavaConfig.class);
        Arrays.stream(ac.getBeanDefinitionNames()).forEach(name -> System.out.println(name));
    }
}

测试类中打印了当前容器的所有bean对象名称,下面可以看到已经注入了Student类的对象。

@Import导入ImportSelector实现类,动态注入对象

上面的注入方式都是通过Imort注解静态的指定需要注入的bean类型,如果需要注入的bean比较多,使用起来会很麻烦,没法达到动态注入的效果。

如果当@Import导入实现了ImportSelector接口的类就可以达到这个目的。

MyImportSelector实现类,实现类需要实现selectImports方法。

public class MyImportSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        String[] beans = {"com.example.importstudy.service.Student"};
        return beans;
    }
}

selectImports方法返回一个对象name数组,这里我们可以进行各种逻辑处理,动态生成我们需要的bean对象name数组。

JavaCongfig配置类

@Configuration
@Import(value = {MyImportSelector.class})
public class JavaConfig {
}

测试类和之前一样,这里我们直接看测试结果。

可以看到student对象已经注入了,但是MyImportSelector并没有注入,这是因为Spring中对MyImportSelector类进行了特殊处理,只注入返回的对象数组。

@Import导入ImportBeanDefinitionRegistrar实现类,动态注入对象

ImportBeanDefinitionRegistrar与ImportSelector接口一样,ImportBeanDefinitionRegistrar也允许我们动态的注入对象。

不同的是,它没有返回值,而是给了我们一个BeanDefinitionRegistry,bean定义注册器,这个注册器可以添加、删除等操作。

public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(Student.class);
        registry.registerBeanDefinition("student1", rootBeanDefinition);
    }
}

JavaConfig配置类

   @Configuration
    @Import(value = {MyImportBeanDefinitionRegistrar.class})
    public class JavaConfig {
    }

测试类和之前一样,我直接看测试结果

与ImportSelector接口一样,Spring并不会注入MyImportBeanDefinitionRegistrar对象,而是把registry.registerBeanDefinition("student1", rootBeanDefinition);中配置的bean注册了。

ImportSelector与ImportBeanDefinitionRegistrar的区别

这两个接口都可以通过@Import注解动态的注入bean对象到容器中。

不同的是实现类重载的方法不同,ImportSelector明确给你需要注入的对象名称,无需你关注更多的细节。ImportBeanDefinitionRegistrar是一个注册类,需要你自己去定义,繁琐一点但是功能更加强大。

假设一个场景,你去银行取款,ImportSelector像一个银行的柜员,你把卡给他,他帮您搞定所有的事情。

ImportBeanDefinitionRegistrar像是一个取款机,你自己去操作,但是你可以取钱、存款,自己的权利更大了。

@Import注解总结

@Import注解实现两大类功能,导入三方配置类,注入bean对象。

注入bean对象又分为静态注入,动态注入两种。

可以看到@Import的功能十分强大,SpringBoot自动装配功能的实现就有@Import的身影,因此@Import注解十分重要。

如果本文对你有帮助,请拿起你发财的小手,不要吝啬你的点赞和评论哦。

展开阅读全文

页面更新:2024-03-15

标签:注解   数组   容器   详解   接口   对象   两个   方式   功能   测试   动态

1 2 3 4 5

上滑加载更多 ↓
推荐阅读:
友情链接:
更多:

本站资料均由网友自行发布提供,仅用于学习交流。如有版权问题,请与我联系,QQ:4156828  

© CopyRight 2008-2024 All Rights Reserved. Powered By bs178.com 闽ICP备11008920号-3
闽公网安备35020302034844号

Top