Spring源码-AbstractRefreshableConfigApplicationContext-源码解读

/**
 * {@link AbstractRefreshableApplicationContext} subclass that adds common handling	｜AbstractRefreshableApplicationContext 的子类
 * of specified config locations. Serves as base class for XML-based application	添加了对指定配置位置的公共处理。
 * context implementations such as {@link ClassPathXmlApplicationContext} and		用作基于 xml 为基础的 application context 所实现
 * {@link FileSystemXmlApplicationContext}, as well as								例如 ClassPathXmlApplicationContext，FileSystemXmlApplicationContext，XmlWebApplicationContext
 * {@link org.springframework.web.context.support.XmlWebApplicationContext}.
 *
 * @author Juergen Hoeller
 * @since 2.5.2
 * @see #setConfigLocation
 * @see #setConfigLocations
 * @see #getDefaultConfigLocations
 */
public abstract class AbstractRefreshableConfigApplicationContext extends AbstractRefreshableApplicationContext
		implements BeanNameAware, InitializingBean {

	@Nullable
	private String[] configLocations;

	private boolean setIdCalled = false;


	/**
	 * Create a new AbstractRefreshableConfigApplicationContext with no parent.
	 */
	public AbstractRefreshableConfigApplicationContext() {
	}

	/**
	 * Create a new AbstractRefreshableConfigApplicationContext with the given parent context.
	 * @param parent the parent context
	 */
	public AbstractRefreshableConfigApplicationContext(@Nullable ApplicationContext parent) {
		super(parent);
	}


	/**
	 * Set the config locations for this application context in init-param style,	以初始化参数的风格为这个 application context 设置配置位置
	 * i.e. with distinct locations separated by commas, semicolons or whitespace.	凭借逗号，分号或空白分隔代表不同的配置，
	 * <p>If not set, the implementation may use a default as appropriate.			如果没有设置，这个实现可以使用默认值
	 */
	public void setConfigLocation(String location) {
		setConfigLocations(StringUtils.tokenizeToStringArray(location, CONFIG_LOCATION_DELIMITERS));
	}

	/**
	 * Set the config locations for this application context.				为这个 application context 设置配置位置
	 * <p>If not set, the implementation may use a default as appropriate.
	 */
	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;
		}
	}

	/**
	 * Return an array of resource locations, referring to the XML bean definition	返回资源位置的数组，引用构建这个 context 伴随着的 xml bean definition 文件
	 * files that this context should be built with. Can also include location		也可以包含位置路径，它将通过 ResourcePatternResolver 被解析
	 * patterns, which will get resolved via a ResourcePatternResolver.
	 * <p>The default implementation returns {@code null}. Subclasses can override	默认的实现将返回 null，子类能够重写，以提供一组用于加载 bean definitions 的资源位置
	 * this to provide a set of resource locations to load bean definitions from.
	 * @return an array of resource locations, or {@code null} if none
	 * @see #getResources
	 * @see #getResourcePatternResolver
	 */
	@Nullable
	protected String[] getConfigLocations() {
		return (this.configLocations != null ? this.configLocations : getDefaultConfigLocations());
	}

	/**
	 * Return the default config locations to use, for the case where no
	 * explicit config locations have been specified.
	 * <p>The default implementation returns {@code null},
	 * requiring explicit config locations.
	 * @return an array of default config locations, if any
	 * @see #setConfigLocations
	 */
	@Nullable
	protected String[] getDefaultConfigLocations() {
		return null;
	}

	/**
	 * Resolve the given path, replacing placeholders with corresponding		解析给定的路径，必要时用相应的环境属性值去替换占位符
	 * environment property values if necessary. Applied to config locations.	请求配置路径
	 * @param path the original file path
	 * @return the resolved file path
	 * @see org.springframework.core.env.Environment#resolveRequiredPlaceholders(String)
	 */
	protected String resolvePath(String path) {
		return getEnvironment().resolveRequiredPlaceholders(path);
	}


	@Override
	public void setId(String id) {
		super.setId(id);
		this.setIdCalled = true;
	}

	/**
	 * Sets the id of this context to the bean name by default,			对于将这个 context 本身定义为 bean 的情况，默认情况下将 context 的 id 设置为 bean name
	 * for cases where the context instance is itself defined as a bean.
	 */
	@Override
	public void setBeanName(String name) {
		if (!this.setIdCalled) {
			super.setId(name);
			setDisplayName("ApplicationContext '" + name + "'");
		}
	}

	/**
	 * Triggers {@link #refresh()} if not refreshed in the concrete context's
	 * constructor already.												如果尚未在具体的 context 构造函数中刷新，将触发 refresh()
	 */
	@Override
	public void afterPropertiesSet() {
		if (!isActive()) {
			refresh();
		}
	}

}

重要方法

方法名	描述
public void setConfigLocation(String location)	设置配置路径