循环依赖的类别
循环依赖的产生可能有很多种情况,例如:
- A的构造方法中依赖了B的实例对象,同时B的构造方法中依赖了A的实例对象;
- A的构造方法中依赖了B的实例对象,同时B的某个
field
或者setter
需要A的实例对象,以及反之; - A的某个field或者setter依赖了B的实例对象,同时B的某个
field
或者setter
依赖了A的实例对象,以及反之;
当然,Spring对于循环依赖的解决不是无条件的,首先前提条件是针对scope
单例并且没有显式指明不需要解决循环依赖的对象,而且要求该对象没有被代理过。同时Spring解决循环依赖也不是万能,以上三种情况只能解决两种,第一种在构造方法中相互依赖的情况Spring也无力回天,第二种如果在B中使用@Autowired
进行注入,那么也无法成功。
Spring对于循环依赖的解决
Spring循环依赖的理论依据其实是Java基于引用传递,当我们获取到对象的引用时,对象的属性是可以延后设置的。
Spring单例对象的初始化其实可以分为三步:
-
createBeanInstance
: 实例化,实际上就是调用对应的构造方法构造对象,此时只是调用了构造方法,@Autowired
修饰的字段还未注入; -
populateBean
:填充属性,对@Autowired
等自动注入的字段进行注入,和xml指定的property进行注入; -
initializeBean
:调用指定的init-method
方法,或者AfterPropertiesSet
方法
会发生循环依赖的步骤集中在第一步和第二步。
三级缓存
对于单例对象来说,在Spring的整个容器的生命周期内,有且只存在一个对象,很容易想到这个对象应该存在Cache中,Spring大量运用了Cache的手段,在循环依赖问题的解决过程中甚至使用了“三级缓存”。
“三级缓存”主要是指
/** Cache of singleton objects: bean name --> bean instance */
private final Map<String, Object> singletonObjects = new ConcurrentHashMap<String, Object>(256);
/** Cache of singleton factories: bean name --> ObjectFactory */
private final Map<String, ObjectFactory<?>> singletonFactories = new HashMap<String, ObjectFactory<?>>(16);
/** Cache of early singleton objects: bean name --> bean instance */
private final Map<String, Object> earlySingletonObjects = new HashMap<String, Object>(16);
-
singletonObjects
:用于存储的是已经初始化完成的bean实例。 -
earlySingletonObjects
:用于存储在创建Bean早期对创建的原始bean的一个引用,是提前曝光的单例对象的cache,一旦对象初始化完成,将会从earlySingletonObjects
提升到singletonObjects
。 -
singletonFactories
:用于存储在spring内部所使用的beanName
到单例对象工厂的引用,一旦最终对象被创建(通过objectFactory.getObject()
),此引用信息将删除,提升至earlySingletonObjects
或singletonObjects
。
解决方法
在Bean创建的过程,首先Spring会尝试从缓存中获取,这个缓存就是指singletonObjects,主要调用的方法是:
protected Object getSingleton(String beanName, boolean allowEarlyReference) {
Object singletonObject = this.singletonObjects.get(beanName);
if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) {
synchronized (this.singletonObjects) {
singletonObject = this.earlySingletonObjects.get(beanName);
if (singletonObject == null && allowEarlyReference) {
ObjectFactory<?> singletonFactory = this.singletonFactories.get(beanName);
if (singletonFactory != null) {
singletonObject = singletonFactory.getObject();
this.earlySingletonObjects.put(beanName, singletonObject);
this.singletonFactories.remove(beanName);
}
}
}
}
return singletonObject;
}
首先解释两个参数:isSingletonCurrentlyInCreation
判断对应的单例对象是否在创建中,当单例对象没有被初始化完全(例如A定义的构造函数依赖了B对象,得先去创建B对象,或者在populatebean
过程中依赖了B对象,得先去创建B对象,此时A处于创建中)。allowEarlyReference
是否允许从singletonFactories
中通过getObject
拿到对象。
分析getSingleton
的整个过程,Spring首先从singletonObjects
(一级缓存)中尝试获取,如果获取不到并且对象在创建中,则尝试从earlySingletonObjects
(二级缓存)中获取,如果还是获取不到并且允许在singletonFactories
获取,则通过 singletonFactory.getObject()
(三级缓存)获取。如果获取到了
this.earlySingletonObjects.put(beanName, singletonObject);
this.singletonFactories.remove(beanName);
则移除对应的singletonFactory
的实例,将singletonObject
放入到earlySingletonObjects
,其实就是将三级缓存提升到二级缓存中。
Spring解决循环依赖的诀窍就在于singletonFactories
这个cache,这个cache中存的是类型为ObjectFactory
,其定义如下:
@FunctionalInterface
public interface ObjectFactory<T> {
T getObject() throws BeansException;
}
在bean创建过程中,有两处比较重要的匿名内部类实现了该接口。一处是
sharedInstance = getSingleton(beanName, () -> {
try {
return createBean(beanName, mbd, args);
}
...
}
Spring利用其创建对象
另一处就是:
addSingletonFactory(beanName, () -> getEarlyBeanReference(beanName, mbd, bean));
此处就是解决循环依赖的关键,这段代码发生在createBeanInstance
之后,也就是说单例对象此时已经被创建出来的。这个对象已经被生产出来了,虽然还不完美(还没有进行初始化的第二步和第三步),但是已经能被人认出来了(根据对象引用能定位到堆中的对象),所以Spring此时将这个对象提前曝光出来让大家认识,让大家使用。
这样做有什么好处呢?让我们来分析一下“A的某个field
或者setter
依赖了B的实例对象,同时B的某个field或者setter依赖了A的实例对象”这种循环依赖的情况。A首先完成了初始化的第一步,并且将自己提前曝光到singletonFactories
中,此时进行初始化的第二步,发现自己依赖对象B,此时就尝试去get(B),发现B还没有被create,所以走create流程,B在初始化第一步的时候发现自己依赖了对象A,于是尝试get(A),尝试一级缓存singletonObjects
(肯定没有,因为A还没初始化完全),尝试二级缓存earlySingletonObjects
(也没有),尝试三级缓存singletonFactories
,由于A通过ObjectFactory
将自己提前曝光了,所以B能够通过ObjectFactory.getObject
拿到A对象(虽然A还没有初始化完全,但是总比没有好呀),A进入二级缓存earlySingletonObjects
,B拿到A对象后顺利完成了初始化阶段1、2、3,完全初始化之后将自己放入到一级缓存singletonObjects
中。此时返回A中,A此时能拿到B的对象顺利完成自己的初始化阶段2、3,最终A也完成了初始化,进去了一级缓存singletonObjects
中,而且由于B拿到了A的对象引用,所以B现在hold住的A对象也蜕变完美了!
另外,Spring对在二级缓存earlySingletonObjects
的对象进行了校验,原因在于如果对象实例在二级缓存earlySingletonObjects
中,就说明存在循环引用,那么该对象有可能被后置处理器beanPostProcessor
对原始bean进行封装或是代理等,有可能B所持有的A是原始bean,而不是后置处理器封装或是代理后的A。方法如下
if (earlySingletonExposure) {
Object earlySingletonReference = getSingleton(beanName, false);
if (earlySingletonReference != null) { //判断点1
if (exposedObject == bean) { //判断点2
exposedObject = earlySingletonReference;
}
else if (!this.allowRawInjectionDespiteWrapping && hasDependentBean(beanName)) { //判断点3
String[] dependentBeans = getDependentBeans(beanName);
Set<String> actualDependentBeans = new LinkedHashSet<>(dependentBeans.length);
for (String dependentBean : dependentBeans) {
if (!removeSingletonIfCreatedForTypeCheckOnly(dependentBean)) {
actualDependentBeans.add(dependentBean);
}
}
if (!actualDependentBeans.isEmpty()) { //判断点4
throw new BeanCurrentlyInCreationException(beanName,
"Bean with name '" + beanName + "' has been injected into other beans [" +
StringUtils.collectionToCommaDelimitedString(actualDependentBeans) +
"] in its raw version as part of a circular reference, but has eventually been " +
"wrapped. This means that said other beans do not use the final version of the " +
"bean. This is often the result of over-eager type matching - consider using " +
"'getBeanNamesOfType' with the 'allowEagerInit' flag turned off, for example.");
}
}
}
- 判断点1,首先确定这个对象能从
earlySingletonObjects
中取出对象来,经过上面的分析,我们知道,在正常情况下,此对象为null,即不存在循环检测。而在循环引用中,此对象能够被取出来。 - 判断点2,判断这个对象和当前通过
beanPostProcessor
处理过的对象是否相同,如果相同,表示对象没有经过修改,那么循环引用成立,无需处理。 - 判断点3,判断当前对象A是否被其他对象所依赖,在循环引用中,已经处理了A和B,那么在依赖表中,即在属性
dependentBeanMap
和dependenciesForBeanMap
中。其中A->B表示A依赖于B,B->A表示B依赖于A。那么在dependentBeanMap
中就会出现两个entry,分别为A->B和B->A。这里A依赖于A,那么表示A已经被依赖,则进入进一步检测中。在检测中,将取得一个A的被依赖列表中的bean已经被创建的对象列表值。 - 判断点4,如果被依赖对象列表不为空,则表示出现循环引用。因为按照创建规则,如果A->B,则必须先创建B,而B->A,则必须先创建A。在这里,A被B依赖,就要求A必须在B之前被创建,而B又被A依赖,又要求A必须在B之前被创建。这创建的两个对象必须满足一致才可以。即在A->B中的两个对象,必须和B->A的两个对象,互相一致才可以,否则就不是循环引用。
总结
Spring通过三级缓存加上“提前曝光”机制,配合Java的对象引用原理,比较完美地解决了某些情况下的循环依赖问题,再加上校验,比较完美的解决了循环引用的问题。