上篇文章,我们自定义实现了一个简单地IOC容器。本篇文章我们来介绍一下Spring IOC容器的实现。
1. 准备工作
为了学习Spring的源码实现,我们需要准备Spring的源码环境,这时我们一般可以有以下两种选择:
1.1 下载spring-framework git项目
将spring-framework git项目下载到本地
git clone https://github.com/spring-projects/spring-framework.git
将源码导入到Idea中
这种方式存在一个问题,现在github下载速度非常慢,spring-framework又非常大,所以一般一般都会下载失败。解决的办法可以修改host文件或挂个代理,我是通过挂代理的方式既觉得,具体参考:https://www.zhihu.com/question/27159393
将源码导入到Idea中后,Idea会自动Sync项目,等Sync结束(这个过程一般会挺久),表示spring-framework正确导入到本地了,这时候项目结构会是下图这个样子:
1.2 通过maven引入相关jar包
除了上述方式,我们还可以通过maven,将spring的相关jar包引入到本地项目中。比如我们再项目的pom.xml文件中添加spring-context的依赖:
<!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.2.4.RELEASE</version>
</dependency>
然后就可以将spring-context相关包导入到项目中,但是这时候Idea默认只是导入了字节码jar包,并没有下载sourceCode包,对我们查看源码非常不方便,我们可以通过如下设置,让Idea在下载jar包的同时,下载sourceCode包。
Preferences > Build,Execution,Deployment > Build Tools > Maven > Importing,设置下载sourceCode包和javaDoc:
Idea重新导入下载源码包:
2. 源码入口
当我们试图研究Spring源码时,一般最开始总是无从下手的,因为Spring整体层级结构、实现还是比较复杂的。并且平时我们使用时一般只会关心到配置文件(配置类)层面,很少去关注底层的实现。首先我们来看一下Spring IOC源码阅读的入口,我们再学习Spring时,肯定会接触如下一段demo(这里我们使用xml配置文件的demo出发,Java配置的Spring道理是一样的,只不过入口类为AnnotationConfigApplicationContext,将Bean配置加载为BeanDefinition的过程不同,后续过程都是完全一致的):
ApplicationContext applicationContext = new ClassPathXmlApplicationContext("spring-context.xml");
applicationContext.getBean(XXX.class);
ClassPathXmlApplicationContext用于加载CLASSPATH下的Spring配置文件,可以看到,第二行就已经可以获取到Bean的实例了,那么必然第一行就已经完成了对所有Bean实例的加载(这里完成加载,表示配置文件中定义的Bean已经实例化并初始化了)。那么入口肯定在ClassPathXmlApplicationContext类的构造函数中,如下:
public ClassPathXmlApplicationContext(String configLocation) throws BeansException {
this(new String[] {configLocation}, true, null);
}
在该构造方法中,调用了另一个构造方法,如下:
public ClassPathXmlApplicationContext(
String[] configLocations, boolean refresh, @Nullable ApplicationContext parent)
throws BeansException {
super(parent);
setConfigLocations(configLocations);
if (refresh) {
refresh();
}
}
- super方法:调用父类构造函数,这里parent为null,表示无父容器
- setConfigLocations方法:用于将参数configLocations指定的Spring配置文件路径中的${PlaceHolder}占位符,替换为系统变量中PlaceHolder对应的Value值,并存储到成员变量configLocations中,方便我们后续将Bean定义加载为BeanDefinition前,获取配置文件的字节输入流
- refresh方法:Spring Bean加载的核心方法,它是ClassPathXmlApplicationContext的父类AbstractApplicationContext的一个方法,用于刷新Spring容器上下文信息,定义了Spring容器Bean加载的流程
@Override
public void refresh() throws BeansException, IllegalStateException {
synchronized (this.startupShutdownMonitor) {
// 1. 准备刷新Spring上下文,主要用来记录Spring上下文加载开始时间,设置一些基础成员变量value
prepareRefresh();
// 2. 刷新BeanFactory,此方法内完成配置文件中配置的Bean到BeanDefinition的转化及注册
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
// 3. 准备Bean工厂,主要用来配置BeanFactory的基础信息,例如上下文的ClassLoader和后处理器
prepareBeanFactory(beanFactory);
try {
// 4. 允许子context添加一些BeanFactoryPostProcessor,
// 比如Web应用中AbstractRefreshableWebApplicationContext添加ServletContextAwareProcessor,
// 可以暂时略过这个方法
postProcessBeanFactory(beanFactory);
// 5. 执行BeanFactoryPostProcessor中定义的方法
invokeBeanFactoryPostProcessors(beanFactory);
// 6. 注册所有的BeanPostProcessor,这部分BeanPostProcessor会在下面finishBeanFactoryInitialization方法
// 过程中使用
registerBeanPostProcessors(beanFactory);
// 7. 初始化MessageSource,MessageSource是Spring定义的用于实现访问国际化的接口
initMessageSource();
// 8. 初始化上下文事件广播器
initApplicationEventMulticaster();
// 9. 模板方法,可以通过重写它添加特殊上下文刷新的工作
onRefresh();
// 10. 注册监听器
registerListeners();
// 11. 实例化所有定义的单例Bean
finishBeanFactoryInitialization(beanFactory);
// 结束Spring上下文刷新
finishRefresh();
}
catch (BeansException ex) {
if (logger.isWarnEnabled()) {
logger.warn("Exception encountered during context initialization - " +
"cancelling refresh attempt: " + ex);
}
// Destroy already created singletons to avoid dangling resources.
destroyBeans();
// Reset 'active' flag.
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();
}
}
}
上述流程会在后面的文章详细介绍,这里只简单罗列一下Bean加载的步骤。对于我们理解Bean加载比较重要的就是第2步和第11步,这两步定义了Spring启动时,Bean是如何从配置文件变成可使用的对象的过程。后面的文章会先介绍这一部分,再逐步讲解剩余的步骤。同时对于refresh方法我们还需要关注以下两点:
- refresh方法主体是加了同步锁的,该锁在关闭方法close中使用,就是为了保证在调用refresh()方法的时候无法调用close()方法。或者调用close方法时无法调用refresh()方法,保证互斥性。
- 该方法中,定义了跟Bean加载相关的很多子方法,每个子方法完成其独立的功能,阅读起来非常清晰明了。否则的花将散布在各个子方法中的逻辑统一搬到refresh方法中,refresh方法至少要有几千行了。所以通过模块划分明的子方法提高了代码的可扩展性和可维护性。
3. 继承体系
通过上述简单地逻辑梳理,我们可以发现,在Bean加载过程中,比较重要的两个类。分别为入口类ClassPathXmlApplicationContext,以及该入口类通过继承得到的成员变量beanFactory,代码中可以发现该实例为DefaultListableBeanFactory。我们来看一下这两个类的继承体系。