Spring框架中注解@Import的用法和示例
1、@Import简介
该注解主要是为了实现把实例加入Spring IOC容器中，功能和通过Spring XML中配置
导入Spring IOC容器中的实例，和@Component等注解导入的实例用法一样，可以通过@Autowired等注入到指定的类中进行使用。
@Import的源码如下：
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Import {
/**
* {@link Configuration @Configuration}, {@link ImportSelector},
* {@link ImportBeanDefinitionRegistrar}, or regular component classes to import.
*/
Class<?>[] value();
}
2、基于@Configuration的导入方式
1、首先准备几个Bean类，如下所示：
除BeanOne这个类添加了@Configuration注解，其他除类名称和输出内容略有区别外，其他都完全一样，代码不在一一列举。
@Configuration
public class BeanOne {
public void run(){
System.out.println("BeanOne.run（）方法。");
}
}
2、实现配置类
@Import({
BeanOne.class})
public class MainConfig {
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(MainConfig.class);
String[] beanNames = context.getBeanDefinitionNames();
for(int i=0;i<beanNames.length;i++){
System.out.println("bean名称："+beanNames[i]);
}
}
}
3、执行Main方法，控制台打印如下：
……省略其他干扰的打印信息，包括默认的一些Bean打印信息
bean名称：mainConfig
bean名称：com.qriver.spring.bean.BeanOne
根据打印内容，可以判断BeanOne的实例导入成功了。
3、基于ImportSelector实现类的导入方式
1、定义ImportSelector实现类
这种方式，需要首先定义一个ImportSelector实现类，并在实现类的selectImports方法中，返回需要导入Spring IOC容器的实例类的全限定类名，如下所示：
/**
* 定义ImportSelector实现类，实现指定Bean的注入，spring框架中最常用的方式
*/
public class MyImportSelector implements ImportSelector {
@Override
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
return new String[]{
"com.qriver.spring.bean.BeanFive","com.qriver.spring.bean.BeanFour"};
}
}
2、修改配置类
@Import({
BeanOne.class,MyImportSelector.class})
public class MainConfig {
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(MainConfig.class);
String[] beanNames = context.getBeanDefinitionNames();
for(int i=0;i<beanNames.length;i++){
System.out.println("bean名称："+beanNames[i]);
}
}
}
3、执行main方法，打印内容如下：
……省略其他干扰的打印信息，包括默认的一些Bean打印信息
bean名称：mainConfig
bean名称：com.qriver.spring.bean.BeanOne
bean名称：com.qriver.spring.bean.BeanFive
bean名称：com.qriver.spring.bean.BeanFour
根据打印内容，可以判断BeanFive和BeanFour的实例也导入成功了。
4、基于ImportBeanDefinitionRegistrar实现类的导入方式
1、定义ImportBeanDefinitionRegistrar实现类
这种方法，需要首先定义一个ImportBeanDefinitionRegistrar实现类，并实现registerBeanDefinitions方法。和基于ImportSelector实现类的导入方式的区别在于，ImportSelector实现方式直接返回需要导入的类的全限定类名即可，但是在ImportBeanDefinitionRegistrar实现方式，需要先定义一个代表实例类的一个RootBeanDefinition实例，然后在把该RootBeanDefinition实例通过BeanDefinitionRegistry的registerBeanDefinition()方法注册到Spring IOC容器中。代码如下：
/**
* 定义一个ImportBeanDefinitionRegistrar的实现类
*/
public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(BeanThree.class);
registry.registerBeanDefinition("beanThree",rootBeanDefinition);
}
}
2、修改配置类
@Import({
BeanOne.class,MyImportSelector.class,MyImportBeanDefinitionRegistrar.class})
public class MainConfig {
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(MainConfig.class);
String[] beanNames = context.getBeanDefinitionNames();
for(int i=0;i<beanNames.length;i++){
System.out.println("bean名称："+beanNames[i]);
}
}
}
3、运行，打印内容如下：
……省略其他干扰的打印信息，包括默认的一些Bean打印信息
bean名称：mainConfig
bean名称：com.qriver.spring.bean.BeanOne
bean名称：com.qriver.spring.bean.BeanFive
bean名称：com.qriver.spring.bean.BeanFour
bean名称：beanThree
根据打印内容，可以判断beanThree的实例也导入成功了。
5、导入普通类的方式
从Spring4.2以后，也可以实现了普通类的导入了。比如，前面已经定义了BeanTwo类，直接在@import注解导入该类也可以。
配置类如下：
@Import({
BeanOne.class,BeanTwo.class,MyImportSelector.class,MyImportBeanDefinitionRegistrar.class})
public class MainConfig {
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(MainConfig.class);
String[] beanNames = context.getBeanDefinitionNames();
for(int i=0;i<beanNames.length;i++){
System.out.println("bean名称："+beanNames[i]);
}
}
}
运行，打印如下：
……省略其他干扰的打印信息，包括默认的一些Bean打印信息
bean名称：mainConfig
bean名称：com.qriver.spring.bean.BeanOne
bean名称：com.qriver.spring.bean.BeanTwo
bean名称：com.qriver.spring.bean.BeanFive
bean名称：com.qriver.spring.bean.BeanFour
bean名称：beanThree
根据打印内容，可以判断BeanTwo的实例也导入成功了。
6、总结
在Spring框架的源码学习中，发现使用基于ImportSelector实现类的这种方式被更广泛的使用，在Spring Boot自动加载默认配置类的过程中，大量使用了基于ImportSelector实现类这种方式的@Import注解，理解该注解有助于学习Spring框架的源码。还有另外一个注解@Conditional在Spring源码中广泛使用，它和@Import注解一起使用，灵活的实现了各种符合条件的类实例的加载。