Spring如何解决循环依赖_spring 循环依赖怎么解决 csdn-CSDN博客

本文链接：https://blog.csdn.net/weixin_37598682/article/details/104499255

什么是循环依赖

循环依赖就是循环引用，就是两个或者多个Bean相互之间持有对象最终反映为一个环，注意此处不是循环调用，循环调用是方法之间的环调用，循环调用是无法解决的，除非有终结条件，否则就是死循环，最后导致栈内存溢出

Spring如何解决循环依赖

Spring容器循环依赖包括：构造器循环依赖和setter方法循环依赖

1.构造器循环依赖

表示通过构造器注入构成的循环依赖，此依赖是无法解决的，只能抛出BeanCurrentlyInCreationException异常表示循环依赖

比如：在创建TestA类时，构造器需要TestB类，那将去创建TestB类，在创建TestB类时候有发现需要TestC类，则有去出创建TestC类，最终发现创建TestC类时有需要去创建TestA类，从而形成一个环，没办法创建

Spring容器将每个正在创建的bean标识符放在一个“当前创建bean池”中，bean标识符在创建过程中一直保持在这个池中，如果在创建bean过程中发现自己已经在“当前创建bean池”里时，将抛出BeanCurrentlyInCreationException异常标识循环依赖，而对于创建完毕的bean将从“当前创建bean池”中清除

测试如下：

public class TestA {  
          
            private TestB testB ;  
          
            public void setTestB(TestB testB) {  
                this.testB = testB;  
            }  
          
        
            public void a() {  
                testB.b()
            }  
              
            public TestA(TestB testB) {  
                this.testB = testB;  
            }  
        }  

public class TestB {  
          
            private TestC testC ;  
          
            public void setTestC(TestC testC) {  
                this.testC = testC;  
            }  
              
            public void b() {  
                testC.c()
            }  
          
            public TestB(TestC testC) {  
                this.testC = testC;  
            }  
        }  

public class TestC {  
          
            private TestA testA ;  
          
            public void setTestA(TestA testA) {  
                this.testA = testA;  
            }  
          
            public void c() {  
                testA.a()
            }  
           
            public TestC(TestA testA) {  
                this.testA = testA;  
            }  
        }

注册成bean

<bean id="a" class="com.test.TestA">  
    <constructor-arg index="0" ref="b"></constructor-arg>  
</bean>  
<bean id="b" class="com.test.TestB">  
    <constructor-arg index="0" ref="c"></constructor-arg>  
</bean>  
<bean id="c" class="com.test.TestC">  
    <constructor-arg index="0" ref="a"></constructor-arg>  
</bean>

测试在初始化Spring容器的时候报错：

ApplicationContext context = new ClassPathXmlApplicationContext("com/test/applicationContext.xml");

报错信息

Caused by: org.springframework.beans.factory.BeanCurrentlyInCreationException:
Error creating bean with name 'a': Requested bean is currently in creation: Is there an unresolvable circular reference

2.setter循环依赖

表示通过setter注入方式构成的循环依赖，对于setter注入造成的依赖是通过Spring容器提前暴露刚完成构造器注入但未完成其他步骤（如setter注入）的bean来完成，而且只能解决单例作用域的bean循环依赖，通过提前暴露一个单列工厂方法，从而使其他bean能够引用到该bean

addSingletonFactory(beanName,new ObjectFactory(){

    public Object getObject() throws BeansException {
        return getEarlyBeanReference(beanName,mbd,bean)
 }
})

具体步骤：

Spring容器创建单例“testA” bean，首先根据无参构造器创建bean，并暴露一个“ObjectFactory”用于返回一个提前暴露一个创建中的bean，并将“testA”标志符放到“当前创建bean池”，然后进行setter注入"testB"

Spring容器将创建单列"testB" bean,步骤同上，然后Spring容器创建单列"testC" bean，然后进行setter注入“testA”，进行注入“testA”时由于提前暴露了“ObjectFactory”，可以获取到（从第三级缓存），从而使用它返回提前暴露一个创建中的bean

最后在依赖注入“testB”和“testA”，完成setter注入

Spring循环依赖的依据是基于java的引用传递，当我们获取到对象引用时，对象的属性是可以延后设置，Spring单例对象的初始化主要分为三步

createBeanInstance实例化：调用无参构造实例化对象

populateBean填充属性：填充属性

initializaBean初始化：执行初始化方法

对于单例的bean来说，在整个Spring容器的生命周期中，有且只有一个对象，可以将这个对象放入Cache中，Spring解决单例的循环依赖使用的就是三级缓存

/** Cache of singleton objects: bean name --> bean instance */
private final Map<String, Object> singletonObjects = new ConcurrentHashMap<String, Object>(256);


/** Cache of early singleton objects: bean name --> bean instance */
private final Map<String, Object> earlySingletonObjects = new HashMap<String, Object>(16);

/** Cache of singleton factories: bean name --> ObjectFactory */
private final Map<String, ObjectFactory<?>> singletonFactories = new HashMap<String, ObjectFactory<?>>(16);

这三级缓存分别指：

singletonObjects：单例对象的cache
earlySingletonObjects ：提前暴露的单例对象的Cache ，用于存储在创建Bean早期对创建的原始bean的一个引用，注意这里是原始bean，即使用工厂方法或构造方法创建出来的对象，一旦对象最终创建好，此引用信息将删除，【用于检测循环引用，与singletonFactories互斥】
singletonFactories ：单例对象工厂的cache ，用于存储在spring内部所使用的beanName->对象工厂的引用，一旦最终对象被创建(通过objectFactory.getObject())，此引用信息将删除

在创建bean的时候，首先想到的是从cache中获取这个单例的bean，这个缓存就是singletonObjects。主要调用方法就就是：

protected Object getSingleton(String beanName, boolean allowEarlyReference) {
    //从一级缓存获取
    Object singletonObject = this.singletonObjects.get(beanName);
    //一级缓存获取不到，并且当前单例bean是否正在创建中
    if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) {
        synchronized (this.singletonObjects) {
            //从二级缓存eralySingletonObjects获取
            singletonObject = this.earlySingletonObjects.get(beanName);
            //从二级缓存eralySingletonObjects获取不到并且允许从三级缓存获取
            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 != NULL_OBJECT ? singletonObject : null);
}

首先会从第一级缓存singleObjects获取这个bean，如果没有获取到（即获取的singletonObject==null），并且当前单例bean正在创建中。则从二级缓存获取，如果二级缓存获取不到且允许从三级缓存singletonFactories中获取，则从三级缓存获取

其中有两个参数：

isSingletonCurrentlyInCreation()判断当前单例bean是否正在创建中，也就是没有初始化完成(比如A的构造器依赖了B对象所以得先去创建B对象，或则在A的populateBean过程中依赖了B对象，得先去创建B对象，这时的A就是处于创建中的状态。)
allowEarlyReference 是否允许从singletonFactories中通过getObject拿到对象

在getSingleton()的整个过程，Spring首先从一级缓存singletonObjects中获取。如果获取不到，并且对象正在创建中，就再从二级缓存earlySingletonObjects中获取。如果还是获取不到且允许singletonFactories通过getObject()获取，就从三级缓存singletonFactory.getObject()(三级缓存)获取，如果获取到了则：

this.earlySingletonObjects.put(beanName, singletonObject);
this.singletonFactories.remove(beanName);

从singletonFactories中移除，并放入earlySingletonObjects中。其实也就是从三级缓存移动到了二级缓存。

从上面三级缓存的分析，我们可以知道，Spring解决循环依赖的诀窍就在于singletonFactories这个三级cache。这个cache的类型是ObjectFactory，定义如下：

public interface ObjectFactory<T> {
    T getObject() throws BeansException;
}

这个接口在下面被引用

protected void addSingletonFactory(String beanName, ObjectFactory<?> singletonFactory) {
    Assert.notNull(singletonFactory, "Singleton factory must not be null");
    synchronized (this.singletonObjects) {
        if (!this.singletonObjects.containsKey(beanName)) {
            this.singletonFactories.put(beanName, singletonFactory);
            this.earlySingletonObjects.remove(beanName);
            this.registeredSingletons.add(beanName);
        }
    }
}

这里就是解决循环依赖的关键，这段代码发生在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还没有初始化完全，但是总比没有好呀)，B拿到A对象后顺利完成了初始化阶段1、2、3，完全初始化之后将自己放入到一级缓存singletonObjects中。此时返回A中，A此时能拿到B的对象顺利完成自己的初始化阶段2、3，最终A也完成了初始化，进去了一级缓存singletonObjects中，而且更加幸运的是，由于B拿到了A的对象引用，所以B现在hold住的A对象完成了初始化。

知道了这个原理时候，肯定就知道为啥Spring不能解决“A的构造方法中依赖了B的实例对象，同时B的构造方法中依赖了A的实例对象”这类问题了！因为加入singletonFactories三级缓存的前提是执行了构造器，所以构造器的循环依赖没法解决。

补充：在Spring的bean的生命周期中，先实例化（执行构造方法），在populateProperties设置属性值（此时执行构造方法），setter方法的循环依赖时，对象已经完成实例化，并添加到了三级缓存中，后面可以直接获取到这个bean(只是设置属性的bean)

Bean生命周期相关流程：