Spring源码学习笔记(二)、prepareRefresh

一、方法功能概述

// Prepare this context for refreshing.
// 准备刷新
prepareRefresh();

该方法就想它的名字一样，在正式的刷新之前做一些准备工作，主要包含如下的操作：

• 记录开始时间

• 设置closed、active标识

• 记录日志

• 初始化属性资源

• 创建环境对象

• 校验必要的属性

• 初始化earlyApplicationEvents

二、整体代码展示

//AbstractApplicationContext
/**
 * Prepare this context for refreshing, setting its startup date and
 * active flag as well as performing any initialization of property sources.
 *
 * 准备此上下文以进行刷新，设置其启动日期和活动标志以及执行属性源的任何初始化
 */
protected void prepareRefresh() {
    //记录开始时间
    this.startupDate = System.currentTimeMillis();
    //设置关闭标识为false
    this.closed.set(false);
    //设置活跃标识为true
    this.active.set(true);

    //记录日志
    if (logger.isDebugEnabled()) {
        if (logger.isTraceEnabled()) {
            logger.trace("Refreshing " + this);
        }
        else {
            logger.debug("Refreshing " + getDisplayName());
        }
    }

    //初始化属性资源,空方法,留给子类实现,可以获取环境对象,放置一些属性
    initPropertySources();

    //创建并获取环境对象,验证需要的属性文件是否都已经放入环境中
    getEnvironment().validateRequiredProperties();

    //创建刷新前的监听事件集合
    this.earlyApplicationEvents = new LinkedHashSet<>();
}

三、详细代码解读、getEnvironment

这个是获取环境的方法，我们点进去看下

//AbstractApplicationContext
@Override
public ConfigurableEnvironment getEnvironment() {
    if (this.environment == null) {
        this.environment = createEnvironment();
    }
    return this.environment;
}

可以看到其实就是创建一个StandardEnvironment环境对象，继续点击createEnvironment进去

//AbstractApplicationContext
protected ConfigurableEnvironment createEnvironment() {
    return new StandardEnvironment();
}

这边看起来很简单，就是new一个StandardEnvironment对象，但其实StandardEnvironment还有父类对象AbstractEnvironment，实例化子类对象，会先实例化父类对象，所以我们看下父类AbstractEnvironment的构造方法

//AbstractEnvironment
public AbstractEnvironment() {
    customizePropertySources(this.propertySources);
}

我们看到构造方法中调用了customizePropertySources方法，再点进去看

//AbstractEnvironment
protected void customizePropertySources(MutablePropertySources propertySources) {}

这个方法叫定制化属性资源，我们发现这个方法是抽象方法，具体实现又回到了子类StandardEnvironment里，点进去看下

//AbstractEnvironment
@Override
protected void customizePropertySources(MutablePropertySources propertySources) {
    propertySources.addLast(new MapPropertySource(SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME, getSystemProperties()));
    propertySources.addLast(new SystemEnvironmentPropertySource(SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, getSystemEnvironment()));
}

其中的getSystemProperties方法和getSystemEnvironment方法的具体实现又回到了父类AbstractEnvironment中，具体实现其实就是调用的System.getProperties()和System.getenv()，获取系统的一些属性和环境信息

四、详细代码解读、validateRequiredProperties

检查某些必要的环境配置是否存在，不存在就抛出异常，我们点进去看下

@Override
public void validateRequiredProperties() throws MissingRequiredPropertiesException {
    this.propertyResolver.validateRequiredProperties();
}

继续跟踪validateRequiredProperties(),发现其实现在AbstractPropertyResolver类中

//AbstractPropertyResolver
@Override
public void validateRequiredProperties() {
    //创建缺失必要属性异常的异常类
    MissingRequiredPropertiesException ex = new MissingRequiredPropertiesException();
    for (String key : this.requiredProperties) {
        //如果在setConfigLocations(configLocations)这一步中放入的变量没有必要的属性
        //就添加到ex异常中
        if (this.getProperty(key) == null) {
            ex.addMissingRequiredProperty(key);
        }
    }
    //如果异常的missingRequiredProperties集合不为空,就证明有必要属性不存在,就抛出这个异常
    if (!ex.getMissingRequiredProperties().isEmpty()) {
        throw ex;
    }
}

看完这里，好像觉得没什么卵用，因为是个空的集合，对吧？仔细想想，如果你在集合中添加了必要的属性呢？那是不是就可以检验了。再想想之前initPropertySources空构造，那么，如果我们实现AbstractApplicationContext，然后再重写initPropertySources，再给requiredProperties设置必要属性呢？