@Import注解 -【Spring底层原理】

2401_84152126

于 2024-04-30 16:36:13 发布

阅读量401

点赞数 26

分类专栏：程序员文章标签： spring java 面试

本文链接：https://blog.csdn.net/2401_84152126/article/details/138350150

版权

程序员专栏收录该内容

190 篇文章 0 订阅

订阅专栏

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！

@Import注解也是用来给容器注册组件的，使用@Import注解快速给容器中导入一个组件有三种方法

导入@Configuration注解的配置类使用@Import（要导入到容器中的组件）：容器中就会自动注册这个组件，ID默认为全类名

导入ImportSelector的实现类：通过实现ImportSelector类，实现selectImports方法，返回需要导入组件的全类名数组

导入ImportBeanDefinitionRegistrar的实现类：通过实现ImportBeanDefinitionRegistrar类，实现registerBeanDefinitions方法手动注册Bean到容器中

@Target({ElementType.TYPE})

@Retention(RetentionPolicy.RUNTIME)

@Documented

public @interface Import {

Class<?>[] value();

}

通过注解源码可以看到，@Import注解作用在类上，并且参数可以是class类型的数组，从这里可以看出可以使用@Import注解一次导入多个组件到容器中

二、实例分析

从上面的注解用法来看，使用@Import注解给容器导入组件有三种方法，并且该注解作用在方法上，一次可以导入多个组件，因此，这里我们直接将三种方法都放在一个@Import注解来进行导入。如下案例需求：使用方法一注入User类、使用方法二注入Person类、使用方法三注入Animal类。

【1】导入@Configuration注解的配置类使用@Import

// 启动类，通过打印容器中的Bean来判断是否注入

@Test

public void TestMain(){

AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

String[] beanNames = applicationContext.getBeanDefinitionNames();

for (String beanName : beanNames) {

System.out.println(beanName);

}

// 待注入的User

public class User {

}

// 配置类

@Configuration

@Import(User.class) //使用@Import导入组件，ID默认是组件的全类名

public class AppConfig {

}

通过在配置类上使用@Import注解，将User给注入进容器中，运行启动类，可以看到容器中有User对象：

image-20210226164625069

【2】导入ImportSelector的实现类

导入ImportSelector的实现类需要实现ImportSelector类，自定义逻辑返回需要导入的组件，返回的字符串数组即是要注入的组件，添加修改如下代码：

// ImportSelector实现类

public class MyImportSelector implements ImportSelector {

/**

* @description 获取要导入到容器的组件全类名

* @author ONESTAR

* @date 2021/2/25 15:49

* @param annotationMetadata：当前标注@Import注解类的所有注解信息

* @throws

* @return java.lang.String[]

public String[] selectImports(AnnotationMetadata annotationMetadata) {

return new String[]{“bean.Person”};

}

// 待注入的Person

public class Person {

}

// 配置类

@Configuration

@Import({User.class, MyImportSelector.class}) //使用@Import导入组件，ID默认是组件的全类名

public class AppConfig {

}

在ImportSelector实现类中获取要导入到容器的组件全类名，这里将ImportSelector实现类在配置类中使用@Import注解进行配置，运行启动类，可以看到容器中有Person对象：

image-20210227151242060

【3】导入ImportBeanDefinitionRegistrar的实现类

导入ImportBeanDefinitionRegistrar的实现类需要实现ImportBeanDefinitionRegistrar类，通过实现registerBeanDefinitions方法手动注册Bean到容器中，添加修改如下代码：

// ImportBeanDefinitionRegistrar实现类

public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {

public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry beanDefinitionRegistry) {

// 指定Bean的名称

RootBeanDefinition beanDefinition = new RootBeanDefinition(Animal.class);

beanDefinitionRegistry.registerBeanDefinition(“Animal”, beanDefinition);

}

// 待注入的Animal

public class Animal {

}

// 配置类

@Configuration

@Import({User.class, MyImportSelector.class, MyImportBeanDefinitionRegistrar.class}) //使用@Import导入组件，ID默认是组件的全类名

public class AppConfig {

}

通过ImportBeanDefinitionRegistrar的实现类进行手动注册添加Bean，并在配置类中使用@Import注解进行配置，运行启动类，可以看到容器中有Animal对象：

image-20210227153057676

三、源码追踪

参考：https://blog.csdn.net/mamamalululu00000000/article/details/86711079

通过@Configuration注解，会进入到doProcessConfigurationClass方法，此时解析的是appConfigure，在doProcessConfigurationClass方法里面，有个执行@Import注解的方法，即processImports

this.processImports(configClass, sourceClass, this.getImports(sourceClass), filter, true);

@Import注解执行的时机，解析配置类的时候，由ConfigurationClassParser当中的processImports来处理，在分析processImports方法之前，咱们先来看看参数getImports方法：

【1】getImports方法

进入源码查看方法，这个方法就是获取所有的@import 里面的类，流程如下：

定义一个 visited 的集合，用作是否已经判断过的标志
这里就是获取sourceClass 上面的所有的 annotation，并挨个判断，如果不是 @import ，那就进一步递归调用对应的 annotation,直到全部结束
加载sourceClass 里面的@Import annotation 里面对应的类名，最后返回

// 获取所有的@import 里面的类

private Set<ConfigurationClassParser.SourceClass> getImports(ConfigurationClassParser.SourceClass sourceClass) throws IOException {

Set<ConfigurationClassParser.SourceClass> imports = new LinkedHashSet();

Set<ConfigurationClassParser.SourceClass> visited = new LinkedHashSet();

this.collectImports(sourceClass, imports, visited);

return imports;

}

// 这里就是获取sourceClass 上面的所有的 annotation，如果不是 @import ,那就进一步递归调用对应的 annotation,直到全部结束

private void collectImports(ConfigurationClassParser.SourceClass sourceClass, Set<ConfigurationClassParser.SourceClass> imports, Set<ConfigurationClassParser.SourceClass> visited) throws IOException {

if (visited.add(sourceClass)) {

Iterator var4 = sourceClass.getAnnotations().iterator();

while(var4.hasNext()) {

ConfigurationClassParser.SourceClass annotation = (ConfigurationClassParser.SourceClass)var4.next();

String annName = annotation.getMetadata().getClassName();

if (!annName.equals(Import.class.getName())) {

this.collectImports(annotation, imports, visited);

}

imports.addAll(sourceClass.getAnnotationAttributes(Import.class.getName(), “value”));

}

【2】processImports 方法