您的位置: 首页  >  文章  >  Spring 与组件注入相关的注解之 @Import

Spring 与组件注入相关的注解之 @Import

分类: 文章 • 2024-05-06 17:25:28
前言：

前面已经介绍了十好几个与组件注入相关的注解了，这里再介绍一个，但也是在 springboot 源码中经常出现的一个，因此还是比较重要的。

注解简介：

@Import 也是用于向 IOC 容器中注入相应组件的。通过查看 @Import 的源码：
Spring 与组件注入相关的注解之 @Import
该注解需要标注在类上，且仅有一个 value 属性，value 属性的注释信息已经做了很好的解释，即 value 属性

  • 要么是普通的组件（标识了 @Component 注解等），
  • 要么是 ImportSelector 接口的实现类，
  • 要么是 ImportBeanDefinitionRegistrar 接口的实现类。
实验：
第一种方式：
  1. 自定义一个类，例如 Teacher 等等；
  2. 在配置类上标注上 @Import 注解，就可以实现 Teacher 组件的注入：
	@Import(value={Teacher.class})
	public class SpringConfig2 {

	}

这种方式默认注入的组件的id为全类名，例如 com.uestc.auto.xiaoxie.bean.Teacher。

第二种方式：
  1. 自定义一个实现了 ImportSelector 接口（它可以帮助我们根据导入特定的组件）的类，如 MyImportSelector；
  2. 重写接口的 selectImports() 方法；
// 自定义逻辑导入特定的组件
public class MyImportSelector implements ImportSelector{

   /**
    * Select and return the names of which class(es) should be imported based on
    * the {@link AnnotationMetadata} of the importing @{@link Configuration} class.
    *
    * AnnotationMetadata: 标注 @Import 注解的类的所有注解信息（稍后通过 debug 源码也可以看到）
    */
   @Override
   public String[] selectImports(AnnotationMetadata importingClassMetadata) {
   	Set<String> annotationTypes = importingClassMetadata.getAnnotationTypes();
   	System.out.println("=============");
   	System.out.println(annotationTypes); // 打印结果：[org.springframework.context.annotation.Configuration, org.springframework.context.annotation.ComponentScans, org.springframework.context.annotation.Import]
   	System.out.println("=============");
   	
   	// 该方法的返回值为需要导入的组件的全类名。
   	return new String[]{"com.uestc.auto.xiaoxie.bean.Professor", "com.uestc.auto.xiaoxie.bean.Student"}; // 在 return 前面打上断点，进行调试
   }
}

需要额外说明一点：selectImports() 方法中如果不注入任何组件的话，最好返回一个空数组；否则会抛出空指针异常。原因如下图所示，debug 源码的时候，需要现在 ApplicationContext 的创建（我是写在单元测试的 beforeMethod 方法中了）以及 selectImports() 方法的 return 语句打上两个断点：
Spring 与组件注入相关的注解之 @ImportSpring 与组件注入相关的注解之 @Import
3. 在配置类上的 @Import 注解中添加上这个类：@Import(value={Teacher.class, MyImportSelector.class})，就可以再将 Professor 和 Student 这两个类注入到容器中。

第三种方式：
  1. 自定义一个实现了 ImportBeanDefinitionRegistrar 接口的实现类，如 MyImportBeanDefinitionRegister；
  2. 重写接口的 registerBeanDefinitions() 方法；
public class MyImportBeanDefinitionRegister implements ImportBeanDefinitionRegistrar{

   /*
    * AnnotationMetadata: 标注 @Import 注解的类的所有注解信息
    * BeanDefinitionRegistry: Bean定义的注册类
    */
   @Override
   public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
   	 	// Register a new bean definition with this registry. 
   	 	// Must support RootBeanDefinition and ChildBeanDefinition.
    		
   		// registry.registerBeanDefinition(String beanName, BeanDefinition beanDefinition);
   		registry.registerBeanDefinition("boy", new RootBeanDefinition(Boy.class)); // 依然可以仿照前面的思路，在这一行的前面打断点，观察是何时执行的。
   }
}
  1. 在配置类上的 @Import 注解中添加上这个类：@Import(value={Teacher.class, MyImportSelector.class, MyImportBeanDefinitionRegister.class})，就可以再将 Boy 这两个组件注入到容器中。
小结：

到目前为止，已经总结了很多与组件注入相关的注解。建议多写几个 demo 分开进行测试，免得影响测试结果，进一步影响对注解的理解。 另外，用好 debug，这个真的太重要了！！！

相关推荐