源码级剖析ContextLoaderListener

最新推荐文章于 2023-03-19 02:14:09 发布
最新推荐文章于 2023-03-19 02:14:09 发布
阅读量250 收藏 2
点赞数
分类专栏： 框架 文章标签： spring springmvc ContextLoader ServletContext Xml
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/w_rcss/article/details/111610634
版权

源码级剖析ContextLoaderListener

文章目录

前言

在Spring项目中，ContextLoaderListener扮演着至关重要的作用。项目启动需要ContextLoaderListener加载spring配置文件，所以经常在web.xml中来配置ContextLoaderListener。

<!-- 配置spring核心监听器，默认会以 /WEB-INF/applicationContext.xml作为配置文件 -->
<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<!-- contextConfigLocation参数用来指定Spring的配置文件 -->
<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>/WEB-INF/applicationContext*.xml</param-value>
</context-param>　

ContextLoaderListener是怎么工作的呢？通过ContextLoaderListener源码来分析一下

ContextLoaderListener

//ContextLoaderListener继承ContextLoader，实现ServletContextListener接口。
public class ContextLoaderListener extends ContextLoader implements ServletContextListener{
    public ContextLoaderListener() {
    }

    public ContextLoaderListener(WebApplicationContext context) {
        super(context);
    }
    //ContextLoaderListener在服务器启动时调用contextInitialized
    public void contextInitialized(ServletContextEvent event) {
        //此处ContextLoaderListener调用的ContextLoader的initWebApplicationContext方法
        this.initWebApplicationContext(event.getServletContext());
    }
    //ContextLoaderListener在服务器关闭时调用contextDestroyed
    public void contextDestroyed(ServletContextEvent event) {
        this.closeWebApplicationContext(event.getServletContext());
        ContextCleanupListener.cleanupAttributes(event.getServletContext());
    }

}
  1. ContextLoaderListener继承ContextLoader
  2. ContextLoaderListener实现ServletContextListener接口
  3. contextInitialized是ContextLoaderListener的关键核心方法，也是我们的重点研究对象

在这里插入图片描述
我们先来了解下ServletContextListener接口

ServletContextListener

ServletContextListener主要用于监听ServletContext对象的生命周期,服务器启动时 创建ServletContext，服务器关闭时销毁ServletContext

public interface ServletContextListener extends EventListener {
    //Servlet容器启动Web应用时调用该方法。在调用完该方法之后，初始化Filter,并且对那些在Web应用启动时就需要被初始化的Servlet 进行初始化
    default void contextInitialized(ServletContextEvent sce) {
    }
    //当Servlet容器终止Web应用时调用该方法。在调用该方法之前，容器会先销毁所有的Servlet和Filter过滤器。
    default void contextDestroyed(ServletContextEvent sce) {
    }
}

当servlet容器启动或终止时，触发ServletContextEvent事件。ServletContextEvent作为参数参与了ContextLoader的initWebApplicationContext方法。

ContextLoaderListener调用父类ContextLoader的initWebApplicationContext方法，接下来重点看一下ContextLoader类。

ContextLoader

在看ContextLoader的initWebApplicationContext的方法前，先来看下ContextLoader的静态代码块
在这里插入图片描述

1. 静态代码块

    static {
        try {
            //DEFAULT_STRATEGIES_PATH = "ContextLoader.properties"，此处加载的是contextLoader.properties的配置文件
            ClassPathResource resource = new ClassPathResource("ContextLoader.properties", ContextLoader.class);
            defaultStrategies = PropertiesLoaderUtils.loadProperties(resource);
        } catch (IOException var1) {
            throw new IllegalStateException("Could not load 'ContextLoader.properties': " + var1.getMessage());
        }

        currentContextPerThread = new ConcurrentHashMap(1);
    }

源码里翻看下contextLoader.properties里是怎么设置的？接着翻

org.springframework.web.context.WebApplicationContext=org.springframework.web.context.support.XmlWebApplicationContext

ContextLoader通过静态代码块读取XmlWebApplicationContext，在用户没有在配置文件指定CONTEXT_CLASS的时候，作为默认值使用。

2. initWebApplicationContext

看完静态代码块，重头戏来了，看看核心方法initWebApplicationContext。

public WebApplicationContext initWebApplicationContext(
        ServletContext servletContext) {
    
    // 检查application对象中是否有ApplicationContext，有则抛出异常
    // 其中ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE = WebApplicationContext.class.getName() + ".ROOT";
    if (servletContext
            .getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE) != null) {
        
        throw new IllegalStateException(
                "Cannot initialize context because there is already a root application context present - "
                        + "check whether you have multiple ContextLoader* definitions in your web.xml!");
        // 无法初始化上下文，因为已经存在根应用程序上下文
        // web.xml中定义了多个ContextLoader
    }else { //否则就初始化WebApplicationContext，"Initializing Spring root WebApplicationContext"这句 是不是很熟悉？
            servletContext.log("Initializing Spring root WebApplicationContext");
            Log logger = LogFactory.getLog(ContextLoader.class);
            if (logger.isInfoEnabled()) {
                logger.info("Root WebApplicationContext: initialization started");
            }
 
    /**
    *
    * 创建得到WebApplicationContext
    * 将createWebApplicationContext返回值转换为ConfigurableWebApplicationContext类型
    */
    
    if (this.context == null) {
        //调用createWebApplicationContext，创建WebApplicationContext，看步骤2.1
        this.context = createWebApplicationContext(servletContext);
    }
    
    // 拿到ConfigurableWebApplicationContext进入if判断
    if (this.context instanceof ConfigurableWebApplicationContext) {
        
        // 强制转换为ConfigurableWebApplicationContext类型
        ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;
        
        // cwac（ApplicationContext）没有生效，配置文件没有加载
        if (!cwac.isActive()) {
            //applicationContext没有刷新，要设置一个parent 
            if (cwac.getParent() == null) {
                ApplicationContext parent = this.loadParentContext(servletContext);
                            cwac.setParent(parent);
                        }
            // 加载配置文件
            // 此处调用了configureAndRefreshWebApplicationContext方法，看步骤2.2
            this.configureAndRefreshWebApplicationContext(cwac, servletContext);
        }
    }
    
    // 将WebApplicationContext绑定到web应用程序的ServtContext上
    servletContext.setAttribute(
            WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE,
            this.context);
    
    // 返回webApplicationContext
    return this.context;
}

init中有两个核心方法

  • createWebApplicationContext()
  • configureAndRefreshWebApplicationContext()

先来看看如何创建webApplicationContext

2.1 createWebApplicationContext
    protected WebApplicationContext createWebApplicationContext(ServletContext sc) {
        // 获取context类， 看步骤2.1.1
        Class<?> contextClass = this.determineContextClass(sc);//判断使用什么样的类在Web容器中作为IoC容器
        
        如果context类没有实现ConfigurableWebApplicationContext接口则抛出异常      
        if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
            throw new ApplicationContextException("Custom context class [" + contextClass.getName() + "] is not of type [" + ConfigurableWebApplicationContext.class.getName() + "]");
        } else {
             返回该context类的实例，调用BeanUtils.instantiateClass(contextClass)，通过反射，调用XmlWebApplicationContext的无参构造函数实例化XmlWebApplicationContext对象
            return (ConfigurableWebApplicationContext)BeanUtils.instantiateClass(contextClass);
        }
    }
2.1.1 determineContextClass
    /**
    * 返回context
    */
    protected Class<?> determineContextClass(ServletContext servletContext) {
        //从servletContext中获取初始化配置参数contextClass，配置类实现了XmlWebApplicationContext
        String contextClassName = servletContext.getInitParameter("contextClass");//读取web.xml中的配置<context-param>contextClass</context-param>
        //有配置使用配置的CONTEXT_CLASS,默认使用XmlWebApplicationContext.
        if (contextClassName != null) {
            try {
                return ClassUtils.forName(contextClassName, ClassUtils.getDefaultClassLoader());
            } catch (ClassNotFoundException var4) {
                throw new ApplicationContextException("Failed to load custom context class [" + contextClassName + "]", var4);
            }
        } else {
            // 如果没有配置则使用XmlWebApplicationContext，此处读取的contextLoad.properties配置
            //
            contextClassName = defaultStrategies.getProperty(WebApplicationContext.class.getName());

            try {
                return ClassUtils.forName(contextClassName, ContextLoader.class.getClassLoader());
            } catch (ClassNotFoundException var5) {
                throw new ApplicationContextException("Failed to load default context class [" + contextClassName + "]", var5);
            }
        }
    }
  1. contextClass继承了XmlWebApplicationContext
  2. XmlWebApplicationContext继承了AbstractRefreshableWebApplicationContext，调用了getConfigLocations()
    // 该方法默认加载contextConfigLocation中定义的xml 文件
    public String[] getConfigLocations() {
        return super.getConfigLocations();
    }
  1. AbstractRefreshableWebApplicationContext继承了AbstractRefreshableConfigApplicationContext
	// this.getDefaultConfigLocations()返回null
    @Nullable
    protected String[] getConfigLocations() {
        return this.configLocations != null ? this.configLocations : this.getDefaultConfigLocations();
    }

在这里插入图片描述
此方法直接返回AbstractRefreshableConfigApplicationContext自己的属性：String[] configLocations，ContextLoader完成了对contextConfigLocation中的spring配置文件的加载。

终于找到了ContextLoaderListener是如何加载spring配置文件的，但是init方法还没结束，接下来我们看看如何初始化WebApplicationContext。

2.2 configureAndRefreshWebApplicationContext
    // 配置并且刷新WebApplicationContext，设置IoC容器的参数,并通过refresh开启容器初始化
    protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) {
        String configLocationParam;
        if (ObjectUtils.identityToString(wac).equals(wac.getId())) {
            configLocationParam = sc.getInitParameter("contextId");
            if (configLocationParam != null) {
                wac.setId(configLocationParam);
            } else {
                wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX + ObjectUtils.getDisplayString(sc.getContextPath()));
            }
        }
        //为wac绑定servletContext
        wac.setServletContext(sc);
        
        //CONFIG_LOCATION_PARAM=contextConfigLocation
        //getInitParameter(CONFIG_LOCATION_PARAM)解释了为什么配置文件中需要有contextConfigLocation项
        //sevletConfig.getInitParameter和servletContext.getInitParameter作用范围是不一样的
        configLocationParam = sc.getInitParameter("contextConfigLocation");
        if (configLocationParam != null) {
            wac.setConfigLocation(configLocationParam);
        }

        ConfigurableEnvironment env = wac.getEnvironment();
        if (env instanceof ConfigurableWebEnvironment) {
            ((ConfigurableWebEnvironment)env).initPropertySources(sc, (ServletConfig)null);
        }

        this.customizeContext(sc, wac);
        wac.refresh();//容器的初始化
    }

总结

做个总结，先上图：
在这里插入图片描述

  • ContextLoadListener实现了ServletContextListener接口，重写了init和distory方法

    • ServletContextListener主要监听ServletContext对象的生命周期，在ServletContext对象创建后，webApplicationContext才能被创建并绑定到ServletContext对象
    • 绑定以后就可以通过servletContext获取webApplicationContext了

  • ContextLoadListener继承了ContextLoader类

    • 通过静态代码块获取XmlWebApplicationContext作为默认的CONTEXT_CLASS，用于WebApplicationContext的创建
    • init方法中create方法用于创建WebApplicationContext，configureAndRefresh用于初始化WebApplicationContext
      • create方法中通过determineContextClass方法，最终使用AbstractRefreshableConfigApplicationContext类的getConfigLocations()
        加载spring的配置文件
      • configureAndRefresh结束完成了WebApplicationContext的初始化工作。

好了，讲到这里，ContextLoadListener已经说完了！

w_rcss
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
使用kxml解析xml文件(一)
Pi的空间
01-19 839
这个是参照ibm网站上的文章做的。 xml源文件： <!DOCTYPE rss PUBLIC "-//Netscape Communications//DTD RSS 0.91//EN" "http://my.netscape.com/publish/formats/rss-0.91.dtd"> Meerkat: An Open2 Wire Servi
基于XML的IOC和DI（上篇）
Yong Ledo的博客
08-11 293
概念 首先来看下百度百科是如何描述IOC的： 控制反转（Inversion of Control，缩写为IoC），是面向对象编程中的一种设计原则，可以用来减低计算机代码之间的耦合度。 总的来说IOC只做了一件事，那就是减低代码之间的耦合度！但在开始之前，我们要清楚所谓减低耦合度，其实也是在减低依赖性，而不是消除。那么在编程中如何减低呢？那就是面向接口编程，所有的依赖全部使用接口对象，而不是具体实现者，真正使用的时候才从外界传入（具体的实现者）到依赖的对象中。那么问题来了，具体的实现者总得有个地方来定义或
11.0、Spring源码学习 ——SpringMVC 的 ContextLoaderListener
༺ bestcxx的专栏 ༻
08-29 409
文章目录前言SpringMVC 和 web.xmlServletContextListener自己实现一个 ServletContextListener在 web.xml 中使用 < listener> 配置 ServletContextListenerSpringMVC 对 ServletContextListener 的实现 ContextLoaderListenerCont...
关于ContextLoaderListener源码
jellins的专栏
01-10 1996
 ContextLoaderListener继承ServletContextListener类,实现contextInitialized方法public void contextInitialized(ServletContextEvent event) {  this.contextLoader = createContextLoader();  this.contextLoader.i
SSM笔记（尚硅谷）
wang17691049的博客
03-19 1005
MyBatis支持定制化SQL、存储过程以及高级映射MyBatis避免了几乎所有的JDBC代码和手动设置参数以及结果集解析操作MyBatis可以使用简单的XML或注解实现配置和原始映射；将接口和Java的POJO（Plain Ordinary Java Object，普通的Java对象）映射成数据库中的记录Mybatis是一个半自动的ORM（Object Relation Mapping）框架简单类型：只包含一个值的数据类型基本数据类型：int、byte、short、double、……
Spring MVC 启动过程源码分析详解
08-27
通过对 Spring MVC 启动过程的源码分析，我们可以了解到 Spring MVC 的工作原理和内部机制，包括 ContextLoaderListener 监听器和 DispatcherServlet 前端控制器的作用。了解这些知识可以帮助我们更好地使用 Spring ...
Spring-5.1.5源码
02-25
总之，`Spring-5.1.5源码`的分析涵盖了Spring框架在Web应用中的核心功能，包括初始化、配置加载、依赖注入、AOP、异常处理以及现代化Web技术的支持。深入理解这些知识点，对于提升Spring框架的使用技巧和开发效率...
SpringMvc+Spring+MyBatis+Maven整合视频源码+数据库
02-04
本资源提供的"SpringMvc+Spring+MyBatis+Maven整合视频源码+数据库"是针对这四个框架的集成实践，通过源码分析，有助于开发者深入理解它们的协同工作方式。 Spring MVC 是Spring框架的一部分，它作为控制器，负责...
Jersey1.8在spring环境下的实现 包括实例代码
03-24
3. **Spring与Jersey集成：** 将Jersey集成到Spring环境中，可以通过Spring的ContextLoaderListener初始化Jersey的Servlet，或者使用`@Provider`注解的bean进行注册。这允许我们在Spring容器中管理Jersey组件，并...
Struts2 Spring Hibernate的配置及登录实例(附源码)
04-16
6. **源码分析** - 源码中可能包含`struts.xml`、`applicationContext.xml`、`hibernate.cfg.xml`等配置文件。 - LoginAction类实现登录功能，可能包含validate()方法进行验证，execute()方法处理登录逻辑。 - ...
SSM 框架整合教程-尚硅谷学习笔记 2022 年
最新发布
08-17
SSM 框架整合教程——尚硅谷学习笔记 2022 年
尚硅谷_SSM高级整合课件
07-22
尚硅谷_SSM高级整合课件
尚硅谷佟刚Spring4代码及PPT.rar
06-18
代码及ppt涵盖 Spring4.0 的所有核心内容：在 Eclipse 中安装 SpringIDE 插件、IOC & DI、在 Spring 中配置 Bean、自动装配、Bean 之间的关系（依赖、继承）、Bean 的作用域、使用外部属性文件、SpEL、管理 Bean 的生命周期、通过工厂方法配置 Bean、通过 FactoryBean 配置 Bean、通过注解配置 Bean、泛型依赖注入、AOP 基础、前置通知、后置通知、返回通知、异常通知、环绕通知、切面的优先级、切点表达式、使用 XML 文件的方式配置 AOP、使用 JdbcTemplate 和 JdbcDaoSupport、使用 NamedParameterJdbcTemplate、Spring 的声明式事务、事务的属性（传播行为、隔离级别、回滚属性、只读属性、过期时间）、使用 XML 文件的方式配置事务、整合 Hibernate、整合 Struts2 等。
尚硅谷SSM高级整合源码及文档
07-19
尚硅谷SSM高级整合项目源码
ssm框架整合demo
03-06
ssm框架整合demo，实现简单功能，主要是几大框架的整个以供学习
【Python教程】基础篇
gecko
02-08 2005
1.1基础入门 1.1.1Python简介 胶着型语言:可以和C语言,java语言融合使用.(GIL程序通常使用其他语言编写,而使用Python调用) 解释型语言:开发过程中无编译环节,运行速度比较慢. 交互式语言:意味着在一个Python提示符下直接互动执行程序. 面向对象语言:代码封装在对象的编程技术. Python应用是否广泛,做网站,做游戏,做爬虫,做数据分析和挖掘,以及人工智能...
Spring源码解读：ContextLoader类
热门推荐
chenpeng19910926的专栏
05-05 1万+
ContextLoader类的结构如图： ContextLoader类的源码： package org.springframework.web.context; import java.io.IOException; import java.util.ArrayList; import java.util.Collections; import java.util.List;
Ubuntu20.04安装OpenCV并配置Clion工程
范子琦的博客
02-27 3373
Ubuntu20.04安装OpenCV并配置Clion工程
ContextLoaderListener
05-25
ContextLoaderListener是一个JavaWeb应用程序中的监听器（Listener），它用于在应用程序启动时加载应用程序上下文（Application Context）。它会在Servlet容器（如Tomcat）启动时自动执行，并通过读取web.xml文件中...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值