前言
在工作中,经常由于设计不佳或各种原因,导致类之间相互依赖。这些类可能单独使用时不会出现问题,但是在使用Spring进行管理的时候可能就会抛出BeanCurrentlyInCreationException
等异常。当抛出这种异常时表示Spring解决不了该循环依赖。本文将说明Spring对于循环依赖的解决方法。
简介
本文,我们来看一下Spring是如何解决循环依赖问题的。在本篇文章中,我会首先向大家介绍以下什么是循环依赖。然后进入源码分析阶段。为了更好的说明Spring解决循环依赖的办法,我将会从获取bean的方法getBean(String)
开始,把整个调用过程梳理一遍。梳理完后,再来详细分析源码。通过这几步讲解,希望让大家能够弄懂什么是循环依赖,以及如何解决循环依赖。
文章内容较长,有点耐心看完。
循环依赖的产生和解决的前提
循环依赖的产生可能有很多种情况,例如:
- A的构造方法中依赖了B的实例对象,同时B的构造方法中依赖了A的实例对象。
- Ade构造方法中依赖了B的实例对象,同时B的某个field或者setter需要A的实例对象,以及反之。
- A的某个field或者setter依赖了B的实例对象,同时B的某个field或者setter依赖了A的实例对象,以及反之。
当然,Spring对于循环依赖的解决不是无条件的,首先前提条件是针对scope单例并且没有显示指明不需要解决循环依赖的对象,而且要求该对象没有被代理过。同时Spring解决循环依赖也不是万能,以上三种情况只能解决两种,第一种在构造方法中相互依赖的情况Spring也无力回天。(知道了以下解决方案就明白为什么第一种情况无法解决了)。
背景知识
什么是循环依赖
所谓的循环依赖是指 A依赖B,B又依赖A,它们之间形成了循环依赖。或者是 A依赖B,B依赖C,C又依赖A。
这里以两个类直接相互依赖为例,它们的实现代码如下:
配置信息如下:
IOC容器在读到上面的配置时,会按照顺序,先去实例化beanA。然后发现beanA依赖于beanB,接着又去实例化beanB。实例化beanB时,发现beanB又依赖于beanA。如果容器不处理循环依赖的话,容器会无限执行上面的流程,直到内存溢出,程序崩溃。
当然,Spring是不会让这种情况发生的。在容器再次发现beanB依赖于beanA时,容器会获取beanA对象的一个早期引用(early reference),并把这个早期引用注入到beanB中,让beanB先完成实例化。beanB完成实例化,beanA就可以获取到beanB的引用,beanA随之完成实例化。
早期引用这个概念在接下来会讲。
一些缓存的介绍
在进行源码分析前,先来看一组缓存的定义。
singletonObjects | 用于存放完全初始化好的bean,从该缓存中取出的bean可以直接使用。 |
earlySingletonObjects | 存放原始的bean对象(尚未填充属性),用于解决循环依赖。 |
singletonFactories | 存放bean工厂对象,用于解决循环依赖。 |
- 之前提到了早期引用,所谓的早期引用是指向原始对象的引用。所谓的原始对象是指刚创建好的对象,但还未填充属性。
配置:
我们先看一下完全实例化好后的bean长什么样:
从调试信息中可以看得出,Room的每个成员变量都被赋值了。然后再看一下原始的bean对象长什么样:
结果就比较明显了,所有字段都是 null。这里的bean和上面的bean指向的是同一个对象Room@1567
,但现在这个对象所有字段都是null,我们把这种对象称为原始的对象。
回顾获取bean的过程
本节,我们来了解从Spring IOC容器中获取bean实例的流程(简化版)。
先来简单介绍一下这张图,这图是一个简化后的流程图。开始流程图中只有一条执行路径,在条件sharedInstance != null
这里出现了岔路,形成了绿色和红色两条路径。在上图中,读取/添加缓存的方法使用蓝色狂和☆标注了出来。
- 这个流程从
getBean
方法开始,getBean
是一个空壳方法,所有逻辑都在doGetBean
方法中。 doGetBean
首先会调用getSingleton(beanName)
方法获取sharedInstance
,sharedInstance
可能是完全实例化好的bean,也可能是一个原始的bean,当然也有可能是 null。- 如果不是null,则走绿色的那条路径。再经
getObjectForBeanInstance
这一步处理后,绿色这条路径就结束了。 - 如果是null,则走红色那条路径。在第一次获取某个bean的时候,缓存中是没有记录的,所以这个时候要走创建逻辑。上图中的
getSingleton(beanName,new ObjectFactory(){...})
方法会创建一个bean实例,上图虚线路径指的是getSingleton
方法内部调用的两个方法,其逻辑如下:
如上所示,
getSingleton
会在内部先调用getObject
方法创建singletonObject
。- 然后再调用
addSingleton
将singletonObject
放入缓存中。 getObject
在内部调用了createBean
方法,createBean
方法基本上也属于空壳方法,更多的逻辑是写在doCreateBean
方法中。doCreateBean
方法中的逻辑很多,其首先调用了createBeanInstance
方法创建一个原始的bean对象。- 随后调用
addSingletonFactory
方法向缓存中添加单例bean工厂,从该工厂可以获取原始对象的引用,也就是所谓的早期引用。 - 再之后,继续调用
populateBean
方法向原始bean对象中填充属性,并解析依赖。 getObject
执行完成后,会返回完全实例化好的bean。紧跟着再调用addSingleton
把完全实例化好的bean对象放入缓存中。- 到这里,红色执行路径差不多也就要结束。
这里没有把getObject
、addSingleton
方法和getSingleton(String,ObjectFactory)
并列画在红色的路径里,目的是想简化一下方法的调用栈。可以进一步简化上面的调用流程:
这里我贴出几个源码:
源码分析
经过前面的铺垫,现在终于可以深入源码一探究竟了。依次来看一下循环依赖相关的代码。如下:(通过上面截图,也标注出了类名,有兴趣可以点进去看,都一样,只是以下代码原博主加上了注释,讲的很详细。)
上面的源码中,doGetBean
所调用的方法getSingleton(String)
是一个空壳方法,其主要逻辑在getSingleton(String,boolean)
中。该方法逻辑比较简单:
- 首先从
singletonObjects
缓存中获取bean实例。 - 若未命中,再去
earlySingletonObjects
缓存中获取原始bean实例。 - 如果仍未命中,则从
singletonFactory
缓存中获取ObjectFactory
对象。 - 然后再调用
getObject
方法获取原始bean实例的应用,也就是早期引用。 - 获取成功后,将该实例放入
earlySingletonObjects
缓存中,并将ObjectFactory
对象从singletonFactories
移除。
看完这个方法,再来看看getSingleton(String,ObjectFactory)
方法,这个方法也是在doGetBean
中被调用的。这次会把doGetBean
的代码多贴出来点,如下:(源码里doGetBean这个方法有点太长了,但是确实又调用了getSingleton(String,ObjectFactory)
方法,好好找。)
这里的代码逻辑和在上面所说的回顾获取bean的过程一节的最后贴的主流程图已经很接近了,对照那张图和代码中的注释,可以理解doGetBean
方法了。继续看:
上面的代码中包含两步操作:
- 第一步操作是调用
getObject
创建bean实例。 - 第二步是调用
addSingleton
方法将创建好的bean放入缓存中。代码逻辑并不复杂。
接下来继续看,这次分析的是doCreateBean
中的一些逻辑。(这个方法上面说过了,是在getSingelton(String,ObjectFactory)
的getObject
方法中内部调用了createBean
之后createBean
又调用了doCreateBean
。
上面的代码简化了不少,不过看起来仍有点复杂。好在,上面的代码主线逻辑比较简单,由三个方法组成。如下:
- 创建原始bean实例 →
createBeanInstance(beanName,mbd,args)
。 - 添加原始对象工厂对象到
singletonFactories
缓存中。→addSingletonFactory(beanName,new ObjectFactory<Object>{...})
- 填充属性,解析依赖 →
populateBean(beanName,mbd,instanceWrapper)
到这里,本节涉及到的源码就解析完了。可是看完源码后,似乎仍然不知道这些源码是如何解决循环依赖问题的。下面来解答这个问题,这里还是以BeanA和BeanB两个类相互依赖为例。在上面的方法调用中,有几个关键的地方,下面一一列举出来:
- 创建原始bean对象
假设beanA先被创建,创建后的原始对象为BeanA@1234
,上面代码中的bean变量指向就是这个对象。
- 暴露早期引用
beanA指向的原始对象创建好后,就开始把指向原始对象的引用通过ObjectFactory
暴露出去。getEarlyBeanReference
方法的第三个参数bean指向的正是createBeanInstance
方法创建出原始对象BeanA@1234
。
- 解析依赖
populateBean
用于向beanA这个原始对象中填充属性,当它检测到beanA依赖于beanB时,会首先去实例化beanB。beanB在此方法处也会解析自己的依赖,当它检测到beanA这个依赖,于是调用BeanFactory.getBean("beanA")
这个方法,从容器中获取beanA。
- 获取早期引用
接着上面的步骤讲,populateBean调用BeanFactory.getBean("beanA")
以获取beanB的依赖。getBean("beanA")
会先调用getSingleton("beanA")
,尝试从缓存中获取beanA。此时由于beanA还没有完全实例化好,于是this.singletonObjects.get("beanA")
也返回空,因为beanA早期引用还没放入到这个缓存中。最后调用singletonFactory.getObject()
返回singletonObject
,此时singletonObject != null
。singletonObject
指向BeanA@1234
,也就是createBeanInstance
创建的原始对象。此时beanB获取到了这个原始对象的引用,beanB就能顺利完成实例化。beanB完成实例化后,beanA就能获取到beanB所指的实例,beanA随之完成实例化工作。由于beanB.beanA和beanA指向的是同一个对象BeanA@1234,所以beanB中的beanA此时也处于可用状态了。
以上的过程对应下面的流程图:
看到这里,你也肯定知道为什么Spring不能解决A的构造方法中依赖B的实例对象,同时B的构造方法中依赖了A的实例对象这类问题了。
因为Spring只能解决属性之间的循环依赖,看源码就明白,还是需要有前期引用,前期引用属性为null,但是还是需要创建该对象,创建对象那就需要用构造方法,构造方法中循环依赖,通过上面分析的源码,Spring肯定解决不了了。因为缓存中连前期引用都没有。
参考文章
Spring源码初探-IOC(4)-Bean的初始化-循环依赖的解决