Spring中BeanDefinitionRegistryPostProcessor接口 -【Spring底层原理】

柔情只为你懂 2021-09-21 21:34 266阅读 0赞

**目录**

一、概述

二、实例分析

三、源码分析

四、总结

--------------------

### 一、概述 ###

> 上一篇我们讲到spring中BeanFactoryPostProcessor可以对bean进行修改拓展，[Spring中BeanFactoryPostProcessor接口 -【Spring底层原理】][Spring_BeanFactoryPostProcessor_ -_Spring]，BeanDefinitionRegistryPostProcessor是BeanFactoryPostProcessor的一个子接口，那BeanDefinitionRegistryPostProcessor是不是可以对BeanDefinitionRegistry进行修改拓展呢，答案是肯定的，那什么是BeanDefinitionRegistry呢，了解BeanDefinitionRegistry，首先得要知道什么是BeanDefinition

【1】BeanDefinition

容器中的每一个bean都会有一个对应的`BeanDefinition`实例，该实例负责保存bean对象的所有必要信息，包括bean对象的class类型、是否是抽象类、构造方法和参数、其它属性等等。

【2】BeanDefinitionRegistry

BeanDefinition是定义bean的，BeanDefinitionRegistry则是bean定义信息的保存中心，也叫注册中心，保存了bean的所有定义，以后BeanFactory就是按照BeanDefinitionRegistry里面保存的每一个bean定义信息创建bean实例。bean是单例还是多例，bean的类型，bean的ID等信息，都是存在BeanDefinitionRegistry里面。

综上，**BeanDefinitionRegistryPostProcessor就是bean定义注册中心的后置处理器，允许我们修改拓展bean定义信息的注册中心，在所有bean定义信息将要被加载，bean实例还未创建的时候执行**

### 二、实例分析 ###

// 启动测试类
    @Test
    public void TestMain(){
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
        String[] beanNames = applicationContext.getBeanDefinitionNames();
        for (String beanName : beanNames) {
            System.out.println(beanName);
        }
    }
    
    // 待注入的bean
    public class User {
    }
    
    // BeanDefinitionRegistryPostProcessor实现类
    @Component
    public class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
        public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry beanDefinitionRegistry) throws BeansException {
            System.out.println("MyBeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry");
            System.out.println("bean的数量："+ beanDefinitionRegistry.getBeanDefinitionCount());
            // 通过bean的构建器生成rootbean
            AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(User.class).getBeanDefinition();
            beanDefinitionRegistry.registerBeanDefinition("hello",beanDefinition);
    
        }
    
        public void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException {
            System.out.println("MyBeanDefinitionRegistryPostProcessor#postProcessBeanFactory");
            System.out.println("bean的数量：" + configurableListableBeanFactory.getBeanDefinitionCount());
        }
    }
    
    // 配置类
    @Configuration
    @ComponentScan("postprocessor")
    public class AppConfig {
    }

可以看到输出结果如下，从中我们可以看出：

>  *  先执行postProcessBeanDefinitionRegistry方法，获取到IOC容器中bean的数量为7
>  *  然后给Registry里面注册一个hello
>  *  再执行postProcessBeanFactory方法，由于上面又注册了一个，所以这里获取到IOC容器中bean的数量为8
>  *  等BeanDefinitionRegistryPostProcessor里面的方法都执行完后，再执行BeanFactoryPostProcessor里面的方法

![image-20210319140530528][]

### 三、源码分析 ###

同样，我们通过Debug的方式来分析源码，在postProcessBeanDefinitionRegistry方法处打个断点，启动断点调试，根据方法调用栈来进行跟踪：

![image-20210319154228551][]

通过查看方法调用栈，可以作出如下分析：

>  *  启动IOC容器调用refresh方法
>  *  再依次调用invokeBeanFactoryPostProcessors()——>invokeBeanDefinitionRegistryPostProcessors()方法
>  *  在invokeBeanDefinitionRegistryPostProcessors方法中获取到currentRegistryProcessors参数

public static void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory, List<BeanFactoryPostProcessor> beanFactoryPostProcessors) {
        ......
        // 获取到BeanDefinitionRegistryPostProcessor组件
        postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);
        var16 = postProcessorNames;
        var9 = postProcessorNames.length;
    
        for(var10 = 0; var10 < var9; ++var10) {
            ppName = var16[var10];
            if (!processedBeans.contains(ppName) && beanFactory.isTypeMatch(ppName, Ordered.class)) {
                // 获取currentRegistryProcessors参数
                currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));
                processedBeans.add(ppName);
            }
        }
        
        ......
            while(reiterate) {
                reiterate = false;
                postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);
                String[] var19 = postProcessorNames;
                var10 = postProcessorNames.length;
    
                for(int var26 = 0; var26 < var10; ++var26) {
                    String ppName = var19[var26];
                    if (!processedBeans.contains(ppName)) {
                        currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));
                        processedBeans.add(ppName);
                        reiterate = true;
                    }
                }
    
                sortPostProcessors(currentRegistryProcessors, beanFactory);
                registryProcessors.addAll(currentRegistryProcessors);
                // 1.在这个方法里面触发postProcessBeanDefinnitionRegistry
                invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry, beanFactory.getApplicationStartup());
                currentRegistryProcessors.clear();
            }
        // 2.在这个方法里面触发postProcessBeanFactory方法
        invokeBeanFactoryPostProcessors((Collection)registryProcessors, (ConfigurableListableBeanFactory)beanFactory);
        invokeBeanFactoryPostProcessors((Collection)regularPostProcessors, (ConfigurableListableBeanFactory)beanFactory);
    	......
        // 3.在这个方法里面触发postProcessorBeanFactory方法
        invokeBeanFactoryPostProcessors((Collection)nonOrderedPostProcessors, (ConfigurableListableBeanFactory)beanFactory);
        ......
    }

从源码可以看到：

>  *  先获取BeanDefinitionRegistryPostProcessor组件
>  *  再按照一定规则（如优先级）加入到currentRegistryProcessors数组中
>  *  currentRegistryProcessors作为参数传给invokeBeanDefinitionRegistryPostProcessors方法，最后在这个方法执行
>  *  下图可以看到此时已经将自己写的MyBeanDefinitionRegistryPostProcessor组件给获取到了

![image-20210319155522363][]

【1】触发BeanDefinitionRegistryPostProcessor\#postProcessBeanDefinitionRegistry

进入invokeBeanDefinitionRegistryPostProcessors方法，可以看到，在这里获取到组件并触发了postProcessBeanDefinitionRegistry：

private static void invokeBeanDefinitionRegistryPostProcessors(Collection<? extends BeanDefinitionRegistryPostProcessor> postProcessors, BeanDefinitionRegistry registry, ApplicationStartup applicationStartup) {
        Iterator var3 = postProcessors.iterator();
    
        while(var3.hasNext()) {
            BeanDefinitionRegistryPostProcessor postProcessor = (BeanDefinitionRegistryPostProcessor)var3.next();
            StartupStep var10000 = applicationStartup.start("spring.context.beandef-registry.post-process");
            postProcessor.getClass();
            StartupStep postProcessBeanDefRegistry = var10000.tag("postProcessor", postProcessor::toString);
            // 触发postProcessBeanDefinnitionRegistry
            postProcessor.postProcessBeanDefinitionRegistry(registry);
            postProcessBeanDefRegistry.end();
        }
    }

【2】触发BeanDefinitionRegistryPostProcessor组件的BeanFactoryPostProcessor\#postProcessBeanFactory

在invokeBeanDefinitionRegistryPostProcessors方法执行完后，通过invokeBeanFactoryPostProcessors方法执行postProcessBeanFactory，点进源码进行查看：

private static void invokeBeanFactoryPostProcessors(Collection<? extends BeanFactoryPostProcessor> postProcessors, ConfigurableListableBeanFactory beanFactory) {
        Iterator var2 = postProcessors.iterator();
    
        while(var2.hasNext()) {
            BeanFactoryPostProcessor postProcessor = (BeanFactoryPostProcessor)var2.next();
            StartupStep var10000 = beanFactory.getApplicationStartup().start("spring.context.bean-factory.post-process");
            postProcessor.getClass();
            StartupStep postProcessBeanFactory = var10000.tag("postProcessor", postProcessor::toString);
            // 执行postProcessBeanFactory
            postProcessor.postProcessBeanFactory(beanFactory);
            postProcessBeanFactory.end();
        }
    }

【3】触发其他组件的BeanFactoryPostProcessor\#postProcessBeanFactory

private static void invokeBeanFactoryPostProcessors(Collection<? extends BeanFactoryPostProcessor> postProcessors, ConfigurableListableBeanFactory beanFactory) {
        Iterator var2 = postProcessors.iterator();
    
        while(var2.hasNext()) {
            BeanFactoryPostProcessor postProcessor = (BeanFactoryPostProcessor)var2.next();
            StartupStep var10000 = beanFactory.getApplicationStartup().start("spring.context.bean-factory.post-process");
            postProcessor.getClass();
            StartupStep postProcessBeanFactory = var10000.tag("postProcessor", postProcessor::toString);
            // 触发postProcessorBeanFactory方法
            postProcessor.postProcessBeanFactory(beanFactory);
            postProcessBeanFactory.end();
        }
    
    }

通过源码可以看到的执行顺序：

> 1.  执行BeanDefinitionRegistryPostProcessor\#postProcessBeanDefinitionRegistry
> 2.  执行BeanDefinitionRegistryPostProcessor组件的BeanFactoryPostProcessor\#postProcessBeanFactory
> 3.  执行其他组件的BeanFactoryPostProcessor\#postProcessBeanFactory

### 四、总结 ###

1.  AnnotationConfigApplicationContext：创建IOC对象
2.  refresh()——>invokeBeanFactoryPostProcessors()：执行BeanDefinitionRegistryPostProcessor
3.  从容器中获取到所有的BeanDefinitionRegistryPostProcessor组件
    
    1.  依次触发所有的postProcessBeanDefinitionRegistry()方法
    2.  再来触发postProcessorBeanFactory()方法BeanFactoryPostProcessor
4.  再来从容器中找到BeanFactoryPostProcessor组件，然后依次触发postProcessorBeanFactory()方法

从这个总结也可以看出**postProcessBeanDefinitionRegistry()方法要先于BeanFactoryPostProcessor()执行**

[Spring_BeanFactoryPostProcessor_ -_Spring]: https://mp.weixin.qq.com/s?__biz=MzU2MDQ2MTE5MA==&mid=2247484414&idx=1&sn=1c7aa87a85ab700fa218eb18c246dff7&chksm=fc06e717cb716e01ff54a9616643ca1459b99173b43c27c4e5d176d8267abb7eb17446a77c30&token=262250173&lang=zh_CN#rd
[image-20210319140530528]: /images/20210920/e6be382cf48b4640b7013ad68b046b41.png
[image-20210319154228551]: /images/20210920/03e35c534c6b4303a6099d9004797a7c.png
[image-20210319155522363]: /images/20210920/274a6e9ef088410485f04641c1940bf2.png