Spring源码探究:IoC容器在Web容器中的创建及初始化

关于IoC容器和控制反转(也被称为依赖注入)模式以及Spring IoC的应用场景我在这里就不进行赘述了,下面直接深入到Spring的源码当中来探究一下IoC容器究竟是如何工作的。

在文章开头,我们要明确两个概念:

  • IoC容器的创建就是我们创建一个容器,使其拥有IoC容器的基本结构;(下文中提到的的createWebApplicationContext完成的是IoC容器的创建工作)
  • 在完成IoC容器创建的前提下进行bean的注册以及依赖注入之后才算完成了IoC容器的初始化(下文中提到的ConfigureAndRefreshWebApplicationContext进行的是IoC容器的初始化工作但是关于容器初始化的细节我将放到后面的博客进行介绍)。

在Spring IoC容器系列的设计中,我们可以看到两个两个主要的容器系列:一个是实现BeanFactory接口的简单容器系列,这个系列容器只实现了容器的最基本功能;另一个是ApplicationContext应用上下文,它作为容器的高级形态而存在。应用上下文在简单容器的基础上,增加了许多面向框架的特性,同时对应用环境作了许多适配。有了这两种基本的容器系列,基本上可以满足用户对IoC容器使用的大部分需求了。下面我们主要来看看IoC容器在Web容器中是如何进行初始化的。

既然我们要探究IoC容器初始化的过程,那就要问一个问题:
IoC容器什么时候会进行初始化的行为呢?

我们先来看一个非常基础的场景:

web.xml配置文件中的一部分

上面是web.xml配置文件中的一部分

  • contextConfigLocation对应的value是Spring配置文件的绝对路径;
  • 下面这个监听器主要用来对Servlet容器(在这里指的是Tomcat)的行为进行监听

我们先来看看监听器类ContextLoaderListener中有什么东西:

ContextLoaderListener源码

我们可以发现ContextLoaderListener继承自ContextLoader,并且还实现了ServletContextListener。并且它的构造函数中传入了一个WebApplicationContext,它是继承自ApplicationContext接口的高级IoC容器。

ServletContextListener源码

ServletContextListener是Servlet中比较重要的一个接口:它的作用是用来监听Servlet容器的启动和销毁事件。所以在ContextLoaderListener中:

  • contextInitialized方法的入参或是监听的Event是ServletContextEvent事件,也就是Tomcat启动加载完web.xml会产生的事件,ServletContextEvent持有了从web.xml加载的初始化配置的ServletContext上下文。
  • ContextDestroyed方法的入参或是监听的Event是ServletContextEvent事件,在Tomcat关闭的时候执行该方法。

所以我们现在可以先捋一下流程:当Servlet容器启动事件发生时,将被ContextLoaderListen监听器监听到。此时ContextLoaderListener会调用实现ServletContextListener接口后实现的contextInitialized方法,并把在web.xml加载初始化后获取的ServletContext传入initWebApplicationContext函数中进行IoC容器的初始化。

因为initWebApplicationContext函数是从ContextLoader继承过来的,所以我们现在进入ContextLoader源码中看一看。

ContextLoader类中的静态代码块

映入眼帘的是个静态代码块:

  • 创建一个ClassPathResource对象,同时把值为"ContextLoader.properties"的一个常量作为参数传入。易知ContextLoader.properties文件与ContextLoader类是在同一个目录下的;ContextLoader.properties文件内容如下:
org.springframework.web.context.WebApplicationContext=
org.springframework.web.context.support.XmlWebApplicationContext

因此我们可以得知Spring默认初始化的是XmlWebApplicationContext容器

  • 得到一个Properties对象,后面讲根据类名来创建对应的ApplicationContext容器

下面来看看initiWebApplicationContext方法


initWebApplicationContext方法源码

我们现在可以接着刚才的流程继续讲下去:当调用ContextLoaderListener中的initWebApplicationContext的函数并且将获取到的servletContext作为参数传入之后,initWebApplicationContext首先会尝试从servletContext中获取根容器,如果容器不为空,则容器初始化失败---因为web.xml中可能定义了多个IoC容器的加载器。假如此时容器还未初始化,则调用createWebApplicationContext方法来创建一个容器。创建完容器之后,将会调用一个非常重要的configureAndRefreshWebApplicationContext方法。在执行这个方法的时候,会将从ApplicationContext.xml配置文件中获取到的内容配置到已经创建好了的XmlWebApplicationContext容器中去,并调用refresh方法来完成容器的初始化。然后,再将已经完成初始化的XmlWebApplicationContext容器注册到servletContext中去。

其实在Web容器中,ServletContext为Spring的IoC容器提供了宿主环境,对应的建立起一个IoC容器的体系。其中,首先需要建立的是根上下文,这个上下文持有的对象可以有业务对象、数据存取对象、资源、事务管理器等各种中间层对象。在这个上下文的基础上,与Web MVC相关还会有一个上下文来保持控制器之类的MVC对象,这样就构成了一个层次化的上下文结构。因为在initWebApplicationContext方法中我们可以看到其实创建ApplicationContext容器的工作是交由createWebApplicationContext方法来实现的,下面我们来看看这个方法:

createWebApplicationContext函数源码

createWebApplicationContext函数功能:

  • 决定要创建的ApplicationContext类型;
  • 实例化一个ApplicationContext

那么它是如何决定要创建的ApplicationContext类型的呢?
起作用的其实是方法中第一行的determineContextClass方法

determineContextClass方法源码

完成了IoC容器的创建之后,在initWebApplicationContext中讲调用configureAndRefreshWebApplicationContext来对该IoC进行初始化:

  • 为创建好的IoC容器设置Web应用的上下文,以便二者整合;
  • 为同一个IoC容器设置配置文件的绝对路径;
  • 调用IoC容器的refresh函数对其进行初始化
configureAndRefreshWebApplicationContext函数

由于IoC容器的初始化涉及到比较多的步骤:包括BeanDefinition的Resource定位等等,所以我将在后面另开博客进行介绍。

推荐阅读更多精彩内容