IOC体系结构
¶BeanFactory
ClassPathXmlApplicationContext 使用代码执行xml文件的类,是一个入口方法
通过这个文件向上找,会发现最终会继承ListableBeanFactory、HierarchicalBeanFactory等等一些实现了BeanFactory的抽象类
所以通过这个入口,我们发现BeanFactory是spring一切的基础,最顶级的抽象类
- ListableBeanFactory:可列表化的bean工厂
- HierarchicalBeanFactory:有层级关系的bean工厂(有父子继承关系的)
- AutowireCapableBeanFactory:可自动注入的Bean工厂
1 | public interface BeanFactory { |
在 BeanFactory 里只对 IOC 容器的基本行为作了定义,根本不关心你的 bean 是如何定义怎样加载的。
正如我们只关心工厂里得到什么的产品对象,至于工厂是怎么生产这些对象的,这个基本的接口不关心。
要知道工厂是如何产生对象的,我们需要看具体的 IOC 容器实现,Spring 提供了许多 IOC 容器的
实现。比如 XmlBeanFactory,ClasspathXmlApplicationContext 等。其中 XmlBeanFactory 就是针对最
基本的 IOC 容器的实现,这个 IOC 容器可以读取 XML 文件定义的 BeanDefinition(XML 文件中对 bean
的描述),如果说 XmlBeanFactory 是容器中的低配屌丝,ApplicationContext 应该算容器中的高帅富
从 ApplicationContext 接口的实现,我们看出其特点:
1 | public interface ApplicationContext extends EnvironmentCapable, ListableBeanFactory, HierarchicalBeanFactory, |
1.支持信息源,可以实现国际化。(实现 MessageSource 接口)
2.访问资源。(实现 ResourcePatternResolver 接口)
3.支持应用事件。(实现 ApplicationEventPublisher 接口)
¶BeanDefinition
这个主要是存储了bean定义的一些配置信息(其实就是讲xml中配置的信息,保存到BeanDefinition)
SpringIOC 容器管理了我们定义的各种 Bean 对象及其相互的关系,Bean 对象在 Spring 实现中是以
BeanDefinition 来描述的,其继承体系如下:
Bean 的解析过程非常复杂,功能被分的很细,因为这里需要被扩展的地方很多,必须保证有足够的灵
活性,以应对可能的变化。Bean 的解析主要就是对 Spring 配置文件的解析。这个解析过程主要通
过下图中的类完成:
IOC容器的初始化
IOC 容器的初始化包括 BeanDefinition 的 Resource 定位、载入和注册这三个基本的过程
- 定位:就是找到定义的xml配置文件在哪里
- 加载:通过xml解析工具解析xml文件
- 注册:将配置信息交给beanFactory,对xml中的bean进行创建生产
以ApplicationContext 为例,ApplicationContext 系列容器也许是我们最熟悉的,因为 web 项目中
使用的 XmlWebApplicationContext 就属于这个继承体系,还有 ClasspathXmlApplicationContext 等,
其继承体系如下图所示:
ApplicationContext 允许上下文嵌套,通过保持父上下文可以维持一个上下文体系。对于 bean 的查找
可以在这个上下文体系中发生,首先检查当前上下文,其次是父上下文,逐级向上,这样为不同的 Spring
应用提供了一个共享的 bean 定义环境。
使用FileSystemXmlApplicationContext和使用ClassPathXmlApplicationContext的区别在于:
- FileSystemXmlApplicationContext在指定的文件系统路径下查找xml文件和本项目下的classPath
ApplicationContext context = new FileSystemXmlApplicationContext(“C:/bean.xml, classPath: bean.xml”); - ClassPathXmlApplicationContext是在所有的类路径(包含JAR文件) 下查找xml文件(classPath*)
ApplicationContext context = new ClassPathXmlApplicationContext(“bean.xml”);
¶XmlBeanFactory
低配BeanFactory的整个流程
先看下XmlBeanFactory的源码:
1 | public class XmlBeanFactory extends DefaultListableBeanFactory{ |
还原一下调用过程
1 | //根据 Xml 配置文件创建 Resource 资源对象,该对象中包含了 BeanDefinition 的信息 |
然后我们看下loadBeanDefinitions方法
其实就是对xml文件的解析,并把解析出来的bean 定义配置回传给factory,让其进行new对象
¶FileSystemXmlApplicationContext
最主要的构造方法,其余构造方法都是调用这个
1 | /** |
实际调用
1 | public FileSystemXmlApplicationContext(String[] configLocations, boolean refresh, |
因为spring的context是可以自定义的,所以如果不设置,则使用默认的资源加载器,如果配置则使用用户自定义的ApplicationContext
设置资源加载器和资源定位
通过分析 FileSystemXmlApplicationContext 的源代码可以知道,在创建
FileSystemXmlApplicationContext 容器时,构造方法做以下两项重要工作:
1.调用父类容器的构造方法(super(parent)方法)为容器设置好 Bean 资源加载器。
2.再调用父类 AbstractRefreshableConfigApplicationContext 的
setConfigLocations(configLocations)方法设置 Bean 定义资源文件的定位路径。
通过追踪 FileSystemXmlApplicationContext 的继承体系,发现其父类的父类
AbstractApplicationContext 中初始化 IOC 容器所做的主要源码如下:
1 | public abstract class AbstractApplicationContext extends DefaultResourceLoader implements ConfigurableApplicationContext, DisposableBean { |
AbstractApplicationContext构造方法中调用PathMatchingResourcePatternResolver的构造方法创建
Spring 资源加载器:
1 | public PathMatchingResourcePatternResolver(ResourceLoader resourceLoader) { |
在设置容器的资源加载器之后,接下来 FileSystemXmlApplicationContet 执行 setConfigLocations 方
法通过调用其父类 AbstractRefreshableConfigApplicationContext 的方法进行对 Bean 定义资源文件
的定位,该方法的源码如下:
1 | //处理单个资源文件路径为一个字符串的情况 |
通过这两个方法的源码我们可以看出,我们既可以使用一个字符串来配置多个 Spring Bean 定义资源
文件,也可以使用字符串数组,即下面两种方式都是可以的:
1.ClasspathResource res = new ClasspathResource(“a.xml,b.xml,……”);
多个资源文件路径之间可以是用” ,; /t/n”等分隔。
2.ClasspathResource res = new ClasspathResource(newString[]{“a.xml”,”b.xml”,……});
Spring IOC 容器在初始化时将配置的 Bean 定义资源文件定位为 Spring 封装的 Resource。
3.AbstractApplicationContext 的 refresh 函数载入 Bean 定义过程:
Spring IOC 容器对 Bean 定义资源的载入是从 refresh()函数开始的,refresh()是一个模板方法,
refresh()方法的作用是:在创建 IOC 容器前,如果已经有容器存在,则需要把已有的容器销毁和关闭,
以保证在 refresh 之后使用的是新建立起来的 IOC 容器。refresh 的作用类似于对 IOC 容器的重启,在
新建立好的容器中对容器进行初始化,对 Bean 定义资源进行载入
¶refresh()
1 | public FileSystemXmlApplicationContext(String[] configLocations, boolean refresh, |
FileSystemXmlApplicationContext 通过调用其父类 AbstractApplicationContext 的 refresh()函数启
动整个 IoC 容器对 Bean 定义的载入过程:
1 | public void refresh() throws BeansException, IllegalStateException { |
refresh()方法主要为 IOC 容器 Bean 的生命周期管理提供条件,Spring IOC 容器载入 Bean 定义资源文
件从其子类容器的 refreshBeanFactory()方法启动,所以整个 refresh()中
“ConfigurableListableBeanFactory beanFactory =obtainFreshBeanFactory();”这句以后代码的
都是注册容器的信息源和生命周期事件,载入过程就是从这句代码启动。
refresh()方法的作用是:在创建 IOC 容器前,如果已经有容器存在,则需要把已有的容器销毁和关
闭,以保证在 refresh 之后使用的是新建立起来的 IOC 容器。refresh 的作用类似于对 IOC 容器的重启,
在新建立好的容器中对容器进行初始化,对 Bean 定义资源进行载入
AbstractApplicationContext的obtainFreshBeanFactory()方法调用子类容器的refreshBeanFactory()
方法,启动容器载入 Bean 定义资源文件的过程,代码如下:
1 | protected ConfigurableListableBeanFactory obtainFreshBeanFactory() { |
AbstractApplicationContext 子类的 refreshBeanFactory()方法:
AbstractApplicationContext 类中只抽象定义了 refreshBeanFactory()方法,容器真正调用的是
其子类AbstractRefreshableApplicationContext实现的refreshBeanFactory()方法,方法的源码如下:
1 | protected final void refreshBeanFactory() throws BeansException { |
在这个方法中,先判断 BeanFactory 是否存在,如果存在则先销毁 beans 并关闭 beanFactory,接着创
建 DefaultListableBeanFactory,并调用 loadBeanDefinitions(beanFactory)装载 bean 定义。
AbstractRefreshableApplicationContext 子类的 loadBeanDefinitions 方法:
AbstractRefreshableApplicationContext 中只定义了抽象的 loadBeanDefinitions 方法,容器真正调
用的是其子类 AbstractXmlApplicationContext 对该方法的实现,AbstractXmlApplicationContext 的
主要源码如下:
loadBeanDefinitions 方法同样是抽象方法,是由其子类实现的,也即在
AbstractXmlApplicationContext 中。
1 | public abstract class AbstractXmlApplicationContext extends AbstractRefreshableConfigApplicationContext { |
Xml Bean 读取器(XmlBeanDefinitionReader)调用其父类 AbstractBeanDefinitionReader
的 reader.loadBeanDefinitions 方法读取 Bean 定义资源。
由于我们使用 FileSystemXmlApplicationContext 作为例子分析,因此 getConfigResources 的返回值
为 null,因此程序执行 reader.loadBeanDefinitions(configLocations)分支。
AbstractBeanDefinitionReader 读取 Bean 定义资源:
AbstractBeanDefinitionReader 的 loadBeanDefinitions 方法源码如下
可以到 org.springframework.beans.factory.support 看一下 BeanDefinitionReader 的结构
在其抽象父类 AbstractBeanDefinitionReader 中定义了载入过程
1 | //重载方法,调用下面的 loadBeanDefinitions(String, Set<Resource>);方法 |
loadBeanDefinitions(Resource…resources)方法和上面分析的 3 个方法类似,同样也是调用
XmlBeanDefinitionReader 的 loadBeanDefinitions 方法。
从对 AbstractBeanDefinitionReader 的 loadBeanDefinitions 方法源码分析可以看出该方法做了以下
两件事:
- 调用资源加载器的获取资源方法 resourceLoader.getResource(location),获取到要加载的资源。
- 真正执行加载功能是其子类 XmlBeanDefinitionReader 的 loadBeanDefinitions 方法。
看到第 8、16 行,结合上面的 ResourceLoader 与 ApplicationContext 的继承系图,可以知道此时调用
的是 DefaultResourceLoader 中的 getSource()方法定位 Resource,因为
FileSystemXmlApplicationContext 本身就是 DefaultResourceLoader 的实现类,所以此时又回到了
FileSystemXmlApplicationContext 中来。
资源加载器获取要读入的资源:
XmlBeanDefinitionReader 通过调用其父类 DefaultResourceLoader 的 getResource 方法获取要加载的
资源,其源码如下
1 | //获取 Resource 的具体实现方法 |
FileSystemXmlApplicationContext 容器提供了 getResourceByPath 方法的实现,就是为了处理既不是
classpath 标识,又不是 URL 标识的 Resource 定位这种情况。
1 | protected Resource getResourceByPath(String path) { |
这样代码就回到了 FileSystemXmlApplicationContext 中来,他提供了 FileSystemResource 来完
成从文件系统得到配置文件的资源定义。
这样,就可以从文件系统路径上对 IOC 配置文件进行加载 - 当然我们可以按照这个逻辑从任何地方
加载,在 Spring 中我们看到它提供 的各种资源抽象,比如
ClassPathResource, URLResource,FileSystemResource 等来供我们使用。上面我们看到的是定位
Resource 的一个过程,而这只是加载过程的一部分.
¶XmlBeanDefinitionReader 加载 Bean 定义资源
Bean 定义的 Resource 得到了
继续回到 XmlBeanDefinitionReader 的 loadBeanDefinitions(Resource …)方法看到代表 bean 文
件的资源定义以后的载入过程。
1 | //XmlBeanDefinitionReader 加载资源的入口方法 |
通过源码分析,载入 Bean 定义资源文件的最后一步是将 Bean 定义资源转换为 Document 对象,该过程
由 documentLoader 实现
DocumentLoader 将 Bean 定义资源转换为 Document 对象:
DocumentLoader 将 Bean 定义资源转换成 Document 对象的源码如下:
1 | //使用标准的 JAXP 将载入的 Bean 定义资源转换成 document 对象 |
该解析过程调用 JavaEE 标准的 JAXP 标准进行处理。
至此 Spring IOC 容器根据定位的 Bean 定义资源文件,将其加载读入并转换成为 Document 对象过程完成。
接下来我们要继续分析 Spring IOC 容器将载入的 Bean 定义资源文件转换为 Document 对象之后,是如
何将其解析为 Spring IOC 管理的 Bean 对象并将其注册到容器中的。
¶XmlBeanDefinitionReader 解析载入的 Bean 定义资源文件
XmlBeanDefinitionReader类中的doLoadBeanDefinitions方法是从特定XML 文件中实际载入Bean 定
义资源的方法,该方法在载入 Bean 定义资源之后将其转换为 Document 对象,接下来调用
registerBeanDefinitions 启动 Spring IOC 容器对 Bean 定义的解析过程,registerBeanDefinitions
方法源码如下:
1 | //按照 Spring 的 Bean 语义要求将 Bean 定义资源解析并转换为容器内部数据结构 |
Bean 定义资源的载入解析分为以下两个过程:
- 首先,通过调用 XML 解析器将 Bean 定义资源文件转换得到 Document 对象,但是这些 Document 对象并没有按照 Spring 的 Bean 规则进行解析。这一步是载入的过程
- 在完成通用的 XML 解析之后,按照 Spring 的 Bean 规则对 Document 对象进行解析。
按照 Spring 的 Bean 规则对 Document 对象解析的过程是在接口 BeanDefinitionDocumentReader 的实现
类 DefaultBeanDefinitionDocumentReader 中实现的。
¶DefaultBeanDefinitionDocumentReader 对 Bean 定义的 Document 对象解析
BeanDefinitionDocumentReader 接口通过 registerBeanDefinitions 方法调用其实现类
DefaultBeanDefinitionDocumentReader 对 Document 对象进行解析,解析的代码如下:
1 | //根据 Spring DTD 对 Bean 的定义规则解析 Bean 定义 Document 对象 |
通过上述 Spring IOC 容器对载入的 Bean 定义 Document 解析可以看出,我们使用 Spring 时,在 Spring
配置文件中可以使用<Import>
元素来导入 IOC 容器所需要的其他资源,Spring IoC 容器在解析时会首
先将指定导入的资源加载进容器中。使用<Ailas>
别名时,Spring IOC 容器首先将别名元素所定义的别
名注册到容器中。
对于既不是<Import>
元素,又不是<Alias>
元素的元素,即 Spring 配置文件中普通的<Bean>
元素的解析
由 BeanDefinitionParserDelegate 类的 parseBeanDefinitionElement 方法来实现。
¶BeanDefinitionParserDelegate 解析 Bean 定义资源文件中的<Bean>
元素
Bean 定义资源文件中的<Import>
和<Alias>
元素解析在 DefaultBeanDefinitionDocumentReader 中已经
完成,对 Bean 定义资源文件中使用最多的<Bean>
元素交由 BeanDefinitionParserDelegate 来解析,其解析实现的源码如下:
1 | //解析<Bean>元素的入口 |
只要使用过 Spring,对 Spring 配置文件比较熟悉的人,通过对上述源码的分析,就会明白我们在 Spring
配置文件中<Bean>
元素的中配置的属性就是通过该方法解析和设置到 Bean 中去的。
注意:在解析<Bean>
元素过程中没有创建和实例化 Bean 对象,只是创建了 Bean 对象的定义类BeanDefinition,将<Bean>
元素中的配置信息设置到 BeanDefinition 中作为记录,当依赖注入时才使用这些记录信息创建和实例化具体的 Bean 对象。
上面方法中一些对一些配置如元信息(meta)、qualifier 等的解析,我们在 Spring 中配置时使用的也不多,我们在使用 Spring 的<Bean>
元素时,配置最多的是<property>
属性,因此我们下面继续分析源码,了解 Bean 的属性在解析时是如何设置的。
¶BeanDefinitionParserDelegate 解析<property>
元素
BeanDefinitionParserDelegate 在解析<Bean>
调用 parsePropertyElements 方法解析<Bean>
元素中的<property>
属性子元素,解析源码如下:
1 | //解析<Bean>元素中的<property>子元素 |
通过对上述源码的分析,我们可以了解在 Spring 配置文件中,<Bean>
元素中<property>
元素的相关配
置是如何处理的:
- ref 被封装为指向依赖对象一个引用
- value 配置都会封装成一个字符串类型的对象
- ref 和 value 都通过“解析的数据类型属性值.setSource(extractSource(ele));”方法将属性值/引用与所引用的属性关联起来
在方法的最后对于<property>
元素的子元素通过 parsePropertySubElement 方法解析,我们继续分析
该方法的源码,了解其解析过程。
¶解析<property>
元素的子元素
在 BeanDefinitionParserDelegate 类中的 parsePropertySubElement 方法对<property>
中的子元素解析,源码如下:
1 | //解析<property>元素中 ref,value 或者集合等子元素 |
通过上述源码分析,我们明白了在 Spring 配置文件中,对<property>
元素中配置的 Array、List、Set、
Map、Prop 等各种集合子元素的都通过上述方法解析,生成对应的数据对象,比如 ManagedList、
ManagedArray、ManagedSet 等,这些 Managed 类是 Spring 对象 BeanDefiniton 的数据封装,对集合数据类型的具体解析有各自的解析方法实现,解析方法的命名非常规范,一目了然,我们对集合元素的解析方法进行源码分析,了解其实现过程。
¶解析<list>
子元素
在 BeanDefinitionParserDelegate 类中的 parseListElement 方法就是具体实现解析<property>
元素中的<list>
集合子元素,源码如下:
1 | //解析<list>集合子元素 |
经过对 Spring Bean 定义资源文件转换的 Document 对象中的元素层层解析,Spring IOC 现在已经将
XML 形式定义的 Bean 定义资源文件转换为 Spring IOC 所识别的数据结构——BeanDefinition,它是
Bean 定义资源文件中配置的 POJO 对象在 Spring IOC 容器中的映射,我们可以通过
AbstractBeanDefinition 为入口,看到了 IOC 容器进行索引、查询和操作。
通过 Spring IOC 容器对 Bean 定义资源的解析后,IOC 容器大致完成了管理 Bean 对象的准备工作,即
初始化过程,但是最为重要的依赖注入还没有发生,现在在 IOC 容器中 BeanDefinition 存储的只是一
些静态信息,接下来需要向容器注册 Bean 定义信息才能全部完成 IoC 容器的初始化过程
¶解析过后的 BeanDefinition 在 IOC 容器中的注册
让我们继续跟踪程序的执行顺序,接下来会到我们第3步中分析DefaultBeanDefinitionDocumentReader
对 Bean 定义转换的 Document 对象解析的流程中,在其 parseDefaultElement 方法中完成对 Document
对象的解析后得到封装 BeanDefinition 的 BeanDefinitionHold 对象,然后调用
BeanDefinitionReaderUtils 的 registerBeanDefinition 方法向 IOC 容器注册解析的 Bean,BeanDefinitionReaderUtils 的注册的源码如下:
1 | //将解析的 BeanDefinitionHold 注册到容器中 |
当调用 BeanDefinitionReaderUtils 向 IOC 容器注册解析的 BeanDefinition 时,真正完成注册功能的
是 DefaultListableBeanFactory。
¶DefaultListableBeanFactory 向 IOC 容器注册解析后的 BeanDefinition
DefaultListableBeanFactory 向 IOC 容器注册解析后的 BeanDefinition:
1 | //存储注册信息的 BeanDefinition |
至此,Bean 定义资源文件中配置的 Bean 被解析过后,已经注册到 IOC 容器中,被容器管理起来,真正
完成了 IOC 容器初始化所做的全部工作。现在 IOC 容器中已经建立了整个 Bean 的配置信息,这些
BeanDefinition 信息已经可以使用,并且可以被检索,IOC 容器的作用就是对这些注册的 Bean 定义信
息进行处理和维护。这些的注册的 Bean 定义信息是 IoC 容器控制反转的基础,正是有了这些注册的数
据,容器才可以进行依赖注入。
总结
现在通过上面的代码,总结一下 IOC 容器初始化的基本步骤:
- 初始化的入口在容器实现中的 refresh()调用来完成
- 对 bean 定义载入 IOC 容器使用的方法是 loadBeanDefinition,
其中的大致过程如下:
通过 ResourceLoader 来完成资源文件位置的定位,DefaultResourceLoader 是默
认的实现,同时上下文本身就给出了 ResourceLoader 的实现,可以从类路径,文件系统,URL 等方式来
定为资源位置。如果是 XmlBeanFactory 作为 IOC 容器,那么需要为它指定 bean 定义的资源,也就是说
bean 定义文件时通过抽象成 Resource 来被 IOC 容器处理的,容器通过 BeanDefinitionReader 来完成
定义信息的解析和 Bean 信息的注册,往往使用的是 XmlBeanDefinitionReader 来解析 bean 的 xml 定义
文件-实际的处理过程是委托给 BeanDefinitionParserDelegate来完成的,从而得到bean的定义信息,
这些信息在 Spring 中使用 BeanDefinition 对象来表示-这个名字可以让我们想到
loadBeanDefinition,RegisterBeanDefinition 这些相关方法-他们都是为处理BeanDefinitin 服务的,
容器解析得到 BeanDefinitionIoC 以后,需要把它在 IOC 容器中注册,这由 IOC 实
现 BeanDefinitionRegistry 接口来实现。注册过程就是在 IOC 容器内部维护的一个 HashMap 来保存得
到的 BeanDefinition 的过程。这个 HashMap 是 IOC 容器持有 bean 信息的场所,以后对 bean 的操作都
是围绕这个 HashMap 来实现的.
然后我们就可以通过 BeanFactory 和 ApplicationContext 来享受到 SpringIOC 的服务了,在使用 IOC
容器的时候,我们注意到除了少量粘合代码,绝大多数以正确 IOC 风格编写的应用程序代码完全不用关
心如何到达工厂,因为容器将把这些对象与容器管理的其他对象钩在一起。基本的策略是把工厂放到已
知的地方,最好是放在对预期使用的上下文有意义的地方,以及代码将实际需要访问工厂的地方。Spring
本身提供了对声明式载入 web 应用程序用法的应用程序上下文,并将其存储在 ServletContext 中的框架
实现。
在使用 SpringIOC 容器的时候我们还需要区别两个概念
¶BeanFactory 和 FactoryBean
- BeanFactory 功能性工厂,专门用来生产bean的,如果是生产车的就叫做CarFactory,是 IOC 容器的编程抽象,比如ApplicationContext,XmlBeanFactory 等,这些都是 IOC 容器的具体表现,需要使用什么样的容器由客户决定,但 Spring 为我们提供了丰富的选择。
- FactoryBean 是由spring工厂生产出来的bean, 只是一个可以在 IOC 而容器中被管理的一个bean,是对各种处理过程和资源使用的抽象,FactoryBean 在需要时产生另一个对象,而不返回FactoryBean 本身,我们可以把它看成是一个抽象工厂,对它的调用返回的是工厂生产的产品。所有的FactoryBean 都实现特殊的 org.springframework.beans.factory.FactoryBean 接口,当使用容器中FactoryBean 的时候,该容器不会返回 FactoryBean 本身,而是返回其生成的对象。Spring 包括了大部分的通用资源和服务访问抽象的 FactoryBean 的实现,其中包括:对 JNDI 查询的处理,对代理对象的处理,对事务性代理的处理,对 RMI 代理的处理等,这些我们都可以看成是具体的工厂,看成是 Spring 为我们建立好的工厂。也就是说 Spring 通过使用抽象工厂模式为我们准备了一系列工厂来生产一些特定的对象,免除我们手工重复的工作,我们要使用时只需要在 IOC 容器里配置好就能很方便的使用了
¶springboot
SpringApplication
AnnotationConfigServletWebServerApplicationContext
ServletWebServerApplicationContext
AbstractApplicationContext 在这个类中定义了扫描注解的执行器
ClassPathBeanDefinitionScanner
ClassPathScanningCandidateComponentProvider
AbstractTypeHierarchyTraversingFilter
AnnotationTypeFilter