ServletContext

Web容器在启动的过程中,会为每个Web应用程序创建一个对应的ServletContext对象,它代表了当前的Web应用,为Spring IoC容器提供宿主环境。

在部署Web工程的时候,Web容器会读取web.xml,创建ServletContext,当前Web工程所有部分都共享这个Contextcontext-paramServletContext提供键值对,即Servlet上下文的信息,这些信息ListenerFilterServlet都有可能使用到,因此先加载context-param,创建ServletContext,然后加载Listener,再加载Filter,最后加载Servlet

接下来我将按照这个加载顺序来分析Spring容器的启动过程。

ContextLoaderListener

web.xml中配置有ContextLoaderListener,也可以自定义一个实现了ServletContextListener接口的Listener类,web.xml中的配置实例如下。

<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

Web容器在启动的过程中会触发ServletContextEvent事件,会被ContextLoaderListener监听到,并调用ContextLoaderListener中的contextInitialized方法,contextInitialized方法如下所示。

public void contextInitialized(ServletContextEvent event) {
        this.initWebApplicationContext(event.getServletContext());
}

ContextLoaderListener类继承了ContextLoader,在初始化Context的过程中,调用ContextLoaderinitWebApplicationContext方法初始化WebApplicationContextWebApplicationContext是一个接口,Spring默认的实现类为XmlWebApplicationContextXmlWebApplicationContext就是SpringIoC容器。

在初始化XmlWebApplicationContext之前,Web容器已经加载了context-paramweb.xml中的context-param实例如下所示。作为SpringIoC容器,其对应的Bean定义的配置正是context-param指定的。

<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:applicationContext.xml</param-value>
</context-param>

接着进入到initWebApplicationContext方法内,initWebApplicationContext方法定义如下(已省略部分代码)。

public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {      
    if(servletContext.getAttribute(
        WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE) != null) {
            throw new IllegalStateException("...");
    }else{
        if(this.context == null) {
            this.context = this.createWebApplicationContext(servletContext);
        }
    }
    servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
}

Spring IoC容器初始化前,initWebApplicationContext先检测以ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTEkey的值是否为空,若不为空,则初始化IoC Context,并在初始化完毕后,以ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTEkeyIoC Context存储到ServletContext中。

初始化Servlet

Servlet可以在web.xml中配置多个,在Spring中,最基本的ServletDispatcherServlet,对应的配置实例如下所示。

<servlet>
    <servlet-name>appServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/spring/appServlet/appServlet-context.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>

DispatcherServlet会建立自己的IoC Context,用以持有相关的Bean,在初始化自己的IoC Context的过程中,先通过WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE,从ServletContext中获取WebApplicationContext,将WebApplicationContext作为DispatcherServlet的IoC Contextparent ContextDispatcherServlet自己的IoC Context的初始化工作在DispatcherServletinitStrategies方法中完成,包括控制器映射,视图解析等,initStrategies 方法如下所示。

protected void initStrategies(ApplicationContext context) {
    this.initMultipartResolver(context);
    this.initLocaleResolver(context);
    this.initThemeResolver(context);
    this.initHandlerMappings(context);
    this.initHandlerAdapters(context);
    this.initHandlerExceptionResolvers(context);
    this.initRequestToViewNameTranslator(context);
    this.initViewResolvers(context);
    this.initFlashMapManager(context);
}

DispatcherServlet自己的IoC Context的类型也是XmlWebApplicationContext,初始化完毕后,Spring将以与DispatcherServletservlet-name属性相关的符号作为key,将IoC Context保存到 ServletContext中。这样每个Servlet就都可以持有自己的Context,也就是都拥有自己的Bean空间,同时,各个Servlet之间还共享着keyWebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTEWebApplicationContext,其中定义的Bean为各个Servlet共享的Bean

参考