详述SpringMVC中ContextLoaderListener监听器

最新推荐文章于 2023-12-24 22:14:08 发布
最新推荐文章于 2023-12-24 22:14:08 发布
阅读量938 收藏
点赞数
分类专栏： SSM
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/DangerousMc/article/details/105556398
版权

Table of Contents

一、配置

二、原理

1.监听器中执行原理

2.DispatchServlet加载时执行原理

三、Root WebApplicationContext和Servlet WebApplicationContext

一、配置

org.springframework.web.servlet.DispatcherServlet的配置除了常规的配置方法以外，还可以使用ContextLoaderListener监听器进行配置，如下：

第11-14行：contextConfigLocation用于指定Spring的配置文件

第15-17行： 配置spring核心监听器，默认会以 /WEB-INF/applicationContext.xml作为配置文件

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://java.sun.com/xml/ns/javaee"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	id="WebApp_ID" version="2.5">
	<display-name>springsun</display-name>
	<welcome-file-list>
		<welcome-file>index.jsp</welcome-file>
	</welcome-file-list>

	<context-param> 
		<param-name>contextConfigLocation</param-name> 
		<param-value>classpath:app*.xml</param-value> 
	</context-param> 
	<listener> 
		<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> 
	</listener> 
	<servlet> 
		<servlet-name>DispatcherServlet</servlet-name> 
		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> 
		<init-param> 
			<param-name>contextAttribute</param-name> 
			<param-value>org.springframework.web.context.WebApplicationContext.ROOT</param-value> 
		</init-param> 
		<load-on-startup>1</load-on-startup> 
	</servlet> 
	<servlet-mapping> 
		<servlet-name>DispatcherServlet</servlet-name> 
		<url-pattern>*.do</url-pattern> 
	</servlet-mapping>
</web-app>

二、原理

1.监听器中执行原理

首先进入ContextLoaderListener类中，因为该类实现了javax.servlet.ServletContextListener接口，所以Tomcat发布Web应用时执行该类contextInitialized方法：

该方法中执行了initWebApplicationContext方法，参数为ServletContext类对象，即application对象

再进入initWebApplicationContext方法中，该方法是ContextLoaderListener继承自父类ContextLoader的方法：

第295行：判断ServletContext对象，即application对象是否已经存放了XmlWebApplicationContext实例，其中常量ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE为WebApplicationContext全类名与“.ROOT”拼接而成的字符串，即org.springframework.web.context.WebApplicationContext.ROOT；

第312行：createWebApplicationContext方法利用反射的方式创建XmlWebApplicationContext对象，并赋值给context变量；

第314行：由于XmlWebApplicationContext类间接实现了ConfigurableWebApplicationContext接口，所以该处if条件为true；

第315行：将context变量中XmlWebApplicationContext变量强制类型转换为ConfigurableWebApplicationContext类型；

第316行：由于cwac变量中对象尚未加载配置文件，所以进入代码块；

第325行：加载配置文件；

第328行：将context变量中的XmlWebApplicationContext对象保存至application内置对象中，保存的变量名即为org.springframework.web.context.WebApplicationContext.ROOT；

第347行：返回XmlWebApplicationContext示例对象；

接下来再来分析上面第325行中的configureAndRefreshWebApplicationContext方法的源代码：

第428行：为wac绑定ServletContext对象

第429行：此处常量CONFIG_LOCATION_PARAM为字符串contextConfigLocation，即获取web.xml配置文件中context-param标签key为contextConfigLocation的value值，上述配置中该value值为classpath:app*.xml

2.DispatchServlet加载时执行原理

DispatchServlet加载完整过程见博客：SpringMVC中load-on-startup标签的执行过程

Tomcat发布Web应用时依次执行init方法—>initServletBean方法—>执行initWebApplicationContext方法：

第549行：findWebApplicationContext用于在application内置对象中寻找已有的WebApplicationContext对象；

第553行：如果此时wac为null则说明第549行在application内置对象中未找到WebApplicationContext对象，则重新创建一个WebApplicationContext对象；

接下来进入findWebApplicationContext方法分析源码：

第587行：将web.xml配置文件中配置的DispatchServlet时配置的param-name标签key为contextAttribute的value值，此处为配置的org.springframework.web.context.WebApplicationContext.ROOT

第591-592行：getWebApplicationContext方法用于获取application内置对象中保存到的XmlWebApplicationContext对象

接下来再进入getWebApplicationContext方法分析源码：

第109行：attrName即为传入的org.springframework.web.context.WebApplicationContext.ROOT字符串，调用getAttribute方法即可获取application内置对象中保存的XmlWebApplicationContext对象；

第125行：将得到的XmlWebApplicationContext对象返回；

三、Root WebApplicationContext和Servlet WebApplicationContext

前面例子我们将Spring相关配置和SpringMVC相关配置一股脑写在了一个xml配置文件，试想如果需要配置的东西很多，那么该文件势必很长，势必很乱，为了解决这一诟病需要按照配置的不同创建两个配置文件：一个配置文件专门用于Spring相关配置；一个配置文件专门用于SpringMVC相关配置，如下：

root-context.xml：该文件仅用于实例化Service层和Dao层，用于数据库相关配置：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:p="http://www.springframework.org/schema/p"
	xmlns:tx="http://www.springframework.org/schema/tx"
	xmlns:mybatis-spring="http://mybatis.org/schema/mybatis-spring"
	xsi:schemaLocation="http://mybatis.org/schema/mybatis-spring http://mybatis.org/schema/mybatis-spring-1.2.xsd
		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd
		http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.3.xsd">
	
	<!--仅仅实例化被@Component、@Service或@Repository等注解所修饰的类 -->
	<context:component-scan base-package="com.jd">
		<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
	</context:component-scan>
	
	<bean id="dataSource" class="com.zaxxer.hikari.HikariDataSource" lazy-init="false" destroy-method="close">
		<property name="driverClassName" value="com.mysql.jdbc.Driver"></property>
		<property name="jdbcUrl" value="jdbc:mysql://127.0.0.1:3306/test?characterEncoding=utf8"></property>
		<property name="username" value="root"></property>
		<property name="password" value="root"></property>
	</bean>
	
	<bean class="org.springframework.jdbc.datasource.DataSourceTransactionManager" p:dataSource-ref="dataSource"></bean>
	<tx:annotation-driven/>
	
	<bean class="org.mybatis.spring.SqlSessionFactoryBean" 	p:dataSource-ref="dataSource" p:configLocation="classpath:mybatis-config.xml"
		p:mapperLocations="classpath:/sql/*.xml">
	</bean>
	
	<mybatis-spring:scan base-package="com.jd.*.dao" />
</beans>

servlet-context.xml：该文件仅用于实例化Controller层，用于视图解析器等SpringMVC相关配置：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:mvc="http://www.springframework.org/schema/mvc"
	xmlns:p="http://www.springframework.org/schema/p"
	xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd
		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd">
	
	<!-- 仅实例化被@Controller等注解所修饰的类 -->
	<context:component-scan base-package="com.jd" use-default-filters="false">
		<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
	</context:component-scan>
	
	<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
		<property name="prefix" value="/WEB-INF/view/"></property>
		<property name="suffix" value=".jsp"></property>
	</bean>
	
	<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver" p:defaultEncoding="UTF-8" p:maxUploadSize="10241000">
	</bean>
	
	<mvc:annotation-driven></mvc:annotation-driven>
</beans>

此时在web.xml配置文件中就需要对root-context.xml和servlet-contxt.xml文件分别进行配置： 

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://java.sun.com/xml/ns/javaee"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	id="WebApp_ID" version="2.5">
	<display-name>cassini</display-name>
	<welcome-file-list>
		<welcome-file>index.jsp</welcome-file>
	</welcome-file-list>
	
	<listener>
		<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
	</listener>
    
	<context-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>classpath:root-context.xml</param-value>
	</context-param>
    
	<servlet>
		<servlet-name>DispatcherServlet</servlet-name>
		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
		<init-param>
			<param-name>contextConfigLocation</param-name>
			<param-value>classpath:servlet-context.xml</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>
	<servlet-mapping>
		<servlet-name>DispatcherServlet</servlet-name>
		<url-pattern>*.do</url-pattern>
	</servlet-mapping>
</web-app>

 

AnFooo
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
spring监听器ContextLoaderListener的疑问
u011956329的博客
08-31 3815
今天新搭了项目，采用Spting和mybatis,MVC用的是Spring MVC ，配置文件采用的是之前的项目的。 在运行后访问项目时候报错了： java.lang.IllegalStateException: No WebApplicationContext found: no ContextLoaderListener registered? 在研究后发现是web.xml缺少了Spri
SpringMVC拦截器实现监听session是否过期详解
08-28
主要介绍了SpringMVC拦截器实现监听session是否过期详解，还是比较不错的，这里分享给大家，供需要的朋友参考。
Spring MVC的web.xml配置详解(ContextLoaderListener创建容器监听器、DispatcherServlet)
m0_45406092的博客
09-10 2876
文章目录参考 1、spring 框架解决字符串编码问题：过滤器 CharacterEncodingFilter（filter-name） 2、在web.xml配置监听器ContextLoaderListener（listener-class） ContextLoaderListener的作用就是启动Web容器时，自动装配ApplicationContext的配置信息。因为它实现了ServletContextListener这个接口，在web.xml配置这个监听器，启动容器时，就会默认执行它实现的方法
SpringMVC-----ContextLoaderListener
weixin_30347335的博客
01-21 162
前言 Spring框架提供了构建Web应用程序的全功能MVC模块。通过策略接口，Spring框架是高度可配置的，而且支持多种视图技术，例如JavaServer Pages（JSP）技术、Velocity、Tiles、iText和POI。Spring MVC框架并不知道使用的视图，所以不会强迫你只是用JSP技术，SpringMVC分离了控制器、模型对象、分派器以及处理程序对象的角色，这种分离让它们...
Spring mvc ContextLoaderListener 原理解析
jijianshuai的专栏
09-28 3879
对于熟悉Spring MVC功能，首先应从web.xml 开始，在web.xml 文件中我们需要配置一个监听器 ContextLoaderListener，如下。 listener> listener-class>org.springframework.web.context.ContextLoaderListenerlistener-class> listener>
SpringMVC容器初始化篇----ContextLoaderListener
大萌小路
10-16 4万+
此篇幅主要围绕着 ContextLoaderListener理解其中的原理。 contextConfigLocation classpath*:server_spring.xml org.springframework.web.context.ContextLoaderListener
spring mvc 之ContextLoaderListener
hepei120的专栏
10-15 290
springmvc 的源码分析要从web.xml开始。 2个重要的类一个是org.springframework.web.context.ContextLoaderListener，一个是org.springframework.web.servlet.DispatcherServletContextLoaderListener的作用是启动web容器时，能够自动装配ApplicationContex
解决SpringMVC Controller 接收页面传递的中文参数出现乱码的问题
08-27
SpringMVC 是一个基于模型-视图-控制器（MVC）模式的Web应用程序框架，广泛应用于Java Web开发中。但是，在使用SpringMVC时，常见的一个问题是Controller 接收页面传递的中文参数出现乱码。这种情况下，Controller ...
SpringMVC事件监听ApplicationListener实例解析
08-25
其中，ApplicationListener就是SpringMVC框架中的一种事件监听器，允许开发者监听框架中的各种事件。 要使用ApplicationListener，需要实现ApplicationListener接口，其中T是监听的事件类型。例如，想要监听...
SpringMVC4.2.4中文文档 PDF-高清带书签版本
11-06
2. **配置与设置**：讲解如何在项目中配置SpringMVC，包括web.xml中的DispatcherServlet配置、Spring MVC的配置文件、以及如何将SpringMVC集成到Spring IoC容器中。 3. **处理器映射器与适配器**：解释...
Spring的监听器ContextLoaderListener的作用
10-10
Spring的监听器ContextLoaderListener的作用
浅谈Springmvc中的页面跳转问题
08-28
标签包括springmvc、跳转页面、mvc、页面跳转、mvc控制器跳转页面等，这些标签都是与SpringMvc中的页面跳转问题相关的关键词。 主要内容解释 SpringMvc中的页面跳转问题可以分为两大类：使用ServletAPI实现页面跳转...
ContextLoaderListener作用详解
热门推荐
ysughw的专栏
05-30 13万+
ContextLoaderListener监听器的作用就是启动Web容器时，自动装配ApplicationContext的配置信息。因为它实现了ServletContextListener这个接口，在web.xml配置这个监听器，启动容器时，就会默认执行它实现的方法。至于ApplicationContext.xml这个配置文件部署在哪，如何配置多个xml文件，书上都没怎么详细说明。现在的方法就是查
关于springMvc启动容器的时候配置的ContextLoadListener，你必须知道的概念
lihaitao910215的博客
03-11 383
一、ServletContext是什么？ ServletContext是一个web应用的上下文，是一个全局信息的存储空间，代表当前web应用。 二、ServletContext什么时候创建？ ServletContext在web应用（服务器）启动时创建。 三、ServletContext什么时候销毁？ ServletContext在Web应用（服务器）关闭时释放。 四、ServletC...
SpringMVC容器初始化 ContextLoaderListener
explore
12-26 409
ContextLoaderListener的作用就是启动Web容器时，自动装配ApplicationContext的配置信息。 * web.xml配置 * ContextLoaderListener UML类图 * UML 时序图 * createWebApplicationContext * 寻找用来实例化ConfigurableWebApplicationContext的cla
SpringMVC源码5.0：ContextLoaderListener
weixin_37571795的博客
08-17 154
我打算先看Mvc，目前毕竟需要先研究源码好调试情况。 Spring框架提供了构建Web应用程序的全功能MVC模块，通过策略接口，Spring框架时高度可配置的，而且支持多种视图技术。 SpringMVC分离了控制器，模型对象，分派器以及处理程序对象的角色。此分离让它们更容易进行定制。 Servlet MVC是基于Servlet功能实现的，通过实现Servlet接口，通过实现Servlet接口的D...
SpringMVC之ContextLoaderListener
业精于勤荒于嬉 行成于思毁于随
02-12 1827
ContextLoaderListener的作用就是启动Web容器时自动装配ApplicationContext的配置信息。它实现了ServletContextListener接口，在web.xml中配置这个监听器，启动容器时就会执行它的实现类。 对于ServletContextListener，你可以利用它在为客户端请求提供服务之前像 向ServletContext中添加任意对象。该对象将在Se...
SpringMVC源码解析——ContextLoaderListener
最新发布
qq_16500963的博客
12-24 1022
在配置中只允许声明一次ServletContextListener，多次声明会扰乱Spring的执行逻辑，所以这里首先做的就是对此进行验证，在Spring中如果创建WebApplicationContext实例会记录在ServletContext中以方便全局调用，而使用的key就是WebApplicationContext的ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE，所以验证的方式就是查看ServletContext实例中是否有对应的Key的属性。否则返回默认的上下文类。
Spring学习笔记(4)一SpringMVC启动原理和WebApplicationContext、ApplicationContextInitializer、ApplicationRunner机制
黄规速博客:学如逆水行舟，不进则退
01-19 853
学习技术方面由浅入深的层次步骤： 了解：入门,如何去使用这门技术 掌握：具体,它的原理是什么 熟悉：规则实践,在理解原理的基础上，如何去模仿， 精通：解决问题 专家：觉悟,扩展创新,如何去进一步演化 在分析SpringMVC框架具体组件之前，我们先了解Spring WebApplicationContext。 我们开发springmvc 的web，主要代码就是controller，使用《Spring学习笔记(3)一SpringMVC快速入门》例子： package com.demo.springmv
springmvc注解配置监听器
05-23
在Spring MVC中使用注解配置监听器需要以下几步： 1. 创建一个监听器类，实现相应的监听器接口，如ServletRequestListener、HttpSessionListener、ServletContextListener等。 2. 在监听器类上添加@WebListener注解。 3. 在Spring MVC的配置类（通常是一个继承自WebMvcConfigurerAdapter的类）中添加一个方法，使用@Bean注解将监听器类实例化。 以下是示例代码： ``` import javax.servlet.ServletRequestEvent; import javax.servlet.ServletRequestListener; import javax.servlet.annotation.WebListener; @WebListener public class MyRequestListener implements ServletRequestListener { @Override public void requestInitialized(ServletRequestEvent sre) { // do something when request initialized } @Override public void requestDestroyed(ServletRequestEvent sre) { // do something when request destroyed } } ``` 在Spring MVC的配置类中添加如下方法： ``` import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration public class AppConfig extends WebMvcConfigurerAdapter { @Bean public MyRequestListener myRequestListener() { return new MyRequestListener(); } } ``` 这样就完成了在Spring MVC中使用注解配置监听器的步骤。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值