ContextLoaderListener vs DispatcherServlet

在基于XML的Spring MVC配置中，在web.xml中你需要有ContextLoaderListener和DispatcherServlet的声明。下面让我们来理解一下它们在框架中的作用和不同。

根上下文和子上下文

首先，我们需要知道下面这两个知识：

• Spring在同一时刻可以有多个上下文（contexts）。其中一个是根上下文（Root Context），其它的是子上下文（Child Context）。
• 所有的子上下文可以访问根上下文中定义的bean，但是反过来则不行，即根上下文是不能访问子上下文中的bean的。

DispatcherServlet-Child application context

DispatcherServlet其实就是一个继承了HttpServlet的Servlet，它的主要作用根据请求的url来匹配到符合条件的Controller来处理web请求。所以说它是前端控制器（Front Controller），Spring MVC的Controller是后端控制器。

当使用XML来配置DispatcherServlet时，通常会有如下的web.xml配置：

<web-app>

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

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/applicationContext.xml</param-value>
    </context-param>

    <servlet>
        <servlet-name>app</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
          <!--这儿没有配置value，会默认从 servlet名称-servlet.xml 的文件中获取配置，这儿的servlet名称是app，即从app-servlet.xml文件中获取配置，也可以自己提供一个配置文件路径，如 classpath:my-servlet.xml -->
            <param-value></param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>app</servlet-name>
        <url-pattern>/app/*</url-pattern>
    </servlet-mapping>

</web-app>

值得一提的是，web应用可以定义任意数量的DispatcherServlet，每个DispatcherServlet控制属于自己namespace下面的mapping，handler等。这些DispatcherServlet会创建属于自己的web application context，它们创建的web application context都是子上下文。

ContextLoaderListener-Root application context

ContextLoaderListener创建一个根上下文，这个根上下文会被DispatcherServlet创建的子上下文共享。前面的web.xml中的属于ContextLoaderListener的部分的配置如下：

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

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/applicationContext.xml</param-value>
    </context-param>

ContextLoaderListener创建的上下文中包含的bean是全局可见的，比如services，repositories，框架相关的beans等等，等根上下文创建完成的时候，会被保存到ServletContext中，作为一个字段，代码参见ContextLoader#initWebApplicationContext方法中

servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
//WebApplicationContext接口中定义了
//String ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE = WebApplicationContext.class.getName() + ".ROOT";

如果想获取根上下文，可以通过org.springframework.web.context.support.WebApplicationContextUtils提供的方法，如某个Controller的代码：

@Autowired
ServletContext context; 
 
ApplicationContext ac = WebApplicationContextUtils.getWebApplicationContext(context);

ContextLoaderListener 和 DispatcherServlet

下图描述了ContextLoaderListener和DispatcherServlet的关系。

1. ContextLoaderListener创建了根上下文。
2. DispatcherServlet创建了子上下文。
3. 子上下文可以访问根上下文中的bean。
4. 根上下文中的bean无法直接访问子上下文中的bean。
5. 所有的上下文都被添加到ServletContext中。
6. 可以通过WebApplicationContextUtils访问根上下文。

总结

通常，在DispatcherServlet的上下文中定义MVC相关的bean（Controller、View等），所有的横切bean，如安全security、事务transaction、服务service等都定义在ContextLoaderListener创建的根上下文中。

之所以会有这种设计，是因为很少会有在安全、事务相关的bean中访问MVC相关的bean的场景，即很少会有从根上下文的bean中访问子上下文中的bean的场景，但是反过来是很常见的。

参考文章：

1.https://howtodoinjava.com/spring-mvc/contextloaderlistener-vs-dispatcherservlet

2.https://docs.spring.io/spring-framework/docs/current/reference/html/web.html