运行源码分析：初始化ApplicationArguments

监 听 器 启 动 之 后 &＃xff0c; 紧接着便是执行ApplicationArguments对象的初始化 &＃xff0c;Application-Arguments 是用于提供访问运行 SpringApplication 时的参数。

ApplicationArguments 的 初 始 化 过 程 非 常 简 单 &＃xff0c; 只 是 调 用 了 它 的 实 现 类
Default-ApplicationArguments 并传入 main 方法中的 args 参数。

ApplicationArguments applicationArguments &＃61; new DefaultApplicationArguments(args);

在
DefaultApplicationArguments 中将参数 args 封装为 Source 对象&＃xff0c;Source 对象是基于Spring 框架的 SimpleCommandLinePropertySource 来实现的。

我们对该接口在此不进行拓展&＃xff0c;只需知道通过 main 方法传递进来的参数被封装成ApplicationArguments 对象即可。关于该接口实例化的步骤我会在后续关于 Spring Boot 的参数的章节中进行详细讲解&＃xff0c;因此在图 4-1 所示的核心流程图中也没有体现出来。

完成 ApplicationArguments 参数的准备之后&＃xff0c;便开始通过 prepareEnvironment 方法对ConfigurableEnvironment 对象进行初始化操作。

ConfigurableEnvironment接口继承自Environment接口和
ConfigurablePropertyResolver&＃xff0c;最终都继承自接口 PropertyResolver。

ConfigurableEnvironment 接口的主要作用是提供当前运行环境的公开接口&＃xff0c;比如配置文件profiles 各类系统属性和变量的设置、添加、读取、合并等功能。

通过 ConfigurableEnvironment 接口中方法定义&＃xff0c;可以更清楚地了解它的功能&＃xff0c;代码如下。

public interface ConfigurableEnvironment extends Environment, Configurable-
PropertyResolver{
设置激活的组集合
void setActiveProfiles(String. .. profiles);
向当前激活的组集合中添加一个 profile 组
void addActiveProfile(String profile);
设置默认激活的组集合。激活的组集合为空时会使用默认的组集合
void setDefaultProfiles(String... profiles);
//获取当前环境对象中的属性源集合&＃xff0c;也就 是应用环境变量
//属性源集合其实就是
滚动鼠标轴或单击&＃xff0c;开始截长图
//该方法提供了直接配置属性源的
MutablePropertySources getPropertySources();
//获取虚拟机环境变量&＃xff0c;该方法提供 J 直接配置虚拟机环境变量的入口
Map getSystemProperties();
//获取操作系统环境变量
//该方法提供了直接配置系统环境变量的入口
Map getSystemEnvironment();
合并指定环境中的配置到当前环境中
void merge (ConfigurableEnvironment parent);
}

通过接口提供的方法&＃xff0c;我们可以看出 ConfigurableEnvironment 就是围绕着这个“环境”来提供相应的功能&＃xff0c;这也是为什么我们也将它称作“环境”。

了解了 ConfigurableEnvironment 的功能及方法&＃xff0c;我们回归到 SpringApplication 的流程看相关源代码。run 方 法中调用 prepareEnvironment 方法相关代码如下。

public ConfigurableApplicationContext run(String... args) {
//加载属性配置&＃xff0c;包括所有的配 置属性(如: application. properties 中和外部的属性
配置)
ConfigurableEnvironment environment &＃61; prepareEnvironment( listeners,
applicationArgum
ents);}

prepareEnvironment 方法的源代码实现如下。

private ConfigurableEnvironment prepareEnvironment(
SpringApplicationRunListeners listeners, ApplicationArguments application
Arguments) {
//获取或创建环境
ConfigurableEnvironment environment &＃61; getOrCreateEnvironment();
//配置环境&＃xff0c; 主要包括 PropertySources lactiveProfiles 的配置
configureEnvironment (environment, applicationArguments . getSourceArgs());
//将 ConfigurationPropertySources 附加到指定环境中的第一位&＃xff0c; 并动态跟踪环境的添加
或删除ConfigurationPropertySources . attach( environment);
// listener 环境准备(之前章节已经提到)
listeners. environmentPrepared environment);
//将环境绑定到 SpringApplication
bindToSpringApplication( environment);
//判断是否定制的环境&＃xff0c;如果不是定制的则将环境转换为 StandardEnvironment
if (!this. isCustomEnvironment) {
environment &＃61; new EnvironmentConverter(getClassLoader())
. convertEnvironmentIfNecess ary(environment, deduceEnvironment -
Class());
//将 ConfigurationPropertySources 附加到指定环境中的第一位&＃xff0c; 并动态跟踪环境的添加
或删除
ConfigurationPropertySources . attach( environment);
return environment;
}

通过以上代码及注解可知&＃xff0c;prepareEnvironment 进行 了以下的操作。

.获取或创建环境。

.配置环境。

:ConfigurationPropertySources 附加到指定环境:将 ConfigurationPropertySources 附加到指定环境中的第一位&＃xff0c;并动态跟踪环境的添加或删除(当 前版本新增了该行代码&＃xff0c;与最后一步操作相同)。

.设置 listener 监听事件:前面章节已经讲过&＃xff0c;此处主要针对准备环境的监听。

.绑定环境到 SpringApplication:将环境绑定到 name 为“spring.main”的目标上。

.转换环境:判断是否是定制的环境&＃xff0c;如果不是定制的&＃xff0c;则将环境转换为Standard-Environment。此时判断条件 isCustomEnvironment 默认为 false,在后面的操作中会将其设置为 true,如果为 true 则不再会进行此转换操作。

:ConfigurationPropertySources 附加到指定环境:将 ConfigurationPropertySources 附加到指定环境中的第一位&＃xff0c;并动态跟踪环境的添加或删除操作。

下面针对以上步骤挑选部分代码进行相应的讲解。

获取或创建环境

SpringApplication 类中通过 getOrCreateEnvironment 方法来获取或创建环境。在该方法中首先判断环境是否为 null&＃xff0c;如果不为 null 则直接返回;如果为 null,则根据前面推断出来的WebApplicationType 类型来创建指定的环境&＃xff0c;代码如下。

private Conf igurableEnvironment getOrCreateEnvironment() {
if (this. environment !&＃61; null) {return this . environment;
//根据不同的应用类型&＃xff0c; 创建不同的环境实现
switch (this . webApplicationType) {
case SERVLET:
return new StandardServletEnvironment();
case REACTIVE:
return new StandardReactiveWebEnvironment();
default:
return new StandardEnvironment();}

. 上面方法中如果 environment 存在&＃xff0c; 则直接返回;如果 environment 不存在&＃xff0c;则根据前面步骤中推断获得的 WebApplicationType 来进行区分创建环境。如果是 SERVLET 项目则创建标准的 Servlet 环境
StandardServletEnvironment;

如果是 REACTIVE 项目则创建
StandardReactiveWebEnvironment;其他情况则创建标准的非 Web 的 StandardEnvironment。

配置环境

在获得环境变量对象之后&＃xff0c;开始对环境变量和参数进行相应的设置&＃xff0c;主要包括转换服务的设置、PropertySources 的设置和 activeProfiles 的设置。

SpringApplication 类中相关 configureEnvironment 方法代码如下。

protected void configureEnvironment (ConfigurableEnvironment environment,
String[] args) {
//如果为 true 则获取并设置转换服务
f (this. addConversionService) {
ConversionService conversionService &＃61; ApplicationConversionService
. getSharedInstance();
environment . setConversionService( (ConfigurableConvers ionService) conversion-
Service);
//配置 PropertySources
configurePropertySources( environment, args);
//配置 Profiles
configureProfiles(environment, args);}

在以上代码中&＃xff0c;首先判断 addConversionService 变量是否为 true, 也就是判断是否需要添加转换服务&＃xff0c;如果需要&＃xff0c;则获取转换服务实例&＃xff0c;并对环境设置转换服务。随后进行PropertySources 和 Profiles 的配置。

其中 configurePropertySources 方法对 PropertySources 进行配置&＃xff0c;代码如下。

protected void configurePropertySources (ConfigurableEnvironment environmenString[] args) {
//获得环境中的属性资源信息
MutablePropertySources sources &＃61; environment . getPropertySources();
// 如果默认属性配置存在则将其放置于属性资源的最后位置
if (this . defaultProperties !&＃61; null && !this . defaultProperties . isEmpty())
sources . addLast (new MapPropertySource(" defaultProperties", this . default
Properties));
// 如果命令行属性存在
if (this . addCommandL ineProperties && args . length > 0) {
String name &＃61; CommandL inePropertySource . COMMAND_ LINE_ PROPERTY_
_SOURCE_ NAME;
//如果默认属性资源中不包含该命令&＃xff0c; 则将命令行属性放置在第一 位&＃xff0c;如果包含&＃xff0c;则通过
Composite-PropertySource 进行处理
if (sources . contains(name)) {
PropertySource source &＃61; sources.get(name);
CompositePropertySource composite &＃61; new CompositePropertySource(nam
e);
composite . addPropertySource (new SimpleCommandLinePropertySource(
"springApplicationCommandLineArgs", args));
composite . addPropertySource(source);
sources . replace(name, composite);
t else
//放置在第一位
sources . addFirst(new SimpleCommandL inePropertySource(args));
}
}
}

这段代码需要重点看一下参数的优先级处理和默认参数 与命令参数之间的关系。首先&＃xff0c;如果存在默认属性配置&＃xff0c;则将默认属性配置放置在最后&＃xff0c;也就是说优先级最低。然后&＃xff0c;如果命令参数存在则会 出现两种情况:如果命令的参数 已经存在于属性配置中&＃xff0c;则使用CompositePropertySource 类进行相同 name 的参数处理;如果命令的参数并不存在于属性配置中&＃xff0c;则直接将其设置为优先级最高。

ConfigurePropertySources 方法的官方注释也很好地解释了它的功能:增加、移除或重新排序应用环境中的任何 PropertySource。

完成了 PropertySources 配置&＃xff0c;随后通过 configureProfiles 方法来完成 Profiles 的配置&＃xff0c;代码如下。

protected void configureProfiles (ConfigurableEnvironment environment, Strin
g[] args)
// 保 证 环 境 的 activeProfiles 属 性 被 初 始 化 &＃xff0c; 如 果 未 初 始 化 该 方 法 会 对 其 初 始 化
environment . getActiveProfiles();
//如果存在的额外的 Profiles,则将其放置在第- -位&＃xff0c; 随后再获得其他的 ProfilesSet
profiles &＃61; new LinkedHashSet<>(this . additionalProfiles);
profiles . addAll(Arrays. asList(environment . getActiveProfiles()));
environment . setActiveProfiles(StringUtils . toStringArray(profiles));
}

上面的代码主要用来处理应用环境中哪些配置文件处于激活状态或默认激活状态。对应的配置正是我们经常使用的用来区分不同环境的 spring.profiles.active 参数指定的值。

1. 下篇文章给大家讲解的是忽略信息配置、打印Banner、Spring应用上下文的创建&＃xff1b;
2. 觉得文章不错的朋友可以转发此文关注小编&＃xff1b;
3. 感谢大家的支持&＃xff01;