Spring Boot 自动装配流程

旧城等待， 2022-08-28 05:46 182阅读 0赞

### Spring Boot 自动装配流程-1 ###

*  ImportSelector
 *   *  Import
     *  ImportSelector
     *  详解Spring的ImportSelector接口
     *   *  PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(xxx)方法
         *  ConfigurationClassPostProcessor
 *  Spring Boot Starter自动装配原理 全流程

> 本章的存在意义是记录本人在学习过程中， 记录自己的疑惑， 梳理知识点， 很多知识点会引用他人的文章，属于二次消化的一个系列

# ImportSelector #

## Import ##

SpringBoot 的 @Import 用于将指定的类实例注入之Spring IOC Container中。

[传送门][Link 1]

## ImportSelector ##

ImportSelector接口是spring中导入外部配置的核心接口

[传送门][Link 2]

**疑问点**

*  ImportSelector是如何被Spring框架调用的呢？

## 详解Spring的ImportSelector接口 ##

为了解决此疑惑， 特意去复习了一下spring的加载流程， 流程图如下  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_17_color_FFFFFF_t_70_g_se_x_16]

根据流程图可知， bean的初始化在 前几步之中， 那么import Select 接口的执行也必然在这之前  
![在这里插入图片描述][bc5c5a20503e4b87a6e1a8992f16ea2e.png]

我们以ClassPathXmlApplicationContext为例子，看看Spring在启动过程中是如何调用到ImportSelector接口的。

为了方便阅读， 这里整理了一些注释， 以及顺序整理成了从上到下的这么一个执行顺序

首先执行spring的核心方法 refresh

public void refresh() throws BeansException, IllegalStateException { 
            synchronized (this.startupShutdownMonitor) { 
                //刷新前的预处理;
                prepareRefresh();
    
                //获取BeanFactory；默认实现是DefaultListableBeanFactory，在创建容器的时候创建的
                ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
    
                //BeanFactory的预准备工作（BeanFactory进行一些设置，比如context的类加载器，BeanPostProcessor和XXXAware自动装配等）
                prepareBeanFactory(beanFactory);
    
                try { 
                    //BeanFactory准备工作完成后进行的后置处理工作
                    postProcessBeanFactory(beanFactory);
    
                    //执行BeanFactoryPostProcessor的方法；
                    invokeBeanFactoryPostProcessors(beanFactory);
    
                    //注册BeanPostProcessor（Bean的后置处理器），在创建bean的前后等执行
                    registerBeanPostProcessors(beanFactory);
    
                    //初始化MessageSource组件（做国际化功能；消息绑定，消息解析）；
                    initMessageSource();
    
                    //初始化事件派发器
                    initApplicationEventMulticaster();
    
                    //子类重写这个方法，在容器刷新的时候可以自定义逻辑；如创建Tomcat，Jetty等WEB服务器
                    onRefresh();
    
                    //注册应用的监听器。就是注册实现了ApplicationListener接口的监听器bean，这些监听器是注册到ApplicationEventMulticaster中的
                    registerListeners();
    
                    //初始化所有剩下的非懒加载的单例bean
                    finishBeanFactoryInitialization(beanFactory);
    
                    //完成context的刷新。主要是调用LifecycleProcessor的onRefresh()方法，并且发布事件（ContextRefreshedEvent）
                    finishRefresh();
                }
    
                ......
        }

从上面的实现中，我们可以看到该方法做了很多准备、初始化、事件通知等工作。具体的我们就不一一看了，今天我们只关心其中的invokeBeanFactoryPostProcessors方法。

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16]

从上面的代码中我们可以看到，invokeBeanFactoryPostProcessors()方法把具体的调用方法委托给了PostProcessorRegistrationDelegate类。另外，从该方法的名字当中我们也可以看出，该方法主要的目的是：实例化，并调用BeanFactoryPostProcessor类的。BeanFactoryPostProcessor是一个接口，有很多的实现类，这里我们就暂且不管BeanFactoryPostProcessor的具体用处了 (**Spring中BeanFactoryPostProcessor和BeanPostProcessor都是Spring初始化bean时对外暴露的扩展点**)。我们先进入PostProcessorRegistrationDelegate一窥究竟。

### PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(xxx)方法 ###

public static void invokeBeanFactoryPostProcessors(
                ConfigurableListableBeanFactory beanFactory, List<BeanFactoryPostProcessor> beanFactoryPostProcessors) { 
    
            // Invoke BeanDefinitionRegistryPostProcessors first, if any.
            // 如果有BeanDefinitionRegistryPostProcessors 的话，就先调用它们
            // 处理过的Beans
            Set<String> processedBeans = new HashSet<String>();
            // 是否是BeanDefinitionRegistry类型的BeanFactory. BeanDefinitionRegistry的作用是可以用来注册，删除，获取BeanDefinitions
            if (beanFactory instanceof BeanDefinitionRegistry) { 
                BeanDefinitionRegistry registry = (BeanDefinitionRegistry) beanFactory;
            // 普通类型的BeanFactoryPostProcessor集合
                List<BeanFactoryPostProcessor> regularPostProcessors = new LinkedList<BeanFactoryPostProcessor>();
            // BeanDefinitionRegistry类型的BeanFactoryPostProcessor集合（BeanDefinitionRegistryPostProcessor继承于BeanFactoryPostProcessor）
                List<BeanDefinitionRegistryPostProcessor> registryPostProcessors =
                        new LinkedList<BeanDefinitionRegistryPostProcessor>();
                            
            // 对集合beanFactoryPostProcessors进行分类，如果是BeanDefinitionRegistry类型的BeanFactoryPostProcessor；则调用方法 - postProcessBeanDefinitionRegistry()。、、
            // postProcessBeanDefinitionRegistry(BeanDefinitionRegistry)该方法的作用是在标准的BeanDefinitions初始化完成后可以修改容器上下文内部的beanDefinition。
                for (BeanFactoryPostProcessor postProcessor : beanFactoryPostProcessors) { 
                    if (postProcessor instanceof BeanDefinitionRegistryPostProcessor) { 
                        BeanDefinitionRegistryPostProcessor registryPostProcessor =
                                (BeanDefinitionRegistryPostProcessor) postProcessor;
                        registryPostProcessor.postProcessBeanDefinitionRegistry(registry);
                        registryPostProcessors.add(registryPostProcessor);
                    }
                    else { 
                        regularPostProcessors.add(postProcessor);
                    }
                }
    
                // Do not initialize FactoryBeans here: We need to leave all regular beans
                // uninitialized to let the bean factory post-processors apply to them!
                // Separate between BeanDefinitionRegistryPostProcessors that implement
                // PriorityOrdered, Ordered, and the rest.
                // 这里不要初始化FactoryBeans，我们需要保留这些普通的beans 不在这里初始化，目的是为了让bean factory post-processor去处理他们。
               // 根据BeanDefinitionRegistryPostProcessors 实现的不同接口，拆分开来去调用他们。
                String[] postProcessorNames =
                        beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);
    
                // First, invoke the BeanDefinitionRegistryPostProcessors that implement PriorityOrdered.
                // 首先，调用实现了优先级接口 - PriorityOrdered的BeanDefinitionRegistryPostProcessors 
                List<BeanDefinitionRegistryPostProcessor> priorityOrderedPostProcessors = new ArrayList<BeanDefinitionRegistryPostProcessor>();
                for (String ppName : postProcessorNames) { 
                    if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) { 
                        priorityOrderedPostProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));
                        processedBeans.add(ppName);
                    }
                }
                 // 排序
                sortPostProcessors(beanFactory, priorityOrderedPostProcessors);
                // 添加排序好的优先级PostProcessors到registryPostProcessors集合
                registryPostProcessors.addAll(priorityOrderedPostProcessors);
                // 调用排序好的优先级BeanDefinitionRegistryPostProcessors，postProcessBeanDefinitionRegistry方法会被调用，用来修改，获取，删除容器上下文中的bean定义。
                invokeBeanDefinitionRegistryPostProcessors(priorityOrderedPostProcessors, registry);
    
                // Next, invoke the BeanDefinitionRegistryPostProcessors that implement Ordered.
                // 调用实现了Ordered接口的BeanDefinitionRegistryPostProcessors ，大致逻辑同上PriorityOrdered的处理
                postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);
                List<BeanDefinitionRegistryPostProcessor> orderedPostProcessors = new ArrayList<BeanDefinitionRegistryPostProcessor>();
                for (String ppName : postProcessorNames) { 
                    if (!processedBeans.contains(ppName) && beanFactory.isTypeMatch(ppName, Ordered.class)) { 
                        orderedPostProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));
                        processedBeans.add(ppName);
                    }
                }
                sortPostProcessors(beanFactory, orderedPostProcessors);
                registryPostProcessors.addAll(orderedPostProcessors);
                invokeBeanDefinitionRegistryPostProcessors(orderedPostProcessors, registry);
    
                // Finally, invoke all other BeanDefinitionRegistryPostProcessors until no further ones appear.
                // 调用所有其它类型的BeanDefinitionRegistryPostProcessors
                boolean reiterate = true;
                while (reiterate) { 
                    reiterate = false;
                    postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);
                    for (String ppName : postProcessorNames) { 
                        if (!processedBeans.contains(ppName)) { 
                            BeanDefinitionRegistryPostProcessor pp = beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class);
                            registryPostProcessors.add(pp);
                            processedBeans.add(ppName);
                            pp.postProcessBeanDefinitionRegistry(registry);
                            reiterate = true;
                        }
                    }
                }
    
                // Now, invoke the postProcessBeanFactory callback of all processors handled so far.
                // 调用所有的BeanDefinitionRegistryPostProcessor的postProcessBeanFactory 方法。
                invokeBeanFactoryPostProcessors(registryPostProcessors, beanFactory);
               // 调用容器中BeanFactoryPostProcessor类型的bean（不包含BeanDefinitionRegistryPostProcessor类型的beans）。
                invokeBeanFactoryPostProcessors(regularPostProcessors, beanFactory);
            }
    
            else { 
                // Invoke factory processors registered with the context instance.
                // 若beanFactory不是BeanDefinitionRegistry类型的，则直接调用容器中所有的BeanFactoryPostProcessor的postProcessBeanFactory 方法。
                invokeBeanFactoryPostProcessors(beanFactoryPostProcessors, beanFactory);
            }
    
              // 下面是BeanFactoryPostProcessor的具体调用过程，和上面的过程很相似，这里就不多说了。
            // Do not initialize FactoryBeans here: We need to leave all regular beans
            // uninitialized to let the bean factory post-processors apply to them!
            String[] postProcessorNames =
                    beanFactory.getBeanNamesForType(BeanFactoryPostProcessor.class, true, false);
    
            // Separate between BeanFactoryPostProcessors that implement PriorityOrdered,
            // Ordered, and the rest.
            List<BeanFactoryPostProcessor> priorityOrderedPostProcessors = new ArrayList<BeanFactoryPostProcessor>();
            List<String> orderedPostProcessorNames = new ArrayList<String>();
            List<String> nonOrderedPostProcessorNames = new ArrayList<String>();
            for (String ppName : postProcessorNames) { 
                if (processedBeans.contains(ppName)) { 
                    // skip - already processed in first phase above
                }
                else if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) { 
                    priorityOrderedPostProcessors.add(beanFactory.getBean(ppName, BeanFactoryPostProcessor.class));
                }
                else if (beanFactory.isTypeMatch(ppName, Ordered.class)) { 
                    orderedPostProcessorNames.add(ppName);
                }
                else { 
                    nonOrderedPostProcessorNames.add(ppName);
                }
            }
    
            // First, invoke the BeanFactoryPostProcessors that implement PriorityOrdered.
            sortPostProcessors(beanFactory, priorityOrderedPostProcessors);
            invokeBeanFactoryPostProcessors(priorityOrderedPostProcessors, beanFactory);
    
            // Next, invoke the BeanFactoryPostProcessors that implement Ordered.
            List<BeanFactoryPostProcessor> orderedPostProcessors = new ArrayList<BeanFactoryPostProcessor>();
            for (String postProcessorName : orderedPostProcessorNames) { 
                orderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class));
            }
            sortPostProcessors(beanFactory, orderedPostProcessors);
            invokeBeanFactoryPostProcessors(orderedPostProcessors, beanFactory);
    
            // Finally, invoke all other BeanFactoryPostProcessors.
            List<BeanFactoryPostProcessor> nonOrderedPostProcessors = new ArrayList<BeanFactoryPostProcessor>();
            for (String postProcessorName : nonOrderedPostProcessorNames) { 
                nonOrderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class));
            }
            invokeBeanFactoryPostProcessors(nonOrderedPostProcessors, beanFactory);
    
            // Clear cached merged bean definitions since the post-processors might have
            // modified the original metadata, e.g. replacing placeholders in values...
            beanFactory.clearMetadataCache();
        }

上面的调用关系中，我们可以看出。在这个方法中有两种类型的PostPorcessor被调用处理了；而这两种PostProcessor的关系如下图：

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_12_color_FFFFFF_t_70_g_se_x_16]  
BeanDefinitionRegistryPostProcessor继承于BeanFactoryPostProcessor。我们大致看看接口定义的方法：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16 1]

postProcessBeanFactory用于在标准的初始化完成后修改容器上下文中的beanFactory。所有bean定义将被加载，但是它们将暂时不被实例化，这允许覆盖，甚至添加一些属性到延迟初始化的bean上。

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16 2]  
postProcessBeanDefinitionRegistry方法在标准化初始化完成后可以修改容器内部的bean definition registry。所有的常规的bean定义都将被加载，但是没有bean被实例化。这允许我们在下一个处理阶段增加一些新的bean定义。

综合上面的逻辑，postProcessBeanDefinitionRegistry是在postProcessBeanFactory方法之前被调用的。

### ConfigurationClassPostProcessor ###

ConfigurationClassPostProcessor类实现了BeanDefinitionRegistryPostProcessor接口，同时还实现了一些其他的接口，如下图：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16 3]

我们先来看看postProcessBeanDefinitionRegistry方法的具体内容  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16 4]

这个方法的主要作用是进一步从配置中获取bean的定义，也就是被@Configuration注解修饰的配置类。该方法中又调用了processConfigBeanDefinitions()方法，该方法主要用于处理@Configuration注解。

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16 5]  
这里忽略一些调用， 最终进入到  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16 6]  
processDeferredImportSelectors方法中调用了processImports方法执行导入，跟进去看看，在processImports 方法中有很重要的一段代码，如下：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16 7]

复盘

1.  ImportSelector的导入实现是通过BeanFactoryPostProcessor接口的子接口
2.  BeanDefinitionRegistryPostProcessor来实现的。
3.  ImportSelector接口的处理是伴随着@Configuration注解的处理一起处理的。
4.  ImportSelector接口可以实现自定义条件选择性导入classes。
5.  ImportSelector接口的字接口DeferredImportSelector在所有@Configuration处理完成后才被处理的。
6.  处理ImportSelector接口时，bean定义已经被加载，但是bean还没有被实例化。
7.  Spring Bootn的自动配置功能就是通过DeferredImportSelector接口的实现类
8.  EnableAutoConfigurationImportSelector做到的。

# Spring Boot Starter自动装配原理 全流程 #

[传送门][Link 3]

[Link 1]: https://blog.csdn.net/tuoni123/article/details/80213050
[Link 2]: https://blog.csdn.net/u011320740/article/details/105094866
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_17_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/7c3ea7b04b7a4379b1ed8cc17a00f86b.png
[bc5c5a20503e4b87a6e1a8992f16ea2e.png]: /images/20220828/124e18455dd74b62980262edd1d3d0cf.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/af68bd20133541c0b94de106182daccb.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_12_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/4ef07e4136504f04b1d7a6b46e32582b.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16 1]: /images/20220828/a5e77e879a96415b999068ef3a4c5024.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16 2]: /images/20220828/110e614e0b5c467587e2eee47273ea9f.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16 3]: /images/20220828/4746151bd2b7492ebfcca542e48d5813.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16 4]: /images/20220828/2d668e48c896456a875800e7af1a7ebe.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16 5]: /images/20220828/f39f5c36bb83458d92c1ebd25a14b221.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16 6]: /images/20220828/b0804591192243b89bbbf11e98d7b5b0.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBARWNrc1lhbmctMTEyOA_size_20_color_FFFFFF_t_70_g_se_x_16 7]: /images/20220828/1805fdacebc340bab6a2942f281c89a4.png
[Link 3]: https://blog.csdn.net/ypp91zr/article/details/107041933