Spring源码深度解析-容器的基本实现

àì夳堔傛蜴生んèń 2021-10-15 05:33 365阅读 0赞

### 文章目录 ###

*  概述
 *  容器的基本用法及功能分析
 *  Spring的结构组成
 *   *  核心类介绍
     *   *  DefaultListableBeanFactory
         *  XMLBeanDefinitionReader
 *  容器的基础 XMLBeanFactory
 *   *  配置文件封装
     *  加载Bean
 *  获取xml的验证模式
 *  获取Document
 *  解析及注册BeanDefinitions
 *   *  profile属性的使用
     *  解析并注册BeanDefinition

# 概述 #

bean的加载与注册（容器的加载）

BeanFactory bf = new XmlBeanFactory(new ClassPathResource("beanFactoryTest.xml"));

容器加载的核心类是XmlBeanFactory，它继承自DefaultListableBeanFactory，并使用了自定义的XML读取器XmlBeanDefinitionReader。

从上面的代码可以看到，我们首先可以通过ClassPathResource的构造函数来构造Resource资源文件的实例对象，有了这个Resource实例后就可以进行XmlBeanFactory的初始化了。

XmlBeanFactory构造函数中会调用XmlBeanDefinitionReader类型的reader属性提供的方法this.reader.loadBeanDefinitions(resource);  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70]  
loadBeanDefinitions类会首先通过EncodedResource来对资源文件的编码进行处理，并接下来调用doLoadBeanDefinitions方法加载BeanDefinitions。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 1]  
doLoadBeanDefinition中会调用doLoadDocument方法将资源文件转换为Document实例，随后调用registerBeanDefinitions方法提取并注册bean。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 2]  
继续向下走会发现调用了DefaultBeanDefinitionDocumentReader的doRegisterBeanDefinitions方法完成了bean的解析及注册。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 3]

# 容器的基本用法及功能分析 #

bean是Spring中最核心的东西，因为Spring就像是个大水桶，而bean就像是容器中的水，水桶脱离了水便没有什么用处了，那么我们先看看bean的定义。

public class MyTestBean { 
        private String testStr = "testStr";
        
        public String getTestStr() { 
            return testStr;
        }
        
        public void setTestStr(String testStr) { 
            this.testStr = testStr;
        }
    }

然后在配置文件中进行bean的注入，这里我们只简单写xml配置文件中当前例子的这行：

之后可以通过下面的方式读取bean并生成实例：

@SuppressWarnings("deprecation")
    public class BeanFactoryTest { 
        
        public void testSimpleLoad() { 
            BeanFactory bf = new XmlBeanFactory(new ClassPathResource("beanFactoryTest.xml"));
            MyTestBean bean = (MyTestBean) bf.getBean("myTestBean");
        }
    }

上面的逻辑并不复杂，我们可以简单的分析出功能流程：

*  读取配置文件 beanFactoryTest.xml
 *  根据beanFactoryTest.xml中的配置找到对应的类的配置，并实例化
 *  调用实例化后的实例

不难分析出想完成上面的功能我们预设至少需要三个类：

*  ConfigReader：用于读取及验证配置文件。我们要用配置文件里面的东西，当然首先要做的就是读取，然后放置在内存中。
 *  ReflectionUtil：用于根据配置文件中的配置进行反射实例化。比如在上例中xml中的`<bean id = "myTestBean" class = "bean.MyTestBean"/>`，我们就可以根据`bean.MyTestBean`进行实例化。
 *  App：用于完成整个逻辑的串联

# Spring的结构组成 #

## 核心类介绍 ##

通过上面bean使用的简单演示，我们现在对beans有了一个初步的概念，但是在正式开始源码分析之前，有必要了解Spring中核心的两个类。

### DefaultListableBeanFactory ###

`XmlBeanFactory 继承自 DefaultListableBeanFactory，而DefaultListableBeanFactory是整个bean加载的核心部分，是spring注册及加载bean的默认实现`，而对于 XMLBeanFactory 与 DefaultListableBeanFactory `不同的地方其实是在 XMLBeanFactory中使用了自定义的XML读取器 XMLBeanDefinitionReader`，实现了个性化的BeanDefinitionReader，DefaultListableBeanFactory继承了 AbstractAutowireCapableBeanFactory并实现了 ConfigurableListableBeanFacotory 以及 BeanDefinationRegistry接口。以下是ConfigurableListableBeanFactory的层次结构图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 4]  
从上面的层次结构图中，我们可以很清晰的从全局角度了解DefaultListableBeanFactory的脉络，下面我们简单介绍下各个类的作用。

*  AliasRegistry：定义对 alias 的简单增删改等操作。
 *  SimpleAliasRegistry：主要使用 map 作为 alias 的缓存，并对接口 AliasRegistry 进行实现。
 *  SingletonBeanFactory：定义对单例的注册及获取。
 *  BeanFactory：定义获取 bean 及 bean 的各种属性。
 *  DefaultSingletonBeanRegistory：对接口 SingletonBeanRegistry 各函数的实现。
 *  HierarchicalBeanFactory：继承 BeanFactory，也就是在 BeanFactory 定义的功能的基础上增加了对 parentFactory 的支持。
 *  BeanDefinitionRegistry：定义对 BeanDefinition的各种增删改操作。
 *  FactoryBeanRegistrySupport：在 DefaultSingletonBeanRegistry 基础上增加了对 FactoryBean 的特殊处理功能。
 *  ConfigurableBeanFactory：提供配置 Factory 的各种方法。
 *  ListableBeanFactory：根据各种条件获取 bean 的配置清单。
 *  AbstractBeanFactory：综合 FactoryBeanRegistrySupport 和 ConfigurableBeanFactory 的功能。
 *  AutowiredCapableBeanFactory：提供创建 bean、自动注入、初始化以及应用 bean 的后处理器。
 *  AbstractAutowireCapableBeanFactory：综合 AbstractBeanFactory 并对接口 AutowireCapableBeanFactory进行实现。
 *  ConfigurableListableBeanFactory：BeanFactory配置清单，指定忽略类型及接口等。
 *  DefaultListableBeanFactory：综合上面所有功能。主要是对 Bean 注册后的处理。

XmlBeanFactory 对 DefaultListableBeanFactory 类进行了扩展，主要用于从 XML 文档中读取 BeanDefinition，对于注册即获取 Bean 都是使用从父类 DefaultListableBeanFactory 继承的方法去实现，而唯独与父类不同的个性化实现就是增加了 XMLBeanDefinitionReader 类型的 reader 属性。在 XMLBeanFactory 中主要使用 reader 属性对资源文件进行读取和注册。

### XMLBeanDefinitionReader ###

XML 配置文件的读取是 Spring 中重要的功能，因为 Spring 的大部分功能都是以配置作为切入点的，那么我们可以从 XMLBeanDefinitionReader 中梳理一下资源文件读取、解析及注册的大致脉络，首先我们看看各个类的功能。

*  ResourceLoader：定义资源加载器，主要应用于根据给定的资源文件地址返回对应的Resource。
 *  BeanDefinitionReader：主要`定义资源文件读取并转换为 BeanDefinition 的各个功能`。
 *  EnvironmentCapable：定义获取 Environment 方法。
 *  DocumentLoader：定义从资源文件加载到转换为 Document 的功能。
 *  AbstractBeanDefinitionReader：对EnvironmentCapable、BeanDefinitionReader 类定义的功能进行实现。
 *  BeanDefinitionDocumentReader：定义读取 Document 并注册 BeanDefinition 功能。
 *  BeanDefinitionParserDelegate：定义解析 Element 的各种方法。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 5]

经过以上分析，我们可以梳理出整个XML配置文件读取的大致流程，如上图所示，在 XMLBeanDefinitionReader 中主要包含以下几步的处理。

*  1）通过继承自 AbstractBeanDefinitionReader 中的方法，来使用 ResourceLoader 将资源文件路径转换为对应的 Resource 文件。
 *  2）通过 DocumentLoader 对 Resource 文件进行转换，将 Resource 文件转换为 Document 文件。
 *  3）通过实现接口 BeanDefinitionDocumentReader 和 DefaultBeanDefinitionDocumentReader 类对 Document 进行解析，并使用 BeanDefinitionParserDelegate 对 Element 进行解析。

# 容器的基础 XMLBeanFactory #

好了，到这里我们已经对 Spring 的容器功能有了一个大致的了解，尽管你可能还很迷糊，但是不要紧，接下来我们会详细探索每个步骤的实现。再次重申一下代码，我们接下来要深入分析以下功能的代码实现：

BeanFactory bf = new XmlBeanFactory(new ClassPathResource("beanFactoryTest.xml"));

通过XmlBeanFactory初始化时序图,我们可以看到代码的执行逻辑：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 6]  
时序图从BeanFactoryTest测试类开始，通过时序图我们可以一目了然地看到整个逻辑处理顺序。在测试的BeanFactoryTest中首先调用ClassPathResource的构造函数来构造Resource资源文件的实例对象，这样后续的资源处理就可以用Resource提供的各种服务来操作了，当我们有了Resource后就可以进行XmlBeanFactory的初始化了。那么Resource资源是如何封装的呢？

## 配置文件封装 ##

Spring的配置文件读取是通过ClassPathResource进行封装的，如`new ClassPathResource("beanFactoryTest.xml")`，那么ClassPathResource完成了什么功能呢？

。。。

## 加载Bean ##

之前提到的在`XMLBeanFactory构造函数中调用了XMLBeanDefinitionReader类型的reader属性提供的方法this.reader.loadBeanDefinations(resource)，而这句代码则是整个资源加载的切入点`，我们可以看到这个方法的时序图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 7]  
我们可以梳理整个的处理过程如下：

*  1.封装资源文件。当进入XMLBeanDefinitionReader后首先对参数Resource使用EncodedResource类进行封装。
 *  2.获取输入流。从Resource中获取对应的InputStream并构造InputSource。
 *  3.通过构造的InputSource实例和Resource实例继续调用函数doLoadBeanDefinition。

。。。

# 获取xml的验证模式 #

XML文件的验证模式保证了XML文件的正确性，而比较常用的验证模式有两种：DTD和XSD。它们之间有什么区别呢？

。。。

# 获取Document #

经过了验证模式的步骤就可以进行Document加载了，同样XmlBeanFactoryReader类对于文档读取并没有亲力亲为，而是委托给了DocumentLoader去执行，这里的DocumentLoader是个接口，而真正调用的是DefaultDocumentLoader。

。。。

# 解析及注册BeanDefinitions #

`当把文件转换为Document后，接下来的提取及注册bean`就是我们的重头戏。当程序已经拥有XML文档文件的Document实例对象时，就会被引入下面这个方法。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 8]  
其中参数doc是前面loadDocument加载转换出来的。在这个方法中很好的应用了面向对象中单一职责的原则，将逻辑处理委托给单一的类进行处理，而这个逻辑处理类就是BeanDefinitionDocumentReader。BeanDefinitionDocumentReader是一个接口，而实例化的工作是在createBeanDefinitionDocumentReader()中完成的，而通过此方法，BeanDefinitionDocumentReader真正的类型其实已经是DefaultBeanDefinitionDocumentReader了，进入DefaultBeanDefinitionDocumentReader后，发现这个方法的重要目的之一就是提取root，以便于再次将root作为参数继续BeanDefinition的注册。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 9]  
DefaultBeanDefinitionDocumentReader.java：

public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) { 
        this.readerContext = readerContext;
        this.logger.debug("Loading bean definitions");
        Element root = doc.getDocumentElement();
        this.doRegisterBeanDefinitions(root);
    }

经过艰难吸纳组，磕磕绊绊，我们终于到了核心逻辑的底层doRegisterBeanDefinitions(root)。

`如果说之前一直是XML加载解析的准备阶段，那么doRegisterBeanDefinitions算是真正地开始进行解析了，我们期待的核心部分真正开始了。`  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 10]  
DefaultBeanDefinitionDocumentReader.java：

protected void doRegisterBeanDefinitions(Element root) { 
    	// 专门处理解析
        BeanDefinitionParserDelegate parent = this.delegate;
        this.delegate = this.createDelegate(this.getReaderContext(), root, parent);
        if (this.delegate.isDefaultNamespace(root)) { 
        	// 处理profile属性
            String profileSpec = root.getAttribute("profile");
            if (StringUtils.hasText(profileSpec)) { 
                String[] specifiedProfiles = StringUtils.tokenizeToStringArray(profileSpec, ",; ");
                if (!this.getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) { 
                    if (this.logger.isInfoEnabled()) { 
                        this.logger.info("Skipped XML bean definition file due to specified profiles [" + profileSpec + "] not matching: " + this.getReaderContext().getResource());
                    }
    
                    return;
                }
            }
        }
    
    	// 解析前处理，留给子类实现
        this.preProcessXml(root);
        // 解析并注册BeanDefinition
        this.parseBeanDefinitions(root, this.delegate);
        // 解析后处理，留给子类实现
        this.postProcessXml(root);
        this.delegate = parent;
    }

。。。

## profile属性的使用 ##

。。。

## 解析并注册BeanDefinition ##

处理了profile后就可以进行XML的读取了，跟踪代码进入`parseBeanDefinitions(root, this.delegate)`。

protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) { 
    	// 对beans的处理
        if (delegate.isDefaultNamespace(root)) { 
            NodeList nl = root.getChildNodes();
    
            for(int i = 0; i < nl.getLength(); ++i) { 
                Node node = nl.item(i);
                if (node instanceof Element) { 
                    Element ele = (Element)node;
                    if (delegate.isDefaultNamespace(ele)) { 
                    	// 对bean的处理
                        this.parseDefaultElement(ele, delegate);
                    } else { 
                    	// 对bean的处理
                        delegate.parseCustomElement(ele);
                    }
                }
            }
        } else { 
            delegate.parseCustomElement(root);
        }
    
    }

。。。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70]: /images/20211015/4c16fd3aa72148b98eeec88d1dd6bb3f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 1]: /images/20211015/660ddf0db9fc46d9bb342c6e3a64afe9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 2]: /images/20211015/694fb0d3b2d94ebd8e13fce602094432.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 3]: /images/20211015/2eb0b246c814481184dd4deca2ad5e11.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 4]: /images/20211015/dc1c3bb5e6ec4f23b8628abda4a7d727.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 5]: /images/20211015/06cde2f396a54283b9572533fea66b2a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 6]: /images/20211015/3b405427437c40bd81915e55de5213c4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 7]: /images/20211015/6442228b13754b4181c8c38672e13f2e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 8]: /images/20211015/5c9a7c1cc59448e983fbbd80ac108787.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 9]: /images/20211015/ee5fcd76626f405a987a56b88e7e8203.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 10]: /images/20211015/33e0ae5537cd4ddebe37163f8cb090d4.png