【spring源码系列-03】xml配置文件启动spring时refresh的前置工作

简介: 【spring源码系列-03】xml配置文件启动spring时refresh的前置工作

一,xml配置文件启动spring时refresh的前置工作

前两篇大概的描述了一下springIoc的整体流程,接下来再对里面的细节进行分析。如下依旧是通过经典的xml的方式获取到上下文,并且在resources目录下配置一个spring.xml文件,这里推荐使用debug的方式,从上往下看

ApplicationContext ioc=new ClassPathXmlApplicationContext("classpath:spring.xml");

进入这个获取上下文的构造方法之后,可以发现有调用了这个this方法

public ClassPathXmlApplicationContext(String configLocation) throws BeansException {
  this(new String[] {configLocation}, true, null);
}

接下来在进入这个this方法,就是一个熟悉的方法,该方法在前两篇中有所提到。接下来重点就是对里面的前两个方法进行深究,弄清refresh的前置工作到底做了什么

public ClassPathXmlApplicationContext(
  String[] configLocations, boolean refresh, @Nullable ApplicationContext parent)
throws BeansException {
  super(parent); // 初始化父类 ,获得xml路径资源解析器
  setConfigLocations(configLocations); // 通过环境变量解析 xml路径
  if (refresh) {
    refresh(); // 这个方法时spring是最终要的一个方法,甚至体系整个ioc的声明周期
  }
}

1,super(parent)

在该方法中,第一步就是初始化父类,后面很多需要使用的对象,就是在这一步被创建的,而里面的super继续调用自己的super,直到创建一个资源模式处理器,该 AbstractApplicationContext 相对来说比较重要,并且那个最重要的refresh 方法就是在这个抽象类里面

public AbstractApplicationContext() {
    //获取资源模式处理器
  this.resourcePatternResolver = getResourcePatternResolver();
}

接下来就是查看这个具体的获取资源处理器的流程,里面的xml文件,或者其他的注解配置文件,都是能获取的资源,获取到资源之后就对资源进行一个解析操作

protected ResourcePatternResolver getResourcePatternResolver() {
  return new PathMatchingResourcePatternResolver(this);
}

接下来在查看这个 PathMatchingResourcePatternResolver 对象,可以发现里面就是获取资源对象加载器。并且里面还存在一个对象PathMatcher,用做于路径匹配

//用于模式匹配,默认使用的是 PathMatcher
private PathMatcher pathMatcher = new AntPathMatcher();
//获取资源加载器
public PathMatchingResourcePatternResolver(ResourceLoader resourceLoader) {
  Assert.notNull(resourceLoader, "ResourceLoader must not be null");
  this.resourceLoader = resourceLoader;
}

在这个ResourceLoader 类中,主要就是两个方法,一个是用于加载资源,一个是用于加载类加载器

//加载资源
Resource getResource(String location);
@Nullable
//加载类加载器
ClassLoader getClassLoader();

在这个 AbstractApplicationContext 构造方法中,完成this获取一个资源解析器之后,接下来就是一个设置一个Parent的父类,当前springIOC中是没有父子容器的概念的,因此到后续的springMVC再进行分析

public AbstractApplicationContext(@Nullable ApplicationContext parent) {
  this();
    //springIOC中暂时没有父子容器概念,先跳过
  setParent(parent);
}

因此这一整个步骤,都是为了初始化成员变量。而最主要的,就是初始化一个资源的解析器。

2,setConfigLocations()

在获取到这个资源解析器之后,接下来就是设置文件的路径。如在正常开发的springboot项目中,通过设置环境的的属性来表名是dev环境还是线上环境等。这个locations参数就是 new String[] {configLocation}

//参数可以是对象或者数组
public void setConfigLocations(@Nullable String... locations) {
  if (locations != null) {
    Assert.noNullElements(locations, "Config locations must not be null");
    this.configLocations = new String[locations.length];
    for (int i = 0; i < locations.length; i++) {
      this.configLocations[i] = resolvePath(locations[i]).trim();
    }
  }
  else {
    this.configLocations = null;
  }
}

2.1,获取系统属性和系统环境

在获取到外部传进来的文件路径之后,接下来会通过这个 resolvePath方法解析这个路径。而在解析这个路径时,需要通过系统环境变量来解析,如果环境变量为空,则创建一个标准的环境变量

protected String resolvePath(String path) {
    //获取环境
  return getEnvironment().resolveRequiredPlaceholders(path);
}
//如果获取的环境为空,则创建一个标准环境
protected ConfigurableEnvironment createEnvironment() {
  return new StandardEnvironment();
}

而在这些环境中,存在一些spring环境变量的类型,分别是可忽视的,活跃的默认的等

public static final String IGNORE_GETENV_PROPERTY_NAME = "spring.getenv.ignore";
public static final String ACTIVE_PROFILES_PROPERTY_NAME = "spring.profiles.active";
public static final String DEFAULT_PROFILES_PROPERTY_NAME = "spring.profiles.default";
protected static final String RESERVED_DEFAULT_PROFILE_NAME = "default";

同时在这个标准环境中,主要分为系统环境和系统属性等

//系统环境属性资源名称
static final String SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME = "systemEnvironment";
//系统配置变量资源名称
static final String SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME = "systemProperties";

最后将全部的系统环境和系统属性一起加入到 propertySources 这个PropertySources集合中,该集合是在父类中实例化的,因此会作为一个全局共享的资源,其子类都能获取和访问

protected void customizePropertySources(MutablePropertySources propertySources) {
  propertySources.addLast(
      new PropertiesPropertySource(SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME, getSystemProperties()));
  propertySources.addLast(
      new SystemEnvironmentPropertySource(SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, getSystemEnvironment()));
}

加入到集合的value值主要是系统的变量和系统的环境。

//获取系统的属性值
getSystemProperties(){System.getProperties()};
//获取系统的变量
getSystemEnvironment(){System.getenv()};

在创建这个 StandardEnvironment() 标准的环境的时候,可以在父类的无参构造方法中打一个断点,可以发现此时会有两个属性值,就是上面的系统属性值和系统环境值

而在下面的propertySourceList的第一个值systemProperties中,已经加载了56个系统属性,比如说一些 jdk的版本,虚拟机的版本,操作系统的名称,当前用户的名称等等


在下面的propertySourceList的第二个值systemEnvironment中,也有49个值,比如说当前电脑的名称,使用的maven路径以及版本,java_home的路径,用户的用户名等等

此时这些默认的环境对象和环境变量就全被获取。当然这些环境变量的数量也可能因为源码的版本不同个数也会不同。

2.2,解析系统环境和系统属性

又回到上面的第二步,此时环境变量值依旧获取,因此接下来就继续执行这个 resolveRequiredPlaceholders 方法

protected String resolvePath(String path) {
    //获取环境
  return getEnvironment().resolveRequiredPlaceholders(path);
}

在resolveRequiredPlaceholders方法中,会获取到刚刚全部获取到的环境和属性,然后对这些环境和属性做一个解析操作。这里的话类似于一个责任链模式,系统环境要处理的会有对应的方法处理系统环境,系统属性要处理的会有对应的方法处理系统属性。下面这个是处理系统环境的方法

@Override
public String resolveRequiredPlaceholders(String text) throws IllegalArgumentException {
    //this.propertyResolver:全部的系统环境和系统属性
  return this.propertyResolver.resolveRequiredPlaceholders(text);
}
@Override
public String resolveRequiredPlaceholders(String text) throws IllegalArgumentException {
  if (this.strictHelper == null) {
    this.strictHelper = createPlaceholderHelper(false);
  }
    //解析工作
  return doResolvePlaceholders(text, this.strictHelper);
}

而在处理系统属性时,会有一个 createPlaceholderHelper 方法,类似于一个builder的工厂类

private PropertyPlaceholderHelper createPlaceholderHelper(boolean ignoreUnresolvablePlaceholders) {
    //前缀,后缀
  return new PropertyPlaceholderHelper(this.placeholderPrefix, this.placeholderSuffix,
    this.valueSeparator, ignoreUnresolvablePlaceholders);
}

在获取到这个strictHelper 对象之后,接下来开始真正的进行解析工作

private String doResolvePlaceholders(String text, PropertyPlaceholderHelper helper) {
  return helper.replacePlaceholders(text, this::getPropertyAsRawString);
}

再次进入这个replacePlaceholders 这个方法,可以发现里面会有一个重要的方法parseStringValue

public String replacePlaceholders(String value, PlaceholderResolver placeholderResolver) {
  Assert.notNull(value, "'value' must not be null");
  return parseStringValue(value, placeholderResolver, new HashSet < > ());
}

接下来查看这个 parseStringValue 方法,首先会判断当前的value值中是否包含一个 $ 的大括号,并且会递归的判断是否存在$ 的嵌套,判断完成之后,会对里面的值进行解析。


在获取完这个符之后,接着就是递归的循环遍历资源中的 k e y 值,将 < c o d e > 符之后,接着就是递归的循环遍历资源中的key值,将<code>符之后,接着就是递归的循环遍历资源中的key值,将<code>{USERNAME} 对应的值进行一个替换操作。

String propVal = placeholderResolver.resolvePlaceholder(placeholder);

再次跟着debug断点走,可以发现会进入 PropertySourcesPropertyResolver 类的 getProperty 方法里面


里面进行循环的取值,将${}里面的值和系统属性或者系统变量的值进行匹配,如果匹配成功,则进行替换的操作

@Nullable
protected < T > T getProperty(String key, Class < T > targetValueType, boolean resolveNestedPlaceholders) {
  if (this.propertySources != null) {
    for (PropertySource << ? > propertySource : this.propertySources) {
            //取值
      Object value = propertySource.getProperty(key);
      if (value != null) {
                //取值成功,则进行替换操作
        if (resolveNestedPlaceholders && value instanceof String) {
          value = resolveNestedPlaceholders((String) value);
        }
        logKeyFound(key, propertySource, value);
                //如果需要的换则进行值转换
        return convertValueIfNecessary(value, targetValueType);
      }
    }
  }
  return null;
}

接下来再进入转换的convertValueIfNecessary 方法,如果不需要转换则直接返回,需要转换则转换

@Nullable
protected < T > T convertValueIfNecessary(Object value, @Nullable Class < T > targetType) {
  if (targetType == null) {
    return (T) value;
  }
  ConversionService conversionServiceToUse = this.conversionService;
  if (conversionServiceToUse == null) {
    if (ClassUtils.isAssignableValue(targetType, value)) {
      return (T) value;
    }
    conversionServiceToUse = DefaultConversionService.getSharedInstance();
  }
    //转换
  return conversionServiceToUse.convert(value, targetType);
}

如已知刚刚获取到的系统环境变量中存在一个 USERNAME=‘PV’,那么假设xml的文件名为 spring-$ {USERNAME}.xml ,那么结果这个解析器进行解析之后,就会将这个${}里面的值进行一个替换操作,会将这个文件名变成 spring-PV.xml 文件。如果存在$的嵌套,那么就会递归的进行一个判断和替换操作, 最终会将解析后的文件返回。


自此为止,属性值就全部加载和解析完成。此时所有的配置文件路径等,都添加在重要的类AbstractRefreshableConfigApplicationContext的configLocations 的属性里面。

private String[] configLocations;

除了刚刚举例,还有像一些jdbc的连接参数等等,其原理都是一样的,都是通过这种方式替换

"${jdbc.url}")
"${jdbc.driverClassName}"
"${jdbc.username}"
"${jdbc.password}"

3,总结

也就是通过这个xml的方式作为配置文件,在调用refresh方法之前,主要就是做了两件事情:首先是初始化一个资源的解析器,随后是获取系统的属性和系统的环境变量,同时对配置文件的路径进行解析。至此为止,refresh需要准备的前戏工作结束。

目录
打赏
0
0
0
0
3684
分享
相关文章
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——基于 xml 的整合
本教程介绍了基于XML的MyBatis整合方式。首先在`application.yml`中配置XML路径,如`classpath:mapper/*.xml`,然后创建`UserMapper.xml`文件定义SQL映射,包括`resultMap`和查询语句。通过设置`namespace`关联Mapper接口,实现如`getUserByName`的方法。Controller层调用Service完成测试,访问`/getUserByName/{name}`即可返回用户信息。为简化Mapper扫描,推荐在Spring Boot启动类用`@MapperScan`注解指定包路径避免逐个添加`@Mapper`
130 0
微服务——SpringBoot使用归纳——Spring Boot使用slf4j进行日志记录—— logback.xml 配置文件解析
本文解析了 `logback.xml` 配置文件的详细内容,包括日志输出格式、存储路径、控制台输出及日志级别等关键配置。通过定义 `LOG_PATTERN` 和 `FILE_PATH`,设置日志格式与存储路径;利用 `&lt;appender&gt;` 节点配置控制台和文件输出,支持日志滚动策略(如文件大小限制和保存时长);最后通过 `&lt;logger&gt;` 和 `&lt;root&gt;` 定义日志级别与输出方式。此配置适用于精细化管理日志输出,满足不同场景需求。
474 1
智慧班牌源码,采用Java + Spring Boot后端框架,搭配Vue2前端技术,支持SaaS云部署
智慧班牌系统是一款基于信息化与物联网技术的校园管理工具,集成电子屏显示、人脸识别及数据交互功能,实现班级信息展示、智能考勤与家校互通。系统采用Java + Spring Boot后端框架,搭配Vue2前端技术,支持SaaS云部署与私有化定制。核心功能涵盖信息发布、考勤管理、教务处理及数据分析,助力校园文化建设与教学优化。其综合性和可扩展性有效打破数据孤岛,提升交互体验并降低管理成本,适用于日常教学、考试管理和应急场景,为智慧校园建设提供全面解决方案。
319 70
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——指定项目配置文件
在实际项目中,开发环境和生产环境的配置往往不同。为简化配置切换,可通过创建 `application-dev.yml` 和 `application-pro.yml` 分别管理开发与生产环境配置,如设置不同端口(8001/8002)。在 `application.yml` 中使用 `spring.profiles.active` 指定加载的配置文件,实现环境快速切换。本节还介绍了通过配置类读取参数的方法,适用于微服务场景,提升代码可维护性。课程源码可从 [Gitee](https://gitee.com/eson15/springboot_study) 下载。
116 0
SaaS云计算技术的智慧工地源码,基于Java+Spring Cloud框架开发
智慧工地源码基于微服务+Java+Spring Cloud +UniApp +MySql架构,利用传感器、监控摄像头、AI、大数据等技术,实现施工现场的实时监测、数据分析与智能决策。平台涵盖人员、车辆、视频监控、施工质量、设备、环境和能耗管理七大维度,提供可视化管理、智能化报警、移动智能办公及分布计算存储等功能,全面提升工地的安全性、效率和质量。
Spring Boot 配置文件总结
Spring Boot 提供全局配置文件 `application.properties` 和 `application.yml`,用于修改自动配置的默认值。前者使用键值对配置,后者使用缩进和冒号。不同环境(开发、测试、生产)可切换配置文件,通过 `spring.profiles.active` 指定。例如,开发环境端口为4790,测试环境为4791,生产环境为4792。配置示例展示了属性、List、Map定义及引用方法。
182 14
建筑施工一体化信息管理平台源码,支持微服务架构,采用Java、Spring Cloud、Vue等技术开发。
智慧工地云平台是专为建筑施工领域打造的一体化信息管理平台,利用大数据、云计算、物联网等技术,实现施工区域各系统数据汇总与可视化管理。平台涵盖人员、设备、物料、环境等关键因素的实时监控与数据分析,提供远程指挥、决策支持等功能,提升工作效率,促进产业信息化发展。系统由PC端、APP移动端及项目、监管、数据屏三大平台组成,支持微服务架构,采用Java、Spring Cloud、Vue等技术开发。
243 7
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
本文介绍了在使用Spring框架时,如何通过创建`applicationContext.xml`配置文件来管理对象。首先,在resources目录下新建XML配置文件,并通过IDEA自动生成部分配置。为完善配置,特别是添加AOP支持,可以通过IDEA的Live Templates功能自定义XML模板。具体步骤包括:连续按两次Shift搜索Live Templates,配置模板内容,输入特定前缀(如spring)并按Tab键即可快速生成完整的Spring配置文件。这样可以大大提高开发效率,减少重复工作。
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
Spring面试必问:手写Spring IoC 循环依赖底层源码剖析
在Spring框架中,IoC(Inversion of Control,控制反转)是一个核心概念,它允许容器管理对象的生命周期和依赖关系。然而,在实际应用中,我们可能会遇到对象间的循环依赖问题。本文将深入探讨Spring如何解决IoC中的循环依赖问题,并通过手写源码的方式,让你对其底层原理有一个全新的认识。
174 2
Android自定义View之不得不知道的文件attrs.xml(自定义属性)
本文详细介绍了如何通过自定义 `attrs.xml` 文件实现 Android 自定义 View 的属性配置。以一个包含 TextView 和 ImageView 的 DemoView 为例,讲解了如何使用自定义属性动态改变文字内容和控制图片显示隐藏。同时,通过设置布尔值和点击事件,实现了图片状态的切换功能。代码中展示了如何在构造函数中解析自定义属性,并通过方法 `setSetting0n` 和 `setbackeguang` 实现功能逻辑的优化与封装。此示例帮助开发者更好地理解自定义 View 的开发流程与 attrs.xml 的实际应用。
Android自定义View之不得不知道的文件attrs.xml(自定义属性)
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等

登录插画

登录以查看您的控制台资源

管理云资源
状态一览
快捷访问