Spring之循环依赖

客官°小女子只卖身不卖艺 2022-12-15 11:26 228阅读 0赞

# 一、循环依赖 #

循环依赖其实就是循环引用，也就是两个或者两个以上的bean互相持有对方，最终形成闭环。

# 二、Spring中循环依赖场景 #

（1）**构造器的循环依赖** 【这个**Spring解决不了**】  
创建代码进行验证  
StudentA

package com.cyclicdependence;
    //构造器StudentA
    public class StudentA { 
    	private StudentB studentB ;  
        public void setStudentB(StudentB studentB) {   
            this.studentB = studentB;  
        }  
        public StudentA() {   
        }  
        public StudentA(StudentB studentB) {   
            this.studentB = studentB;  
        }  
    }

StudentB

package com.cyclicdependence;
    //构造器StudentB
    public class StudentB { 
    	 private StudentC studentC ;  
    	    public void setStudentC(StudentC studentC) {   
    	        this.studentC = studentC;  
    	    }  
    	    public StudentB() {   
    	    }  
    	    public StudentB(StudentC studentC) {   
    	        this.studentC = studentC;  
    	    }  
    }

StudentC

package com.cyclicdependence;
    //构造器StudentC
    public class StudentC { 
    	private StudentA studentA;
    	public void setStudentA(StudentA studentA) { 
    		this.studentA = studentA;
    	}
    	public StudentC() { 
    	}
    	public StudentC(StudentA studentA) { 
    		this.studentA = studentA;
    	}
    }

ConstructorsTest

package com.cyclicdependence;
    import org.springframework.context.ApplicationContext;
    import org.springframework.context.support.ClassPathXmlApplicationContext;
    
    public class ConstructorsTest { 
    	public static void main(String[] args) { 
    		ApplicationContext context = new ClassPathXmlApplicationContext("spring-bean.xml");
    		System.out.println(context.getBean("a", StudentA.class));
    	}
    }

spring-bean.xml

<bean id="a" class="com.cyclicdependence.StudentA">
    		<constructor-arg index="0" ref="b"></constructor-arg>
    	</bean>
    	<bean id="b" class="com.cyclicdependence.StudentB">
    		<constructor-arg index="0" ref="c"></constructor-arg>
    	</bean>
    	<bean id="c" class="com.cyclicdependence.StudentC">
    		<constructor-arg index="0" ref="a"></constructor-arg>
    	</bean>

执行报错结果如下：  
![在这里插入图片描述][20201016145932819.jpg_pic_center]  
**报错原因分析**：  
Spring容器会将每一个正在创建的Bean 标识符放在一个“当前创建Bean池”中，Bean标识符在创建过程中将一直保持在这个池中。因此如果在创建Bean过程中发现自己已经在“当前创建Bean池”里时将抛出BeanCurrentlyInCreationException异常表示循环依赖；而对于创建完毕的Bean将从“当前创建Bean池”中清除掉。

Spring容器先创建单例A，A依赖B，然后将A放在“当前创建Bean池”中，此时创建B，B依赖C ,然后将B放在“当前创建Bean池”中，此时创建C，C又依赖A。 但是，此时A已经在池中，所以会报错，因为在池中的Bean都是未初始化完的，所以会依赖错误 。（初始化完的Bean会从池中移除）

（2）**field属性、setter方法设置循环依赖**【这个Spring可以解决】  
从[Spring Bean生命周期][Spring Bean]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppa2UxMTIzMQ_size_16_color_FFFFFF_t_70_pic_center]  
中可以看到**Spring是先将Bean对象实例化【依赖无参构造函数】—>再设置对象属性的。**

setter方式（**默认单例，如果是多例，无法解决循环依赖**）–>通过递归方法找出当前Bean所依赖的Bean，然后提前缓存（放入Map）起来。通过提前暴露 -->暴露一个exposedObject用于返回提前暴露的Bean。

Spring先是构造实例化Bean对象 ，此时Spring会将这个实例化结束的对象放到一个Map中，并且Spring提供了获取这个未设置属性的实例化对象引用的方法。结合我们的实例来看，当Spring实例化了StudentA、StudentB、StudentC后，紧接着会去设置对象的属性，此时StudentA依赖StudentB，就会去Map中取出存在里面的单例StudentB对象，以此类推，不会出现循环的问题。

<bean id="a" class="com.cyclicdependence.StudentA">
    		<property name="StudentB" ref="b"></property>
    	</bean>
    	<bean id="b" class="com.cyclicdependence.StudentB">
    		<property name="StudentC" ref="c"></property>
    	</bean>
    	<bean id="c" class="com.cyclicdependence.StudentC">
    		<property name="StudentA" ref="a"></property>
    	</bean>

执行结果如下：  
![在这里插入图片描述][20201016150556266.png_pic_center]

# 三、怎么检测是否存在循环依赖 #

检测循环依赖相对比较容易，Bean在创建的时候可以给该Bean打标，如果递归调用回来发现正在创建中的话，即存在循环依赖。

# 四、如何解决循环依赖 #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppa2UxMTIzMQ_size_16_color_FFFFFF_t_70_pic_center 1]  
（1）createBeanInstance：实例化，其实也就是调用对象的构造方法实例化对象  
（2）populateBean：填充属性，这一步主要是多bean的依赖属性进行填充  
（3）initializeBean：调用spring xml中的init 方法。  
从上面单例bean的初始化可以知道：循环依赖主要发生在第一、二步，也就是构造器循环依赖和field循环依赖。那么我们要解决循环引用也应该从初始化过程着手，对于单例来说，在Spring容器整个生命周期内，有且只有一个对象，所以很容易想到这个对象应该存在Cache中，Spring为了解决单例的循环依赖问题，使用了三级缓存。

这**三级缓存**依次分别指：  
　　**singletonObjects**：一级，单例对象的cache，保存所有的singletonBean的实例  
　　**earlySingletonObjects**：二级，提前暴光的单例对象的Cache ，保存所有早期创建的Bean对象，这个Bean还没有完成依赖注入  
　　**singletonFactories**： 三级，单例对象工厂的cache，singletonBean的生产工厂

# 五、源码实现 #

1.**循环依赖的解决**：  
三级缓存实现即singletonObjects，earlySingletonObjects和singletonFactories。如下为DefaultSingletonBeanRegistry的**getSingleton**方法实现：该方法主要在AbstractBeanFactory的**doGetBean**方法调用。

protected Object getSingleton(String beanName, boolean allowEarlyReference) { 
        // 检查一级缓存singletonObject是否存在
     Object singletonObject = this.singletonObjects.get(beanName);
     
     // 当前还不存在这个单例对象，
     // 且该对象正在创建中，即在singletonsCurrentlyInCreation列表中
     if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) { 
      synchronized (this.singletonObjects) { 
      
          // 检查二级缓存earlySingletonObjects是否存在
       singletonObject = this.earlySingletonObjects.get(beanName);
       if (singletonObject == null && allowEarlyReference) { 
       
           // 检查三级缓存singletonFactory是否可以创建
        ObjectFactory<?> singletonFactory = this.singletonFactories.get(beanName);
        if (singletonFactory != null) { 
        
            // 三级缓存的对象工厂创建该对象
         singletonObject = singletonFactory.getObject();
         
         // 放入二级缓存earlySingletonObjects中
         this.earlySingletonObjects.put(beanName, singletonObject);
         
            // 移除一级缓存
         this.singletonFactories.remove(beanName);
        }
       }
      }
     }
     return singletonObject;
    }

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

**分析getSingleton()的整个过程**：  
Spring首先从一级缓存singletonObjects中获取。如果获取不到，并且对象正在创建中，就再从二级缓存earlySingletonObjects中获取。如果还是获取不到且允许singletonFactories通过getObject()获取，就从三级缓存singletonFactory.getObject()(三级缓存)获取，如果获取到了则从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循环依赖，为何用三级缓存而非二级][Spring _bean]  
**使用三级缓存而非二级缓存并不是因为只有三级缓存才能解决循环引用问题，其实二级缓存同样也能很好解决循环引用问题。使用三级而非二级缓存并非出于IOC的考虑，而是出于AOP的考虑，即若使用二级缓存，在AOP情形下，注入到其他bean的，不是最终的代理对象，而是原始对象。**

[真正弄懂Spring为什么用三级缓存而不用二级缓存][Spring]  
**如果要使用二级缓存解决循环依赖，意味着所有Bean在实例化后就要完成AOP代理，这样违背了Spring设计的原则，Spring在设计之初就是通过AnnotationAwareAspectJAutoProxyCreator这个后置处理器来在Bean生命周期的最后一步来完成AOP代理，而不是在实例化后就立马进行AOP代理。**

# 七、结束语 #

不要使用基于构造函数的依赖注入，可以通过以下方式解决：  
1.**在字段上使用@Autowired注解**，让Spring决定在合适的时机注入  
2.**用基于setter方法的依赖注入**。

参考文章  
https://www.cnblogs.com/liuqing576598117/p/11227007.html  
https://blog.csdn.net/weixin\_36380516/article/details/108806797  
https://blog.csdn.net/bailaoshi666/article/details/107197985/  
https://blog.csdn.net/qq\_36381855/article/details/79752689  
https://blog.csdn.net/chejinqiang/article/details/80003868

[20201016145932819.jpg_pic_center]: /images/20221123/fab44bc37e52454f8f4f5731af2eb663.png
[Spring Bean]: https://blog.csdn.net/jike11231/article/details/108772978
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppa2UxMTIzMQ_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/2110b915b4a04e649ebe31387ac9e345.png
[20201016150556266.png_pic_center]: /images/20221123/49930981288a4e5494c45ece1d3caf4d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppa2UxMTIzMQ_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/f14734ff66ae4455854ed146c52446bb.png
[Spring _bean]: https://blog.csdn.net/panda9527z/article/details/107359916
[Spring]: https://blog.csdn.net/foxException/article/details/108712397