教你如何阅读Spring源码

本篇文章仅介绍如何阅读Spring源码，想深入了解Spring源码的同学可查找其它资料。

准备

调试代码+Spring包+jdk1.8，见资源。

开始

了解Bean生命周期的同学可以在阅读源码时进行对比。

Bean生命周期：

         1、初始化Bean，这里仅指通过构造器完成初始化阶段，目前还没有进行依赖注入操作

         2、属性注入

         3、是否实现Aware（感知的）接口，用于感知容器信息（Bean的Id、上下文等）

         4、是否存在Bean实现BeanPostProcessor接口（存在则先初始化该Bean）,若存在则执行前置处理器

         5、是否设置init-method，存在则执行

         6、是否存在Bean实现BeanPostProcessor接口，若存在则执行后置处理器

         7、当Bean不再需要时，会经过清理阶段（DisposableBean接口、destroy-method方法）

首先从ClassPathXmlApplicationContext的构造函数说起

public class ClassPathXmlApplicationContext extends AbstractXmlApplicationContext {

	
	public ClassPathXmlApplicationContext(String... configLocations) throws BeansException {
		this(configLocations, true, null);
	}

	
	public ClassPathXmlApplicationContext(
			String[] configLocations, boolean refresh, @Nullable ApplicationContext parent)
			throws BeansException {

		super(parent);//配置成父子关系
		//根据提供的路径，处理成配置文件数组(以分号、逗号、空格、tab、换行符分割)
		setConfigLocations(configLocations);
		if (refresh) {
			refresh();// 核心方法
		}
	}

}

接下来就是refresh()，简单说一下refresh（），其使用模板模式实现，可通过调用该方法重建，上代码：

@Override
public void refresh() throws BeansException, IllegalStateException {
	//加锁，避免同时刷
	synchronized (this.startupShutdownMonitor) {
		// 准备工作，记录容器启动时间、标记启动状态
		prepareRefresh();

		// 解析配置信息封装成BeanDefinition，并注册到BeanFactory中(核心是一个 beanName-> beanDefinition 的 map)
		// 通俗说就是将applicationContext.xml配置文件中的解析成BeanDefinition（注解、配置类一样）
		ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();

		// 设置BeanFactory的类加载器，并添加几个BeanPostProcession（核心是一个列表）
		prepareBeanFactory(beanFactory);

		try {
			// 到目前为止Bean还没有初始化
			//这一步主要是注册一些特殊类BeanFactoryPostProcessor
			//BeanFactoryPostProcessor主要作用：可以对BeanDefinition进行修改，可以参考资源中SpringBeanFactoryPostProcessor类
			postProcessBeanFactory(beanFactory);

			// 调用BeanFactoryPostProcessor各个实现类的postProcessBeanFactory(factory)方法
			invokeBeanFactoryPostProcessors(beanFactory);

			// 注册BeanPostProcession的实现类（初始化BeanPostProcession接口对象），可参考资源中SpringBeanPostProcessor类
			registerBeanPostProcessors(beanFactory);

			// 国际化，比如：中英文的切换
			initMessageSource();

			// 初始化事件
			initApplicationEventMulticaster();

			// 初始化特殊的子类
			onRefresh();

			// 注册事件监听器，将监听器绑定到事件上，观察者模式
			registerListeners();

			// 核心方法
			//初始化所有的 singleton beans，（lazy-init 的除外）
			finishBeanFactoryInitialization(beanFactory);

			// 执行事件
			finishRefresh();
		}

		catch (BeansException ex) {
			if (logger.isWarnEnabled()) {
				logger.warn("Exception encountered during context initialization - " +
						"cancelling refresh attempt: " + ex);
			}

			// 销毁已经初始化过的singleton bean
			destroyBeans();

			// 标记启动状态false
			cancelRefresh(ex);

			// Propagate exception to caller.
			throw ex;
		}

		finally {
			// Reset common introspection caches in Spring's core, since we
			// might not ever need metadata for singleton beans anymore...
			resetCommonCaches();
		}
	}
}

下面，我们开始一步步来解析这个 refresh() 方法

prepareRefresh()

该过程主要用来记录容器的启动时间、标记启动状态等，不展开详述了。

obtainFreshBeanFactory()

该方法是核心方法之一，该过程主要用来解析配置信息为BeanDefinition，并注册到BeanFactory中

protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {
	// 关闭旧的 BeanFactory (如果有)，创建新的 BeanFactory，
	// 加载 BeanDefinition、注册 BeanDefinition 等等
	refreshBeanFactory();
	ConfigurableListableBeanFactory beanFactory = getBeanFactory();
	if (logger.isDebugEnabled()) {
		logger.debug("Bean factory for " + getDisplayName() + ": " + beanFactory);
	}
	return beanFactory;
}

@Override
protected final void refreshBeanFactory() throws BeansException {
	// 如果 ApplicationContext 中已经加载过 BeanFactory 了，销毁所有 Bean，关闭 BeanFactory
    // 注意，应用中 BeanFactory 本来就是可以多个的，这里可不是说应用全局是否有 BeanFactory，而是当前
    // ApplicationContext 是否有 BeanFactory
	if (hasBeanFactory()) {
		destroyBeans();
		closeBeanFactory();
	}
	try {
		DefaultListableBeanFactory beanFactory = createBeanFactory();
		beanFactory.setSerializationId(getId());
		// 设置 BeanFactory 的两个配置属性：是否允许 Bean 覆盖、是否允许循环引用
		customizeBeanFactory(beanFactory);
		// 重点加载 Bean 到 BeanFactory 中
		loadBeanDefinitions(beanFactory);
		synchronized (this.beanFactoryMonitor) {
			this.beanFactory = beanFactory;
		}
	}
	catch (IOException ex) {
		throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);
	}
}

浅尝辄止，想深入的同学可以自行了解

prepareBeanFactory(beanFactory)

该过程主要设置BeanFactory的类加载器，并添加几个BeanPostProcession，不再展开叙述。

postProcessBeanFactory(beanFactory)和invokeBeanFactoryPostProcessors(beanFactory)

该过程主要是注册BeanFactoryPostProcessor的实现类并调用postProcessBeanFactory(factory)方法用来调整BeanDefinition，不再展开叙述。可调式SpringBeanFactoryPostProcessor类进行了解

registerBeanPostProcessors(beanFactory)

将BeanPostProcession的实现类注册到BeanFactory中，并初始化，注意：仅仅是初始化实现了BeanPostProcession接口的类。不再展开叙述。可调式SpringBeanPostProcessor类进行了解

直接看核心方法finishBeanFactoryInitialization(beanFactory)

protected void finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory) {
	// 初始化实现了ConversionService接口的类（beanFactory.getBean），主要用来转换参数.
	if (beanFactory.containsBean(CONVERSION_SERVICE_BEAN_NAME) &&
			beanFactory.isTypeMatch(CONVERSION_SERVICE_BEAN_NAME, ConversionService.class)) {
		beanFactory.setConversionService(
				beanFactory.getBean(CONVERSION_SERVICE_BEAN_NAME, ConversionService.class));
	}

	// Register a default embedded value resolver if no bean post-processor
	// (such as a PropertyPlaceholderConfigurer bean) registered any before:
	// at this point, primarily for resolution in annotation attribute values.
	if (!beanFactory.hasEmbeddedValueResolver()) {
		beanFactory.addEmbeddedValueResolver(strVal -> getEnvironment().resolvePlaceholders(strVal));
	}

	// 用于织入第三方模块
	String[] weaverAwareNames = beanFactory.getBeanNamesForType(LoadTimeWeaverAware.class, false, false);
	for (String weaverAwareName : weaverAwareNames) {
		getBean(weaverAwareName);
	}

	// Stop using the temporary ClassLoader for type matching.
	beanFactory.setTempClassLoader(null);

	// Allow for caching all bean definition metadata, not expecting further changes.
	beanFactory.freezeConfiguration();

	// 实例化所有剩余的(非惰性初始化)单例.
	beanFactory.preInstantiateSingletons();
}

@Override
public void preInstantiateSingletons() throws BeansException {
	if (this.logger.isDebugEnabled()) {
		this.logger.debug("Pre-instantiating singletons in " + this);
	}

	// Iterate over a copy to allow for init methods which in turn register new bean definitions.
	// While this may not be part of the regular factory bootstrap, it does otherwise work fine.
	List beanNames = new ArrayList<>(this.beanDefinitionNames);

	// 触发所有的非懒加载的 singleton beans 的初始化操作
	for (String beanName : beanNames) {
		// 合并父 Bean 中的配置，注意  中的 parent，用的不多
		RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
		// 非抽象、非懒加载的 singletons。如果配置了 'abstract = true'，那是不需要初始化的
		if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) {
			// 处理 FactoryBean
			if (isFactoryBean(beanName)) {
				// FactoryBean 的话，在 beanName 前面加上 ‘&’ 符号。再调用 getBean
				Object bean = getBean(FACTORY_BEAN_PREFIX + beanName);
				if (bean instanceof FactoryBean) {
					final FactoryBean factory = (FactoryBean) bean;
					// 判断当前 FactoryBean 是否是 SmartFactoryBean 的实现，此处忽略，直接跳过
					boolean isEagerInit;
					if (System.getSecurityManager() != null && factory instanceof SmartFactoryBean) {
						isEagerInit = AccessController.doPrivileged((PrivilegedAction)
										((SmartFactoryBean) factory)::isEagerInit,
								getAccessControlContext());
					}
					else {
						isEagerInit = (factory instanceof SmartFactoryBean &&
								((SmartFactoryBean) factory).isEagerInit());
					}
					if (isEagerInit) {
						getBean(beanName);
					}
				}
			}
			else {
				// 对于普通的 Bean，只要调用 getBean(beanName) 这个方法就可以进行初始化了
				getBean(beanName);
			}
		}
	}

	// 到这里说明所有的非懒加载的 singleton beans 已经完成了初始化
   // 如果我们定义的 bean 是实现了 SmartInitializingSingleton 接口的，那么在这里得到回调，忽略
	for (String beanName : beanNames) {
		Object singletonInstance = getSingleton(beanName);
		if (singletonInstance instanceof SmartInitializingSingleton) {
			final SmartInitializingSingleton smartSingleton = (SmartInitializingSingleton) singletonInstance;
			if (System.getSecurityManager() != null) {
				AccessController.doPrivileged((PrivilegedAction