ContextLoaderListener与DispatcherServlet

快来打我* 2022-04-25 10:42 193阅读 0赞

在基于XML的Spring MVC配置中，您必须在`web.xml`文件中看到两个声明，即`ContextLoaderListener`和`DispatcherServlet`。让我们试着理解他们在框架中的目的和他们的差异。

## 根和子上下文 ##

在进一步阅读之前，请理解 -

*  Spring一次可以有多个上下文。其中一个将是根上下文，所有其他上下文将是子上下文。
 *  所有子上下文都可以访问根上下文中定义的bean; 但事实恰恰相反。根上下文无法访问子上下文bean。

## DispatcherServlet - 子应用程序上下文 ##

`DispatcherServlet`本质上是一个Servlet（它扩展`HttpServlet`），其主要目的是处理与配置的URL模式匹配的传入Web请求。它接受传入的URI并找到控制器和视图的正确组合。所以它是前端控制器。

定义`DispatcherServlet`in spring配置时，使用`contextConfigLocation`属性提供包含控制器类，视图映射等条目的XML文件。

<table> 
 web.xml中 
 <tbody> 
 <tr> 
 <td style="text-align:left;vertical-align:baseline;"> <code>&lt;</code><code>servlet</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>servlet-name</code><code>&gt;employee-services&lt;/</code><code>servlet-name</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>servlet-class</code><code>&gt;org.springframework.web.servlet.DispatcherServlet&lt;/</code><code>servlet-class</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>init-param</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>param-name</code><code>&gt;contextConfigLocation&lt;/</code><code>param-name</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>param-value</code><code>&gt;classpath:employee-services-servlet.xml&lt;/</code><code>param-value</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/</code><code>init-param</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>load-on-startup</code><code>&gt;1&lt;/</code><code>load-on-startup</code><code>&gt;</code> <code>&lt;/</code><code>servlet</code><code>&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

如果您不提供配置文件，那么它将使用加载自己的配置文件`[servlet_name]-servlet.xml`。Web应用程序可以定义任意数量的`DispatcherServlet`条目。每个servlet都在自己的命名空间中运行，使用映射，处理程序等加载自己的应用程序上下文。

这意味着每个人`DispatcherServlet`都可以访问Web应用程序上下文。**直到规定，每个`DispatcherServlet`创建自己的内部Web应用程序上下文**。

从Spring 3.x开始，方法使用给定的Web应用程序上下文`DispatcherServlet(WebApplicationContext webApplicationContext)`创建一个新`DispatcherServlet`的。只有在Servlet 3.x环境中才有可能通过`ServletContext.addServlet(java.lang.String, java.lang.String)`API支持。

## ContextLoaderListener - 根应用程序上下文 ##

**`ContextLoaderListener`创建根应用程序上下文，并与所有`DispatcherServlet`上下文创建的子上下文共享。**你只能有一个条目`web.xml`。

<table> 
 web.xml中 
 <tbody> 
 <tr> 
 <td style="text-align:left;vertical-align:baseline;"> <code>&lt;</code><code>listener</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>listener-class</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>org.springframework.web.context.ContextLoaderListener</code> <code>&nbsp;&nbsp;</code><code>&lt;/</code><code>listener-class</code><code>&gt;</code> <code>&lt;/</code><code>listener</code><code>&gt;</code> <code>&nbsp;</code>&nbsp; <code>&lt;</code><code>context-param</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>param-name</code><code>&gt;contextConfigLocation&lt;/</code><code>param-name</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>param-value</code><code>&gt;/WEB-INF/spring/applicationContext.xml&lt;/</code><code>param-value</code><code>&gt;</code> <code>&lt;/</code><code>context-param</code><code>&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

`ContextLoaderListener`包含全局可见的bean 的上下文，如服务，存储库，基础结构bean等。创建根应用程序上下文后，它将`ServletContext`作为属性存储，名称为：

<table> 
 组织/ springframework的/ WEB /上下文/ ContextLoader.java 
 <tbody> 
 <tr> 
 <td style="text-align:left;vertical-align:baseline;"> <code>servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE,&nbsp;</code><code>this</code><code>.context);</code> &nbsp; <code>//Where attibute is defined in /org/springframework/web/context/WebApplicationContext.java as</code> &nbsp; <code>WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE = WebApplicationContext.</code><code>class</code><code>.getName() +&nbsp;</code><code>".ROOT"</code><code>;</code> </td> 
 </tr> 
 </tbody> 
</table>

要**在Spring控制器中获取根应用程序上下文**，可以使用`WebApplicationContextUtils`类。

<table> 
 Controller.java 
 <tbody> 
 <tr> 
 <td style="text-align:left;vertical-align:baseline;"> <code>@Autowired</code> <code>ServletContext context;</code> &nbsp; <code>ApplicationContext ac = WebApplicationContextUtils.getWebApplicationContext(context);</code> &nbsp; <code>if</code><code>(ac ==&nbsp;</code><code>null</code><code>){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>"root application context is null"</code><code>;</code> <code>}&nbsp;&nbsp;&nbsp;&nbsp;</code> </td> 
 </tr> 
 </tbody> 
</table>

## ContextLoaderListener与DispatcherServlet ##

下图描述了单一视图中的整个关系。

![ContextLoaderListener与DispatcherServlet][ContextLoaderListener_DispatcherServlet]

ContextLoaderListener与DispatcherServlet

1.  `ContextLoaderListener` 创建根应用程序上下文
2.  `DispatcherServlet` 条目为每个servlet条目创建一个子应用程序上下文。
3.  子上下文可以访问根上下文中定义的bean。
4.  根上下文中的Bean无法直接访问子上下文中的bean。
5.  所有上下文都被添加到`ServletContext`。
6.  您可以使用`WebApplicationContextUtils`类访问根上下文。

## 摘要 ##

通常，您将在`DispatcherServlet`上下文中定义所有与MVC相关的bean（控制器和视图等），并在根上下文中定义所有交叉bean，例如安全性，事务，服务等`ContextLoaderListener`。

通常，此设置工作正常，因为您很少需要访问任何MVC bean（从子上下文）到安全相关的类（从根上下文）。大多数情况下，我们在MVC类上使用安全bean，他们可以通过上面的设置访问它。

原文地址：[https://howtodoinjava.com/spring-mvc/contextloaderlistener-vs-dispatcherservlet/][https_howtodoinjava.com_spring-mvc_contextloaderlistener-vs-dispatcherservlet]

[ContextLoaderListener_DispatcherServlet]: https://cdn1.howtodoinjava.com/wp-content/uploads/2018/05/ContextLoaderListener-vs-DispatcherServlet.png
[https_howtodoinjava.com_spring-mvc_contextloaderlistener-vs-dispatcherservlet]: https://howtodoinjava.com/spring-mvc/contextloaderlistener-vs-dispatcherservlet/