前言

通过这篇文章来大家分享一下另外一个Springboot的扩展点BeanDefinitionRegistryPostProcessor一般称这类扩展点为容器级后置处理器另外一类是Bean级的后置处理器容器级的后置处理器会在Spring容器初始化后、刷新前这个时间执行一次Bean级的重置处理器则是在每一个Bean实例化前后都会执行。

1. 功能特性

1. postProcessBeanDefinitionRegistry()方法可以通过BeanDefinitionRegistry对BeanDefintion进行增删改查

2. 继承了BeanFactoryPostProcessorBeanFactoryPostProcessor是容器级别的扩展接口org.springframework.beans.factory.config.BeanFactoryPostProcessor#postProcessBeanFactory方法在容器实例化后、刷新容器前被执行即在容器刷新前还可以对BeanDefintion再作一些操作

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

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

总结起来就是在所有的BeanDefinition加载完成之后Bean真正被实例化之前可以通过实现BeanDefinitionRegistryPostProcessor接口对BeanDefinition再做一些定制化的操作比如修改某个bean的BeanDefinition的属性、手动注册一些复杂的Bean。

对于Spring原理不太熟悉的小伙伴心里看到这可能有点晕了BeanDefinition是什么BeanDefinitionRegistry又是什么ConfigurableListableBeanFactory又又是什么别着急这里拐个弯简单的解释一下对整篇文章的理解会更顺畅。

1.1 BeanDefinition

大家都知道Spring的核心之一是IOC控制反转Spring之所以可以实现bean控制权的反转是因为Spring的容器功能在bean纳入Spring容器管理前所有bean会被抽象封装成一个BeanDefinition实例然后会在不同的时机根据BeanDefinition实例信息对bean进行实例化。

简单说Dog.java描述狗这一类动物的属性和行为BeanDefinition描述Dog.java这个类。

1.2 BeanDefinitionRegistry

BeanDefinitionRegistry从字面意思看是bean的定义信息的注册登记其实这个类的功能和字面意思一样就是对BeanDefinition进行管理增删改查

public interface BeanDefinitionRegistry extends AliasRegistry {
    //注册beanDefinition
   void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
         throws BeanDefinitionStoreException;
    //移除指定的beanDefinition
   void removeBeanDefinition(String beanName) throws NoSuchBeanDefinitionException;
    //根据beanName查询beanDefinition
   BeanDefinition getBeanDefinition(String beanName) throws NoSuchBeanDefinitionException;
    //判断某个beanDefinition是否已经注册
   boolean containsBeanDefinition(String beanName);
    //获取所有已注册的beanDefinition
   String[] getBeanDefinitionNames();
    //获取所有已注册的beanDefinition的数量
   int getBeanDefinitionCount();
    //判断某个beanDefinition是否已经被使用
   boolean isBeanNameInUse(String beanName);
}

1.3 ConfigurableListableBeanFactory

上面提到了Spring的容器Spring的核心之一是IOC那么Spring的容器设计就是核心中的核心了。Spring的容器有多种形态最基础的形态就是BeanFactoryConfigurableListableBeanFactory间接继承了BeanFactory因此ConfigurableListableBeanFactory实现类除了有Spring基础版本容器的功能外还有一些高级的功能Springboot默认的实际实现是DefaultListableBeanFactory有兴趣的小伙伴可以以此为入口深入探究一番这里不展开细说了。

2.自定义实现

2.1 MyBeanDefinitionRegistryPostProcessor

下面通过一个具体类MyBeanDefinitionRegistryPostProcessor实现BeanDefinitionRegistryPostProcessor接口来探究BeanDefinitionRegistryPostProcessor实现类的初始化和执行过程。

1. 在postProcessBeanDefinitionRegistry()方法被调用的时候手工在Spring中注册了Dog类的BeanDefinition信息

2. 在postProcessBeanFactory()方法被调用的时候从Spring容器中取出Dog类的BeanDefinition信息和Dog类的实例

@Data
public class Dog {
    private String name;
    private String color;
}

@Component
public class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
    @Override
    public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
        //手工定义一个beanDefinition实例
        RootBeanDefinition beanDefinition = new RootBeanDefinition();
        //给beanDefinition填充属性
        beanDefinition.setBeanClass(Dog.class);
        MutablePropertyValues propertyValues = new MutablePropertyValues();
        PropertyValue propertyValue1 = new PropertyValue("name", "旺财");
        PropertyValue propertyValue2 = new PropertyValue("color", "黑色");
        propertyValues.addPropertyValue(propertyValue1);
        propertyValues.addPropertyValue(propertyValue2);
        beanDefinition.setPropertyValues(propertyValues);
        //注册手工定义的beanDefinition
        registry.registerBeanDefinition("dog", beanDefinition);
    }
    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        System.out.println("-----------start------------");
        //根据类名取出手工注册的beanDefinition
        BeanDefinition beanDefinition = beanFactory.getBeanDefinition("dog");
        System.out.println(beanDefinition.getBeanClassName());
        //根据类从容器中取出手工注册的beanDefinition所描述的实例bean
        Dog dog = beanFactory.getBean(Dog.class);
        System.out.println(dog.getName());
        System.out.println(dog.getColor());
        System.out.println("-----------end------------");
    }
}

单元测试

@Test
public void test(){
    AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext("com.fanfu");
    Dog dog = ((Dog) context.getBean("dog"));
    System.out.println(dog.getName());
    System.out.println(dog.getColor());
}

2.2 UML类图

通过BeanDefinitionRegistryPostProcessorUML类图可以看出BeanDefinitionRegistryPostProcessor继承了BeanFactoryPostProcessorpostProcessBeanDefinitionRegistry()方法属于BeanDefinitionRegistryPostProcessorpostProcessBeanFactory()属于BeanFactoryPostProcessor所有实现了BeanDefinitionRegistryPostProcessor接口的实现类都需要实现这两个方法而作为Springboot的扩展点之一其扩展的逻辑也在这两个方法中。

3. 初始化和执行时机

通过自定义的MyBeanDefinitionRegistryPostProcessor类实现BeanDefinitionRegistryPostProcessor接口从项目启动开始其执行过程如下

1. 执行项目的主类org.springframework.boot.SpringApplication#run被调用

2. 进入boot.SpringApplication#run方法后刚开始是一些Spring容器初始化的配置操作直到执行到org.springframework.boot.SpringApplication#refreshContext开始容器刷新进入了关键阶段

3. 在SpringApplication#refreshContext实际的刷新逻辑是在org.springframework.context.support.AbstractApplicationContext#refresh方法中

4. AbstractApplicationContext#refresh方法中调用org.springframework.context.support.AbstractApplicationContext#invokeBeanFactoryPostProcessors开始初始化和执行实现BeanDefinitionRegistryPostProcessor接口的postProcessBeanDefinitionRegistry()和postProcessBeanFactory()

5. 进入AbstractApplicationContext#invokeBeanFactoryPostProcessors方法发现又调用了org.springframework.context.support.PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors()

6. 在PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors()方法中并不是直接就初始化和执行postProcessBeanDefinitionRegistry()和postProcessBeanFactory()而是又进行了一系列的判断其判断顺序是1、通过AbstractApplicationContext#addBeanFactoryPostProcessor提前注册的BeanDefinitionRegistryPostProcessor实现类2、实现了PriorityOrdered接口3、是否实现了Ordered4、剩下的其他BeanDefinitionRegistryPostProcessor实现类自定义的MyBeanDefinitionRegistryPostProcessor就属于第4类所以是所有实现里较晚才被执行的如果想要提前被执行可以考虑前面三种方式

7. 在PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors()方法中执行完MyBeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry方法后紧接着就开始执行MyBeanDefinitionRegistryPostProcessor#postProcessBeanFactory方法了从整个调用过程看postProcessBeanDefinitionRegistry()是早于postProcessBeanFactory()方法执行

下面是我根据整个调用过程画的一个时序图过程确实比较复杂但是逻辑比较清晰因此并不难理解想要真的搞清楚整个过程最好的方法就是照着这个图亲自执行一遍通过debug观察每一个关键节点的执行过程。

4. 内部实现类

spring-boot-starter-web中内置的实现类有CachingMetadataReaderFactoryPostProcessor、ConfigurationClassPostProcessor、ConfigurationWarningsPostProcessor、EmbeddedDataSourceBeanFactoryPostProcessor、ImportsCleanupPostProcessor、TestRestTemplateRegistrar、WebTestClientRegistrar、WsdlDefinitionBeanFactoryPostProcessor观察一下每个实现类会发现都比较类似这些内置实现类都是Springboot中的内部类通过这些BeanDefinitionRegistryPostProcessor内部实现类向Spring容器中注册了一些特殊的BeanDefinition如果展开详细再说一说这些Bean怕是一天一夜也说不完有兴趣的小伙伴可以深入了解一下这里就不再展开了。

5. 总结

通过梳理整个过程其实最关键的就是一句话在Spring容器初始后、未刷新前即Bean已被扫描注册为BeanDefinition后未正式实例化前可以通过实现BeanDefinitionRegistryPostProcessor做一些额外的操作。