Spring 知识面面通 之 ContextLoader启动入口源码解析

2023-10-29 15:59
文章标签 java 源码 启动 spring 解析 入口 contextloader 知识面 面通

本文主要是介绍Spring 知识面面通 之 ContextLoader启动入口源码解析，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

  关于Spring的启动入口，在本博《Spring 通篇源码 之 启动 之 程序入口分析》已有介绍，其更多的是在理论层面进行了分析，本文将在源码的角度分析ContextLoaderListener入口。

  源码流程

  以ContextLoaderListener作为入口的启动流程，如图中所示，直到AbstractApplicationContext.refresh(...)进行任务分解，本文仅对左侧部分进行解析，其余部分会在后续博文中进行讲解。

在这里插入图片描述

  源码解析

  1) ContextLoaderListener.contextInitialized(...)

  ① ContextLoaderListener实现了ServletContextListener接口，可以通过contextInitialized(...)和contextDestroyed(...)方法接收ServletContext的初始化和销毁事件。

  ② 基于web.xml的应用，需要在web.xml中增加ContextLoaderListener的配置。

<listener><listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener><context-param><param-name>contextConfigLocation</param-name><param-value>classpath*:/spring/applicationContext.xml</param-value>
</context-param>

  ③ 基于Servlet 3.0+版本，可以通过编码的方式对ContextLoaderListener进行配置。

servletContext.addListener(...);

  2) ContextLoader.initWebApplicationContext(...)

  initWebApplicationContext(...)正如方法名描述的一样，主要用来初始化WebApplicationContext，主要涉及操作：

​  ① 校验ServletContext中是否包含WebApplicationContext.class.getName() + ".ROOT"为键的属性，若存在，这抛出异常，以此来禁止重复初始化WebApplicationContext。

​  ② 调用createWebApplicationContext(...)用来创建WebApplicationContext，createWebApplicationContext(...)中调用determineContextClass(...)来确定使用的WebApplicationContext实现类。

  · 首先取得ServletContext初始化参数contextClass，若类可正常加载，则作为WebApplicationContext实现类。

  · 若ServletContext未取得初始化参数contextClass或类加载异常，则会使用ContextLoader.properties配置的默认策略指定的实现类。

  ContextLoader.properties文件配置：

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

  ③ 若WebApplicationContext实例为ConfigurableWebApplicationContext类型，则调用configureAndRefreshWebApplicationContext(...)配置刷新WebApplicationContext。

  ④ 使用WebApplicationContext.class.getName() + ".ROOT"作为键，WebApplicationContext作为值 的键值对设置到ServletContext属性中。

  ⑤ 当前类加载器与加载ContextLoader的类加载器一直时，将WebApplicationContext设置到currentContext属性，否则将WebApplicationContext设置到currentContextPerThread，两种方式的目的都是保证后续操作中可以取到WebApplicationContext。

  initWebApplicationContext(...)源码注释：

/*** 根据给定的ServletContext初始化Spring的WebApplicationContext.* 使用构造时给定的提供的ApplicationContext，或者根据contextClass和contextConfigLocation创建一个新的ApplicationContext.* @param servletContext 当前ServletContext.* @return 新的WebApplicationContext.*/
public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {// 从ServletContext获取WebApplicationContext.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!");}Log logger = LogFactory.getLog(ContextLoader.class);servletContext.log("Initializing Spring root WebApplicationContext");if (logger.isInfoEnabled()) {logger.info("Root WebApplicationContext: initialization started");}// WebApplicationContext启动开始时间.long startTime = System.currentTimeMillis();try {// 将上下文存储在本地实例变量中，以确保在ServletContext关闭时它可用.if (this.context == null) {this.context = createWebApplicationContext(servletContext);}// context实现了ConfigurableWebApplicationContext接口.if (this.context instanceof ConfigurableWebApplicationContext) {ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;if (!cwac.isActive()) {// 上下文尚未刷新->提供设置父上下文、设置应用程序上下文id等if (cwac.getParent() == null) {// 上下文实例被注入时没有显式的父级.// 确定根web应用程序上下文的父级（如果有）.ApplicationContext parent = loadParentContext(servletContext);cwac.setParent(parent);}// 配置、刷新WebApplicationContext.configureAndRefreshWebApplicationContext(cwac, servletContext);}}// 设置this.context设置到ServletContext中.servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);// 设置当前在用上下文.ClassLoader ccl = Thread.currentThread().getContextClassLoader();if (ccl == ContextLoader.class.getClassLoader()) {currentContext = this.context;}else if (ccl != null) {currentContextPerThread.put(ccl, this.context);}if (logger.isDebugEnabled()) {logger.debug("Published root WebApplicationContext as ServletContext attribute with name [" +WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE + "]");}if (logger.isInfoEnabled()) {long elapsedTime = System.currentTimeMillis() - startTime;logger.info("Root WebApplicationContext: initialization completed in " + elapsedTime + " ms");}return this.context;}catch (RuntimeException ex) {logger.error("Context initialization failed", ex);servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, ex);throw ex;}catch (Error err) {logger.error("Context initialization failed", err);servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, err);throw err;}
}

  createWebApplicationContext(...)源码注释：

/*** 实例化此加载程序的根WebApplicationContext，可以是默认上下文类，也可以是自定义上下文类（如果指定的话）.* 此实现要求自定义上下文实现ConfigurableWebApplicationContext接口.* 可在子类中重写此方法.* 另外，customizeContext在刷新上下文之前被调用，允许子类对上下文执行自定义修改.* @param sc 当前ServletContext.* @return WebApplicationContext.*/
protected WebApplicationContext createWebApplicationContext(ServletContext sc) {// 确定使用的WebApplicationContext实现类.Class<?> contextClass = determineContextClass(sc);// 若WebApplicationContext实现类未实现ConfigurableWebApplicationContext，则会抛出异常.if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {throw new ApplicationContextException("Custom context class [" + contextClass.getName() +"] is not of type [" + ConfigurableWebApplicationContext.class.getName() + "]");}// 实例化对应WebApplicationContext的实现类.return (ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);
}

  determineContextClass(...)源码注释：

/*** 返回要使用的WebApplicationContext实现类，可以是默认的XmlWebApplicationContext，也可以是自定义上下文类（如果指定）.* @param servletContext 当前ServletContext.* @return 要使用的WebApplicationContext实现类.*/
protected Class<?> determineContextClass(ServletContext servletContext) {// 获取ServletContext初始化参数contextClass.String contextClassName = servletContext.getInitParameter(CONTEXT_CLASS_PARAM);if (contextClassName != null) {try {return ClassUtils.forName(contextClassName, ClassUtils.getDefaultClassLoader());}catch (ClassNotFoundException ex) {throw new ApplicationContextException("Failed to load custom context class [" + contextClassName + "]", ex);}}// 若未配置ServletContext初始化参数contextClass，//  则使用默认策略，默认策略为org.springframework.web.context.support.XmlWebApplicationContext.else {contextClassName = defaultStrategies.getProperty(WebApplicationContext.class.getName());try {return ClassUtils.forName(contextClassName, ContextLoader.class.getClassLoader());}catch (ClassNotFoundException ex) {throw new ApplicationContextException("Failed to load default context class [" + contextClassName + "]", ex);}}
}

  3) ContextLoader.configureAndRefreshWebApplicationContext(...)

  configureAndRefreshWebApplicationContext(...)主要为WebApplicationContext的刷新进行配置，主要涉及操作：

  ① 若WebApplicationContext的id属性认为默认值，则会重新为WebApplicationContext设置一个新值。

  · 若ServletContext初始化参数contextId存在，则使用其值作为WebApplicationContext的id属性值。

  · 若ServletContext初始化参数contextId不存在，则使用WebApplicationContext.class.getName() + ":" + ObjectUtils.getDisplayString(sc.getContextPath())作为WebApplicationContext的id属性值。

  ② 将ServletContext实例设置到WebApplicationContext的servletContext。

  ③ 若ServletContext初始化参数contextConfigLocation存在，则其值为WebApplicationContext的configLocation的值，内容为WebApplicationContext的配置文件路径。

  ④ 以servletContextInitParams作为键，servletContextInitParams和ServletContext的ServletContextPropertySource实例作为值，设置到环境变量中。

  以servletConfigInitParams作为键，servletConfigInitParams和ServletConfig的ServletConfigPropertySource实例作为值，设置到环境变量中。

  ⑤ 通过ApplicationContextInitializer自定义上下文修改，ApplicationContextInitializer是一个扩展点，可以针对WebApplicationContext进行修改。

  ⑥ 调用WebApplicationContext实例的refresh()方法刷新上下文。

  configureAndRefreshWebApplicationContext(...)源码注释：

/*** 配置、刷新WebApplicationContext.*/
protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) {// 若WebApplicationContext的id仍是其原始默认值，根据可用信息重新设置一个id.if (ObjectUtils.identityToString(wac).equals(wac.getId())) {// 获取ServletContext初始化参数contextId.String idParam = sc.getInitParameter(CONTEXT_ID_PARAM);if (idParam != null) {wac.setId(idParam);}else {// 为WebApplicationContext生成默认id值.wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +ObjectUtils.getDisplayString(sc.getContextPath()));}}// ServletContext设置到WebApplicationContext.wac.setServletContext(sc);// 获取ServletContext初始化参数contextConfigLocation.String configLocationParam = sc.getInitParameter(CONFIG_LOCATION_PARAM);// 设置WebApplicationContext的configLocation属性.if (configLocationParam != null) {wac.setConfigLocation(configLocationParam);}// WebApplicationContext环境的initPropertySources将在任何情况下在刷新上下文时被调用.ConfigurableEnvironment env = wac.getEnvironment();if (env instanceof ConfigurableWebEnvironment) {((ConfigurableWebEnvironment) env).initPropertySources(sc, null);}// 通过ApplicationContextInitializer自定义上下文修改.customizeContext(sc, wac);// 刷新上下文.wac.refresh();
}

  总结

  作为Spring框架的主入口，花点时间来研究其原理，还是十分必要的，本文流程解析至ContextLoader.configureAndRefreshWebApplicationContext(...)，剩余流程会在后续博文中继续解析。

  源码解析基于spring-framework-5.0.5.RELEASE版本源码。

  若文中存在错误和不足，欢迎指正！

这篇关于Spring 知识面面通 之 ContextLoader启动入口源码解析的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/301715。

相关文章

网页解析 lxml 库--实战

网页解析 lxml 库--实战

lxml库使用流程 lxml 是 Python 的第三方解析库，完全使用 Python 语言编写，它对 XPath表达式提供了良好的支 持，因此能够了高效地解析 HTML/XML 文档。本节讲解如何通过 lxml 库解析 HTML 文档。 pip install lxml lxm| 库提供了一个 etree 模块，该模块专门用来解析 HTML/XML 文档，下面来介绍一下 lxml 库
阅读更多...
JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
MySQL数据库宕机，启动不起来，教你一招搞定！

MySQL数据库宕机，启动不起来，教你一招搞定！

作者介绍：老苏，10余年DBA工作运维经验，擅长Oracle、MySQL、PG、Mongodb数据库运维（如安装迁移，性能优化、故障应急处理等）公众号：老苏畅谈运维欢迎关注本人公众号，更多精彩与您分享。 MySQL数据库宕机，数据页损坏问题，启动不起来，该如何排查和解决，本文将为你说明具体的排查过程。 查看MySQL error日志 查看 MySQL error日志，排查哪个表（表空间
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2