浅谈Spring解决循环依赖的三种方式

桃扇骨 2021-06-11 15:14 462阅读 0赞

[https://www.cnblogs.com/tiger-fu/p/8961361.html][https_www.cnblogs.com_tiger-fu_p_8961361.html]

引言：循环依赖就是N个类中循环嵌套引用，如果在日常开发中我们用new 对象的方式发生这种循环依赖的话程序会在运行时一直循环调用，直至内存溢出报错。下面说一下Spring是如果解决循环依赖的。

**第一种：构造器参数循环依赖**

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

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

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

首先我们先初始化三个Bean。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 </td> 
 <td> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>StudentA { </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>private</code>&nbsp;<code>StudentB studentB ; </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>public</code>&nbsp;<code>void</code>&nbsp;<code>setStudentB(StudentB studentB) { </code> <code>&nbsp;</code><code>this</code><code>.studentB = studentB; </code> <code>&nbsp;</code><code>} </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>public</code>&nbsp;<code>StudentA() { </code> <code>&nbsp;</code><code>} </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>public</code>&nbsp;<code>StudentA(StudentB studentB) { </code> <code>&nbsp;</code><code>this</code><code>.studentB = studentB; </code> <code>&nbsp;</code><code>} </code> <code>} </code> </td> 
 </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 </td> 
 <td> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>StudentB { </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>private</code>&nbsp;<code>StudentC studentC ; </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>public</code>&nbsp;<code>void</code>&nbsp;<code>setStudentC(StudentC studentC) { </code> <code>&nbsp;</code><code>this</code><code>.studentC = studentC; </code> <code>&nbsp;</code><code>} </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>public</code>&nbsp;<code>StudentB() { </code> <code>&nbsp;</code><code>} </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>public</code>&nbsp;<code>StudentB(StudentC studentC) { </code> <code>&nbsp;</code><code>this</code><code>.studentC = studentC; </code> <code>&nbsp;</code><code>} </code> <code>} </code> </td> 
 </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 </td> 
 <td> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>StudentC { </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>private</code>&nbsp;<code>StudentA studentA ; </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>public</code>&nbsp;<code>void</code>&nbsp;<code>setStudentA(StudentA studentA) { </code> <code>&nbsp;</code><code>this</code><code>.studentA = studentA; </code> <code>&nbsp;</code><code>} </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>public</code>&nbsp;<code>StudentC() { </code> <code>&nbsp;</code><code>} </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>public</code>&nbsp;<code>StudentC(StudentA studentA) { </code> <code>&nbsp;</code><code>this</code><code>.studentA = studentA; </code> <code>&nbsp;</code><code>} </code> <code>} </code> </td> 
 </tr> 
 </tbody> 
</table>

OK，上面是很基本的3个类，，StudentA有参构造是StudentB。StudentB的有参构造是StudentC，StudentC的有参构造是StudentA ，这样就产生了一个循环依赖的情况，我们都把这三个Bean交给Spring管理，并用有参构造实例化

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>&lt;</code><code>bean</code>&nbsp;<code>id</code><code>=</code><code>"a"</code>&nbsp;<code>class</code><code>=</code><code>"com.zfx.student.StudentA"</code><code>&gt; </code> <code>&nbsp;</code><code>&lt;</code><code>constructor-arg</code>&nbsp;<code>index</code><code>=</code><code>"0"</code>&nbsp;<code>ref</code><code>=</code><code>"b"</code><code>&gt;&lt;/</code><code>constructor-arg</code><code>&gt; </code> <code>&lt;/</code><code>bean</code><code>&gt; </code> <code>&lt;</code><code>bean</code>&nbsp;<code>id</code><code>=</code><code>"b"</code>&nbsp;<code>class</code><code>=</code><code>"com.zfx.student.StudentB"</code><code>&gt; </code> <code>&nbsp;</code><code>&lt;</code><code>constructor-arg</code>&nbsp;<code>index</code><code>=</code><code>"0"</code>&nbsp;<code>ref</code><code>=</code><code>"c"</code><code>&gt;&lt;/</code><code>constructor-arg</code><code>&gt; </code> <code>&lt;/</code><code>bean</code><code>&gt; </code> <code>&lt;</code><code>bean</code>&nbsp;<code>id</code><code>=</code><code>"c"</code>&nbsp;<code>class</code><code>=</code><code>"com.zfx.student.StudentC"</code><code>&gt; </code> <code>&nbsp;</code><code>&lt;</code><code>constructor-arg</code>&nbsp;<code>index</code><code>=</code><code>"0"</code>&nbsp;<code>ref</code><code>=</code><code>"a"</code><code>&gt;&lt;/</code><code>constructor-arg</code><code>&gt; </code> <code>&lt;/</code><code>bean</code><code>&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

下面是测试类：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>Test { </code> <code>&nbsp;</code><code>public</code>&nbsp;<code>static</code>&nbsp;<code>void</code>&nbsp;<code>main(String[] args) { </code> <code>&nbsp;</code><code>ApplicationContext context = </code><code>new</code>&nbsp;<code>ClassPathXmlApplicationContext(</code><code>"com/zfx/student/applicationContext.xml"</code><code>); </code> <code>&nbsp;</code><code>//System.out.println(context.getBean("a", StudentA.class)); </code> <code>&nbsp;</code><code>} </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

执行结果报错信息为：

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?

如果大家理解开头那句话的话，这个报错应该不惊讶，Spring容器先创建单例StudentA，StudentA依赖StudentB，然后将A放在“当前创建Bean池”中，此时创建StudentB,StudentB依赖StudentC ,然后将B放在“当前创建Bean池”中,此时创建StudentC，StudentC又依赖StudentA， 但是，此时Student已经在池中，所以会报错，，因为在池中的Bean都是未初始化完的，所以会依赖错误 ，（初始化完的Bean会从池中移除）

**第二种：setter方式单例，默认方式**

如果要说setter方式注入的话，我们最好先看一张Spring中Bean实例化的图

[![20171118112450825.jpg_2017101811256][]][20171118112450825.jpg_2017101811256]

如图中前两步骤得知：Spring是先将Bean对象实例化之后再设置对象属性的

修改配置文件为set方式注入

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code>&lt;!--scope="singleton"(默认就是单例方式) --&gt;</code> <code>&lt;</code><code>bean</code>&nbsp;<code>id</code><code>=</code><code>"a"</code>&nbsp;<code>class</code><code>=</code><code>"com.zfx.student.StudentA"</code>&nbsp;<code>scope</code><code>=</code><code>"singleton"</code><code>&gt; </code> <code>&nbsp;</code><code>&lt;</code><code>property</code>&nbsp;<code>name</code><code>=</code><code>"studentB"</code>&nbsp;<code>ref</code><code>=</code><code>"b"</code><code>&gt;&lt;/</code><code>property</code><code>&gt; </code> <code>&lt;/</code><code>bean</code><code>&gt; </code> <code>&lt;</code><code>bean</code>&nbsp;<code>id</code><code>=</code><code>"b"</code>&nbsp;<code>class</code><code>=</code><code>"com.zfx.student.StudentB"</code>&nbsp;<code>scope</code><code>=</code><code>"singleton"</code><code>&gt; </code> <code>&nbsp;</code><code>&lt;</code><code>property</code>&nbsp;<code>name</code><code>=</code><code>"studentC"</code>&nbsp;<code>ref</code><code>=</code><code>"c"</code><code>&gt;&lt;/</code><code>property</code><code>&gt; </code> <code>&lt;/</code><code>bean</code><code>&gt; </code> <code>&lt;</code><code>bean</code>&nbsp;<code>id</code><code>=</code><code>"c"</code>&nbsp;<code>class</code><code>=</code><code>"com.zfx.student.StudentC"</code>&nbsp;<code>scope</code><code>=</code><code>"singleton"</code><code>&gt; </code> <code>&nbsp;</code><code>&lt;</code><code>property</code>&nbsp;<code>name</code><code>=</code><code>"studentA"</code>&nbsp;<code>ref</code><code>=</code><code>"a"</code><code>&gt;&lt;/</code><code>property</code><code>&gt; </code> <code>&lt;/</code><code>bean</code><code>&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

下面是测试类：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>Test { </code> <code>&nbsp;</code><code>public</code>&nbsp;<code>static</code>&nbsp;<code>void</code>&nbsp;<code>main(String[] args) { </code> <code>&nbsp;</code><code>ApplicationContext context = </code><code>new</code>&nbsp;<code>ClassPathXmlApplicationContext(</code><code>"com/zfx/student/applicationContext.xml"</code><code>); </code> <code>&nbsp;</code><code>System.out.println(context.getBean(</code><code>"a"</code><code>, StudentA.</code><code>class</code><code>)); </code> <code>&nbsp;</code><code>} </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

打印结果为：

com.zfx.student.StudentA@1fbfd6

**为什么用set方式就不报错了呢 ？**

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

下面是Spring源码中的实现方法，。以下的源码在Spring的Bean包中的DefaultSingletonBeanRegistry.java类中

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 </td> 
 <td> <code>/** Cache of singleton objects: bean name --&gt; bean instance（缓存单例实例化对象的Map集合） */</code> <code>&nbsp;</code><code>private</code>&nbsp;<code>final</code>&nbsp;<code>Map&lt;String, Object&gt; singletonObjects = </code><code>new</code>&nbsp;<code>ConcurrentHashMap&lt;String, Object&gt;(</code><code>64</code><code>); </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>/** Cache of singleton factories: bean name --&gt; ObjectFactory（单例的工厂Bean缓存集合） */</code> <code>&nbsp;</code><code>private</code>&nbsp;<code>final</code>&nbsp;<code>Map&lt;String, ObjectFactory&gt; singletonFactories = </code><code>new</code>&nbsp;<code>HashMap&lt;String, ObjectFactory&gt;(</code><code>16</code><code>); </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>/** Cache of early singleton objects: bean name --&gt; bean instance（早期的单身对象缓存集合） */</code> <code>&nbsp;</code><code>private</code>&nbsp;<code>final</code>&nbsp;<code>Map&lt;String, Object&gt; earlySingletonObjects = </code><code>new</code>&nbsp;<code>HashMap&lt;String, Object&gt;(</code><code>16</code><code>); </code> <code>&nbsp;</code>&nbsp; <code>&nbsp;</code><code>/** Set of registered singletons, containing the bean names in registration order（单例的实例化对象名称集合） */</code> <code>&nbsp;</code><code>private</code>&nbsp;<code>final</code>&nbsp;<code>Set&lt;String&gt; registeredSingletons = </code><code>new</code>&nbsp;<code>LinkedHashSet&lt;String&gt;(</code><code>64</code><code>); </code> <code>&nbsp;</code><code>/** </code> <code>&nbsp;</code><code>* 添加单例实例 </code> <code>&nbsp;</code><code>* 解决循环引用的问题 </code> <code>&nbsp;</code><code>* Add the given singleton factory for building the specified singleton </code> <code>&nbsp;</code><code>* if necessary. </code> <code>&nbsp;</code><code>* &lt;p&gt;To be called for eager registration of singletons, e.g. to be able to </code> <code>&nbsp;</code><code>* resolve circular references. </code> <code>&nbsp;</code><code>* @param beanName the name of the bean </code> <code>&nbsp;</code><code>* @param singletonFactory the factory for the singleton object </code> <code>&nbsp;</code><code>*/</code> <code>&nbsp;</code><code>protected</code>&nbsp;<code>void</code>&nbsp;<code>addSingletonFactory(String beanName, ObjectFactory singletonFactory) { </code> <code>&nbsp;</code><code>Assert.notNull(singletonFactory, </code><code>"Singleton factory must not be null"</code><code>); </code> <code>&nbsp;</code><code>synchronized</code>&nbsp;<code>(</code><code>this</code><code>.singletonObjects) { </code> <code>&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>(!</code><code>this</code><code>.singletonObjects.containsKey(beanName)) { </code> <code>&nbsp;&nbsp;</code><code>this</code><code>.singletonFactories.put(beanName, singletonFactory); </code> <code>&nbsp;&nbsp;</code><code>this</code><code>.earlySingletonObjects.remove(beanName); </code> <code>&nbsp;&nbsp;</code><code>this</code><code>.registeredSingletons.add(beanName); </code> <code>&nbsp;&nbsp;</code><code>} </code> <code>&nbsp;</code><code>} </code> <code>&nbsp;</code><code>} </code> </td> 
 </tr> 
 </tbody> 
</table>

**第三种：setter方式原型，prototype**

对于"prototype"作用域bean，Spring容器无法完成依赖注入，因为Spring容器不进行缓存"prototype"作用域的bean，因此无法提前暴露一个创建中的bean。

修改配置文件为：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>&lt;</code><code>bean</code>&nbsp;<code>id</code><code>=</code><code>"a"</code>&nbsp;<code>class</code><code>=</code><code>"com.zfx.student.StudentA"</code>&nbsp;<code>&lt;span </code><code>style</code><code>=</code><code>"color:#FF0000;"</code><code>&gt;scope="prototype"&lt;/</code><code>span</code><code>&gt;&gt; </code> <code>&nbsp;</code><code>&lt;</code><code>property</code>&nbsp;<code>name</code><code>=</code><code>"studentB"</code>&nbsp;<code>ref</code><code>=</code><code>"b"</code><code>&gt;&lt;/</code><code>property</code><code>&gt; </code> <code>&nbsp;</code><code>&lt;/</code><code>bean</code><code>&gt; </code> <code>&nbsp;</code><code>&lt;</code><code>bean</code>&nbsp;<code>id</code><code>=</code><code>"b"</code>&nbsp;<code>class</code><code>=</code><code>"com.zfx.student.StudentB"</code>&nbsp;<code>&lt;span </code><code>style</code><code>=</code><code>"color:#FF0000;"</code><code>&gt;scope="prototype"&lt;/</code><code>span</code><code>&gt;&gt; </code> <code>&nbsp;</code><code>&lt;</code><code>property</code>&nbsp;<code>name</code><code>=</code><code>"studentC"</code>&nbsp;<code>ref</code><code>=</code><code>"c"</code><code>&gt;&lt;/</code><code>property</code><code>&gt; </code> <code>&nbsp;</code><code>&lt;/</code><code>bean</code><code>&gt; </code> <code>&nbsp;</code><code>&lt;</code><code>bean</code>&nbsp;<code>id</code><code>=</code><code>"c"</code>&nbsp;<code>class</code><code>=</code><code>"com.zfx.student.StudentC"</code>&nbsp;<code>&lt;span </code><code>style</code><code>=</code><code>"color:#FF0000;"</code><code>&gt;scope="prototype"&lt;/</code><code>span</code><code>&gt;&gt; </code> <code>&nbsp;</code><code>&lt;</code><code>property</code>&nbsp;<code>name</code><code>=</code><code>"studentA"</code>&nbsp;<code>ref</code><code>=</code><code>"a"</code><code>&gt;&lt;/</code><code>property</code><code>&gt; </code> <code>&nbsp;</code><code>&lt;/</code><code>bean</code><code>&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

scope="prototype" 意思是 每次请求都会创建一个实例对象。两者的区别是：有状态的bean都使用Prototype作用域，无状态的一般都使用singleton单例作用域。

测试用例：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>Test { </code> <code>&nbsp;</code><code>public</code>&nbsp;<code>static</code>&nbsp;<code>void</code>&nbsp;<code>main(String[] args) { </code> <code>&nbsp;</code><code>ApplicationContext context = </code><code>new</code>&nbsp;<code>ClassPathXmlApplicationContext(</code><code>"com/zfx/student/applicationContext.xml"</code><code>); </code> <code>&nbsp;</code><code>&lt;strong&gt;</code><code>//此时必须要获取Spring管理的实例，因为现在scope="prototype" 只有请求获取的时候才会实例化对象&lt;/strong&gt; </code> <code>&nbsp;</code><code>System.out.println(context.getBean(</code><code>"a"</code><code>, StudentA.</code><code>class</code><code>)); </code> <code>&nbsp;</code><code>} </code> <code>} </code> </td> 
 </tr> 
 </tbody> 
</table>

打印结果：

**为什么原型模式就报错了呢 ？**

对于“prototype”作用域Bean，Spring容器无法完成依赖注入，因为“prototype”作用域的Bean，Spring容  
器不进行缓存，因此无法提前暴露一个创建中的Bean。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

*  [详解Spring Bean的循环依赖解决方案][Spring Bean]
 *  [Spring循环依赖正确性及Bean注入的顺序关系详解][Spring_Bean]
 *  [spring循环依赖策略解析][spring]
 *  [Spring循环依赖的三种方式(推荐)][Spring]

[https_www.cnblogs.com_tiger-fu_p_8961361.html]: https://www.cnblogs.com/tiger-fu/p/8961361.html
[20171118112450825.jpg_2017101811256]: /images/20210527/3e488ec5d5f0470099a816f8053b2255.png
[Spring Bean]: http://www.jb51.net/article/133871.htm
[Spring_Bean]: http://www.jb51.net/article/132355.htm
[spring]: http://www.jb51.net/article/123385.htm
[Spring]: http://www.jb51.net/article/133875.htm