Spring组件之BeanDefinitionRegistrar动态注册bean

BeanDefinitionRegistryPostProcessor和ImportBeanDefinitionRegistrar的区别

要想了解BeanDefinitionRegistryPostProcessor，那就要从他的父接口BeanFactoryPostProcessor说起

1、BeanFactoryPostProcessor

@FunctionalInterface 
public interface BeanFactoryPostProcessor { 
    void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException; 
}

该接口是spring的扩展点之一

• 实现该接口，可以在spring的bean创建之前修改bean的定义属性
• spring允许BeanFactoryPostProcessor在容器实例化任何其他bean之前读取配置元数据
• 并可以根据需要进行修改，例如可以把bean的scop从singleton改为protatype,也可以把property的值修改掉
• 同时配置多个BeanFactoryPostProcessor,并通过设置‘order’属性来控制各个BeanFactoryPostProcessor的执行顺序
• BeanFactoryPostProcessor是在spring容器加载了bean的定义文件之后，在bean实例化之前执行的

2、BeanDefinitionRegistryPostProcessor

public interface BeanDefinitionRegistryPostProcessor extends BeanFactoryPostProcessor { 
    void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException; 
}

• 继承了BeanFactoryPostProcessor，提供了向工厂注册BeanDefinition的方法
• ConfigurationClassPostProcessor就是该接口的一个实现类，他是初始化BeanFactoy最重要的类 ，没有之一；
• 该后置处理器实现了BeanFactoryPostProcessor 实例化过程中最核心的操作：解析配置类，解析注释，完成扫描，处理@Import导入的类，并将所有交给spring管理的类解析生成BeanDefinition，并将他们注册到BeanFactoryPostProcessor；
• 值得注意的：postProcessBeanFactory（）方法是在postProcessBeanDefinitionRegistry（）之后执行的. 假如有两个后置处理器BeanDefinitionRegistryPostProcessor1和BeanDefinitionRegistryPostProcessor2(按注入优先级)，他们进入方法步骤如下:

进入BeanDefinitionRegistryPostProcessor1
执行postProcessBeanDefinitionRegistry（）
进入BeanDefinitionRegistryPostProcessor2
执行postProcessBeanDefinitionRegistry（）
---------------------------------------------------------------------
进入BeanDefinitionRegistryPostProcessor1
执行postProcessBeanFactory（）
进入BeanDefinitionRegistryPostProcessor2
执行postProcessBeanFactory（）

3、ImportBeanDefinitionRegistrar

public interface ImportBeanDefinitionRegistrar { 
    public void registerBeanDefinitions( AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry); 
}

• spring的扩展点之一, 类似于BeanFactoryPostProcessor 可以插手beanFactory实例化过程
• 通常用于@Import(实现ImportBeanDefinitionRegistrar接口的类.class)

4、BeanDefinitionRegistryPostProcessor和ImportBeanDefinitionRegistrar用法的不同

@Component 
public class MyImportBeanDefinitionRegister implements ImportBeanDefinitionRegistrar { 
    @Override 
    public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry beanDefinitionRegistry) { 
        System.out.println("进入MyImportBeanDefinitionRegister"); } 
    }
}

@Component 
public class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor { 
    @Override 
    public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry beanDefinitionRegistry) throws BeansException { 
        System.out.println("进入BeanDefinitionRegistryPostProcessor");                 
        System.out.println("执行postProcessBeanDefinitionRegistry（）"); 
    } 

    @Override 
    public void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException {
        System.out.println("执行postProcessBeanFactory（）"); 
    } 
}

• 如上面代码，我们将两个接口实现类加注解交给Spring管理，控制台输出如下，即只执行了BeanDefinitionRegistryPostProcessor的方法

进入BeanDefinitionRegistryPostProcessor 执行 postProcessBeanDefinitionRegistry（） 执行 postProcessBeanFactory（）

假如我们在Config文件中添加@Import(MyImportBeanDefinitionRegister.class)

@Configuration 
@ComponentScan() 
@Import(MyImportBeanDefinitionRegister.class) 
public class AppConfig {

}

• 制台显示执行了MyImportBeanDefinitionRegister

进入MyImportBeanDefinitionRegister
15:54:03.799 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating shared instance of singleton bean 'myBeanDefinitionRegistryPostProcessor'
进入BeanDefinitionRegistryPostProcessor
执行postProcessBeanDefinitionRegistry（）
执行postProcessBeanFactory（）

执行流程分析:

BeanDefinitionRegistryPostProcessor

refresh

-> org.springframework.context.support.AbstractApplicationContext#invokeBeanFactoryPostProcessors

    -> org.springframework.context.support.PostProcessorRegistrationDelegate#invokeBeanDefinitionRegistryPostProcessors (解析组件) 第一次执行这个方法时解析应用导入的组件

        ->org.springframework.context.annotation.ConfigurationClassPostProcessor#processConfigBeanDefinitions 解析是否有@Configuration 并调用解析注解的方法

            ->org.springframework.context.annotation.ConfigurationClassParser#parse 解析 循环传进来的配置类(启动时传入的配置类)

                ->org.springframework.context.annotation.ConfigurationClassParser#processConfigurationClass 
                            -> doProcessConfigurationClass 真正解析方法, 分别解析@Component, @PropertySource,@ComponentScan, @Import, @ImportResource

----parse解析完毕, 会在后面的invokeBeanDefinitionRegistryPostProcessors(第二次)处执行我们实现了BeanDefinitionRegistryPostProcessor接口的方法

invokeBeanFactoryPostProcessors共调用了三次invokeBeanDefinitionRegistryPostProcessors()方法, 顺序分别为 带@PriorityOrdered, @Ordered和什么都不带的

 

ImportBeanDefinitionRegistrar

refresh

-> org.springframework.context.support.AbstractApplicationContext#invokeBeanFactoryPostProcessors

    -> org.springframework.context.support.PostProcessorRegistrationDelegate#invokeBeanDefinitionRegistryPostProcessors (解析组件) 第一次执行这个方法时解析应用导入的组件

        ->org.springframework.context.annotation.ConfigurationClassPostProcessor#processConfigBeanDefinitions 解析是否有@Configuration 并调用解析注解的方法

            ->org.springframework.context.annotation.ConfigurationClassParser#parse 解析 循环传进来的配置类(启动时传入的配置类)

                ->org.springframework.context.annotation.ConfigurationClassParser#processConfigurationClass         
                    -> doProcessConfigurationClass 真正解析方法, 分别解析@Component, @PropertySource, @ComponentScan @Import @ImportResource

             ->org.springframework.context.annotation.ConfigurationClassParser#processImports

解析我们的@Import最终会走到 else if (candidate.isAssignable(ImportBeanDefinitionRegistrar.class)) 这个分支, 把解析到的ImportBeanDefinitionRegistrar设置到该@Import配置类的属性中(此时我们手动@Import的MyImportBeanDefinitionRegistrar已经被扫描到)

---parse解析完毕, 紧接着会调用loadBeanDefinitionsForConfigurationClass

->org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader#loadBeanDefinitionsForConfigurationClass
    ->org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader#loadBeanDefinitionsFromRegistrars

循环获取类信息(我们自定义的组件), 获取到有ImportBeanDefinitionRegistrar属性(getImportBeanDefinitionRegistrars())的类时调用导入的实现了ImportBeanDefinitionRegistrar接口的的实现类的registerBeanDefinitions

总结

• BeanDefinitionRegistryPostProcessor实现类只要加注解（@Component）就可以执行，
• 而ImportBeanDefinitionRegister加注解（@Component可以不加）只是交给spring管理，并不会执行接口的方法，必须要在配置类中@Import()才会发挥作用；
• ImportBeanDefinitionRegister执行顺序更早
• mybatis中@MapperScan 注解就是利用ImportBeanDefinitionRegister
• 将接口生成代理类然后注册到BeanFactory中，这就是为什么mybatis中只有接口没有实现类的原因