SpringBoot启动如何加载application.yml配置文件

一、前言

在spring时代配置文件的加载都是通过web.xml配置加载的(Servlet3.0之前),可能配置方式有所不同,但是大多数都是通过指定路径的文件名的形式去告诉spring该加载哪个文件;

<context-param>
  <param-name>contextConfigLocation</param-name>
  <param-value>/WEB-INF/application*.xml</param-value>
</context-param>

而到了springboot时代,我们发现原来熟悉的web.xml已不复存在,但是springboot却依然可以找到默认的配置文件(application.yml),那它是如何实现的呢?今天我们就一起来探究一下springboot自动加载配置文件的机制!

看完本篇文章你将了解到:

  1. springboot什么时候加载配置文件
  2. springboot通过哪个类加载配置文件
  3. springboot自动加载配置文件流程
  4. 激活文件优先级
  5. 文件加载路径优先级
  6. 文件后缀优先级

二、提出猜想

我们知道在使用springboot中我们只要在resources下面新建一个application.yml文件他就会自动加载,那是不是springboot默认在哪里配置了这个路径和文件名?

三、验证猜想

为了证实我们的猜想,我们可以通过查看springboot项目源码,跟着debug一步一步走;
这里我使用的是springboot2.0版本,2.0与1.5版本比较启动的大体流程是一样的,只不过在一些实现中有所差异;

1.启动流程

要知道springboot如何加载配置文件,就需要了解它的启动流程:

我们从main方法进入,大概的调用流程如下:

DemoApplication.main->SpringApplication.run->new SpringApplication().run

在这里插入图片描述
其实启动的主要过程都在new SpringApplication().run();

  • new SpringApplication():创建SpringApplication实例,负责加载配置一些基本的环境变量、资源、构造器、监听器
  • run():负责springboot整个启动过程,包括加载创建环境、打印banner、配置文件、配置应用上下文,加载bean等等sb整个生命周期几乎都在run方法中;

今天我们的主题是sb如何加载配置文件,所以着重讲解加载配置文件和之前的操作原理和源码,其他的功能以后有机会再和大家一起研究,下面我们来看看new SpringApplication()做了什么操作;

2.创建SpringApplication实例

/**
 * 创建一个SpringApplication实体,应用程序上下文将从指定的主源文档加载bean以获取详细信息,
 * 这个实例可以在调用之前自定义
 * @param resourceLoader
 * @param primarySources
 */
@SuppressWarnings({ "unchecked", "rawtypes" })
public SpringApplication(ResourceLoader resourceLoader, Class<?>... primarySources) {
	//使用的资源加载器
	this.resourceLoader = resourceLoader;
	//主要的bean资源 primarySources【在这里是启动类所在的.class】,不能为null,如果为null,抛异常
	Assert.notNull(primarySources, "PrimarySources must not be null");
	//启动类的实例数组转化成list,放在LinkedHashSet集合中
	this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources));
	/**
	 * 创建应用类型,不同应用程序类型,创建不同的环境
	 * springboot1.5 只有两种类型:web环境和非web环境
	 * springboot2.0 有三种应用类型:WebApplicationType
	 * NONE:不需要再web容器的环境下运行,也就是普通的工程
	 * SERVLET:基于servlet的Web项目
	 * REACTIVE:响应式web应用reactive web Spring5版本的新特性
	 */
	this.webApplicationType = WebApplicationType.deduceFromClasspath();
	/**
	 * 每一个initailizer都是一个实现了ApplicationContextInitializer接口的实例。
	 * ApplicationContextInitializer是Spring IOC容器中提供的一个接口: void initialize(C applicationContext);
	 * 这个方法它会在ConfigurableApplicationContext的refresh()方法调用之前被调用(prepareContext方法中调用),
	 * 做一些容器的初始化工作。
	 */
	setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));
	/**
	 * Springboot整个生命周期在完成一个阶段的时候都会通过事件推送器(EventPublishingRunListener)产生一个事件(ApplicationEvent),
	 * 然后再遍历每个监听器(ApplicationListener)以匹配事件对象,这是一种典型的观察者设计模式的实现
	 * 具体事件推送原理请看:sb事件推送机制图
	 */
	setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
	// 指定main函数启动所在的类,即启动类BootApplication.class
	this.mainApplicationClass = deduceMainApplicationClass();
}

我们来大概的看下ApplicationListener的一些实现类以及他们具体的功能简介
在这里插入图片描述

这些监听器的实现类都是在spring.factories文件中配置好的,代码中通过getSpringFactoriesInstances方法获取,这种机制叫做SPI机制:通过本地的注册发现获取到具体的实现类,轻松可插拔。
在这里插入图片描述
SpringBoot默认情况下提供了两个spring.factories文件,分别是:

spring-boot-2.0.2.RELEASE.jar
spring-boot-autoconfigure-2.0.2.RELEASE.jar
在这里插入图片描述

概括来说在创建SpringApplication实例的时候,sb会加载一些初始化和启动的参数与类,如同跑步比赛时的等待发令枪的阶段;

3.run方法

(1)、事件推送原理

SB启动过程中分多个阶段或者说是多个步骤,每完成一步就会产生一个事件,并调用对应事件的监听器,这是一种标准的观察者模式,这在启动的过程中有很好的扩展性,下面我们来看看sb的事件推送原理:
SpringBoot事件推送原理图:
在这里插入图片描述

(2)、run方法整体流程简述

/**
 * 运行应用程序,创建并刷新一个新的应用程序上下文
 *
 * @param args
 * @return
 */
public ConfigurableApplicationContext run(String... args) {
	/**
	 *  StopWatch: 简单的秒表,允许定时的一些任务,公开每个指定任务的总运行时间和运行时间。
	 *  这个对象的设计不是线程安全的,没有使用同步。SpringApplication是在单线程环境下,使用安全。
	 */
	StopWatch stopWatch = new StopWatch();
	// 设置当前启动的时间为系统时间startTimeMillis = System.currentTimeMillis();
	stopWatch.start();
	// 创建一个应用上下文引用
	ConfigurableApplicationContext context = null;
	// 异常收集,报告启动异常
	Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList<>();
	/**
	 * 系统设置headless模式(一种缺乏显示设备、键盘或鼠标的环境下,比如服务器),
	 * 通过属性:java.awt.headless=true控制
	 */
	configureHeadlessProperty();
	/*
	 * 获取事件推送监器,负责产生事件,并调用支某类持事件的监听器
	 * 事件推送原理看上面的事件推送原理图
	 */
	SpringApplicationRunListeners listeners = getRunListeners(args);
	/**
	 * 发布一个启动事件(ApplicationStartingEvent),通过上述方法调用支持此事件的监听器
	 */
	listeners.starting();
	try {
		// 提供对用于运行SpringApplication的参数的访问。取默认实现
		ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
		/**
		 * 构建容器环境,这里加载配置文件
		 */
		ConfigurableEnvironment environment = prepareEnvironment(listeners, applicationArguments);
		// 对环境中一些bean忽略配置
		configureIgnoreBeanInfo(environment);
		// 日志控制台打印设置
		Banner printedBanner = printBanner(environment);
		// 创建容器
		context = createApplicationContext();
		exceptionReporters = getSpringFactoriesInstances(SpringBootExceptionReporter.class, new Class[] { ConfigurableApplicationContext.class }, context);
		/**
		 * 准备应用程序上下文
		 * 追踪源码prepareContext()进去我们可以发现容器准备阶段做了下面的事情:
		 * 容器设置配置环境,并且监听容器,初始化容器,记录启动日志,
		 * 将给定的singleton对象添加到此工厂的singleton缓存中。
		 * 将bean加载到应用程序上下文中。
		 */
		prepareContext(context, environment, listeners, applicationArguments, printedBanner);
		/**
		 * 刷新上下文
		 * 1、同步刷新,对上下文的bean工厂包括子类的刷新准备使用,初始化此上下文的消息源,注册拦截bean的处理器,检查侦听器bean并注册它们,实例化所有剩余的(非延迟-init)单例。
		 * 2、异步开启一个同步线程去时时监控容器是否被关闭,当关闭此应用程序上下文,销毁其bean工厂中的所有bean。
		 * 。。。底层调refresh方法代码量较多
		 */
		refreshContext(context);
		afterRefresh(context, applicationArguments);
		// stopwatch 的作用就是记录启动消耗的时间,和开始启动的时间等信息记录下来
		stopWatch.stop();
		if (this.logStartupInfo) {
			new StartupInfoLogger(this.mainApplicationClass).logStarted(getApplicationLog(), stopWatch);
		}
		// 发布一个已启动的事件
		listeners.started(context);
		callRunners(context, applicationArguments);
	}
	catch (Throwable ex) {
		handleRunFailure(context, ex, exceptionReporters, listeners);
		throw new IllegalStateException(ex);
	}
	try {
		// 发布一个运行中的事件
		listeners.running(context);
	}
	catch (Throwable ex) {
		// 启动异常,里面会发布一个失败的事件
		handleRunFailure(context, ex, exceptionReporters, null);
		throw new IllegalStateException(ex);
	}
	return context;
}

(3)、构建容器环境

在:run方法中的ConfigurableEnvironment environment = prepareEnvironment(listeners, applicationArguments);是准备环境,里面会加载配置文件;

private ConfigurableEnvironment prepareEnvironment(SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments) {
	// 创建一个配置环境,根据前面定义的应用类型定义不同的环境
	ConfigurableEnvironment environment = getOrCreateEnvironment();
	// 将配置参数设置到配置环境中
	configureEnvironment(environment, applicationArguments.getSourceArgs());
	/**
	 * 发布一个环境装载成功的事件,并调用支持此事件的监听器
	 * 这其中就有我们今天的主角:配置文件加载监听器(ConfigFileApplicationListener)
	 */
	listeners.environmentPrepared(environment);
	// 将配置环境绑定到应用程序
	bindToSpringApplication(environment);
	if (!this.isCustomEnvironment) {
		environment = new EnvironmentConverter(getClassLoader())
				.convertEnvironmentIfNecessary(environment, deduceEnvironmentClass());
	}
	ConfigurationPropertySources.attach(environment);
	return environment;
}

(4)、ConfigFileApplicationListener类介绍

sb就是通过ConfigFileApplicationListener 这个类来加载配置文件的,这个类同样是一个监听器,我们来看看他的继承类图:
在这里插入图片描述

再让我们来看看这个类具体都有哪些方法:
在这里插入图片描述

最后我们来看看这个类有哪些需要注意的字段:
在这里插入图片描述

(5)、ConfigFileApplicationListener类加载配置文件

我们从ConfigFileApplicationListener.onApplicationEvent开始,一直往下看方法链,发现最后是load方法去具体怎么加载配置文件的
在这里插入图片描述

在这里插入图片描述

激活配置文件与默认配置文件的优先级:
我们在使用中经常会根据不同的环境根据spring.profiles.active属性来定义不同的配置文件:

  • application-dev.properties
  • application-test.properties
  • application-prod.properties

但同时我们会创建一个默认的配置文件:application.properties,那自定义环境的配置文件与默认的配置文件的优先级是哪个高呢?
在这里插入图片描述
看图片我们可知他们加载的先后顺序(注意:后加载会覆盖前加载的文件):

  • application-xxx.properties
  • application.properties

配置文件路径的优先级:
我们从属性:DEFAULT_SEARCH_LOCATIONS = "classpath:/,classpath:/config/,file:./,file:./config/可以看出文件路径的先后顺序(注意:后加载的会覆盖先加载的):

  • classpath:/
  • classpath:/config/
  • file:./
  • file:./config/

配置文件的优先级:
我们从这个类中的字段:propertySourceLoaders可以看出有两个Loader,请各位看官看图:
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

我们从上面两张图中可以看出,每个Loader会加载两种后缀名的文件,加起来就是4种,又因为是数组类型,所以也会有先后顺序,所以加载配置文件的先后顺序就是(后加载覆盖先加载的):

  • properties
  • xml
  • yml
  • yaml

最后查找的具体路径:location + name + "-" + profile + "." + ext

这里我们介绍了三种优先级:

  1. active与默认优先级
  2. 文件路径优先级
  3. 文件后缀优先级
    未完待续。。。

四、提问

springboot学习遗留问题,
1.active和默认的谁覆盖谁
2.flter区别
3.多个配置文件如何覆盖

©️2020 CSDN 皮肤主题: 技术工厂 设计师:CSDN官方博客 返回首页