Spring中@Import注解源码分析

基础知识

我们知道@Import注解是向容器中导入bean的。

@Import的注解主要作用于类上，往往搭配@Configuration，ImportSelector接口，还有ImportBeanDefinitionRegistrar往IOC容器中放入bean

@Import导入bean的三种方式

1、class数组的方式

2、ImportSelector接口的方式，即批量导入（源码解析）

3、ImportBeanDefinitionRegistrar接口方式，即手工注册bean到容器中

class数组方式直接导入

@Configuration
@Import({Apple.class})
public class MainConfig {


    @Primary
    @Bean
    public Orange orange(){
        return new Orange();
    }

}

我们向容器中导入Apple Bean只需要将其class填入@Import参数数组中

 @Test
    public  void test01(){
        AnnotationConfigApplicationContext applicationContext = new
                AnnotationConfigApplicationContext(MainConfig.class);

        String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            System.out.println(beanDefinitionName);
        }

    }

打印输出IOC容器中的BeanName

可以看到这种方式，直接向容器中导入组件，但是BeanName是全限定类名

ImportSelector接口的方式，即批量导入

ImportSelector是一个接口，我们需要实现它


ImportSelector导入组件，实现接口，重写importSelect 选择导入那些组件进入IOC容器，返回字符串数组。

测试

可以看到Person实际上也成功导入IOC容器中

ImportSelector导入Bean源码分析

在我们实现类中打一断点

执行流程如下

1、创建IOC容器

2、调用refresh方法中的invokeBeanFactoryPostProcessors(beanFactory); 调用Bean工厂的后置处理器生成beanDefinition，放入Bean工厂Map中

@Override
	public void refresh() throws BeansException, IllegalStateException {
		synchronized (this.startupShutdownMonitor) {
			// 为刷新IOc容器准备上下文
			prepareRefresh();

			// 告诉子类刷新内部的beanFactory容器
			ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();

			// 准备Beanfactory在这个上下文中使用
			prepareBeanFactory(beanFactory);

			try {
				// 后置处理BeanFactory
				postProcessBeanFactory(beanFactory);

				//调用Beanfactory的后置处理器，这里主要是生成BeanDefinition
				 invokeBeanFactoryPostProcessors(beanFactory);

				//注册Bean的后置处理器
				registerBeanPostProcessors(beanFactory);

				// Initialize message source for this context.
				initMessageSource();

				// Initialize event multicaster for this context.
				initApplicationEventMulticaster();

				// Initialize other special beans in specific context subclasses.
				onRefresh();

				// Check for listener beans and register them.
				registerListeners();

				// 实例化BeanFactory中BeanDefinitionMap中定义的BeanDefinition
				finishBeanFactoryInitialization(beanFactory);

				// 发布对应事件
				finishRefresh();
			}

			catch (BeansException ex) {
				if (logger.isWarnEnabled()) {
					logger.warn("Exception encountered during context initialization - " +
							"cancelling refresh attempt: " + ex);
				}

				// Destroy already created singletons to avoid dangling resources.
				destroyBeans();

				// Reset 'active' flag.
				cancelRefresh(ex);

				// Propagate exception to caller.
				throw ex;
			}

			finally {
				// Reset common introspection caches in Spring's core, since we
				// might not ever need metadata for singleton beans anymore...
				resetCommonCaches();
			}
		}
	}

经过一系列其它判断后，会扫描到@Import注解，对其进行处理。
此处中间步骤省略。

扫描组件，解析处理@Import注解

解析@Import注解会去找ImportSelector接口的实现类，调用其方法最终，走入到我们的实现类中，我们在实现类中定义了需要注入到IOC容器中的组件的全限定类名。返回字符串数组。

注意：此时导入的Bean还没有生成BeanDefinition

将扫描到的组件封装成ConfigurationClass放入到LinkedHashSet中

我们向容器中放入三个组件标识了注解，这里都扫描到了，放入到一个hashSet中

loadBeanDefinitions(configClasses)将这些ConfigurationClass生成BeanDefinition，放入到BeanFactory中的BeanDefinitionMap中

此时容器中BeanDefinition已经全部准备完毕

3、调用refresh方法中的finishBeanFactoryInitialization(beanFactory); 将BeanFactory中定义的BeanDefinitionMap中对 Bean全部实例化。

实例化全部单实例Bean

实例化之前，会先判断容器中是否存在，通过getBean（name），获取对应Bean实例。如果不存在直接通过反射创建。
容器创建启动，默认不存在，所以是直接创建

最终走到我们默认构造方法中

使用ImportBeanDefinitionRegistrar向容器中注册bean

由于ImportBeanDefinitionRegistrar为接口，因此我们需要实现它

public class MyImportBeanDefinitionRegistry implements ImportBeanDefinitionRegistrar {

	/**
	 * AnnotationMetadata：当前类的注解信息
	 * BeanDefinitionRegistry：BeanDefinition注册类
	 * 
	 * 我们可以通过调用BeanDefinitionRegistry接口中的registerBeanDefinition方法，手动注册所有需要添加到容器中的bean
	 */

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

    }
}

通过上面的源码分析，我们定义的Bean加上对应注解，扫描时会生成BeanDefinition，然后放入到对应的beanFactory中的BeanDefinitionMap中，最后容器为他们实例化

通过ImportBeanDefinitionRegistrar我们可以自己定义BeanDefinition，容器会帮我们创建实例

使用：

public class MyImportBeanDefinitionRegistry implements ImportBeanDefinitionRegistrar {

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

        RootBeanDefinition beanDefinition = new RootBeanDefinition(Water.class);
        
        registry.registerBeanDefinition("water",beanDefinition);
    }
}

通过@Import导入到容器

@Configuration
@Import({Apple.class, MyImportSelector.class, MyImportBeanDefinitionRegistry.class})
public class MainConfig {


    @Primary
    @Bean
    public Orange orange(){
        return new Orange();
    }

}

结果：

可以看到通过ImportBeanDefinition 导入Bean也是可以的，而且名字自定义。

总结

1、@Import({XXx.class})，Bean名字为全限定类名

2、@Import({XXXImportSelector.class})，Bean名字为全限定类名

3、@Import({XXXImportBeanDefinitionRegistry.class})，Bean名字可以自定义

4、Bean导入原理

4.1、IOC容器创建好之后，通过BeanFactoryPostProcessor，对我们定义的Bean进行扫描，生成BeanDefinition对象，放入BeanFactory的BeanDefinitionMap中

4.2、refresh方中，获取BeanDefinitionMap遍历，生成对应的实例对象放入IOC容器中