Spring循环依赖的三种方式

灰太狼 2022-01-16 05:51 261阅读 0赞

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][]

![1240][]

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

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

Spring容器会将每一个正在创建的Bean 标识符放在一个“当前创建Bean池”中，Bean标识符在创建过程中将一直保持在这个池中。

因此如果在创建Bean过程中发现自己已经在“当前创建Bean池”里时将抛出BeanCurrentlyInCreationException异常表示循环依赖；而对于创建完毕的Bean将从“当前创建Bean池”中清除掉。

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

public class StudentA {
    
        private StudentB studentB ;
    
        public void setStudentB(StudentB studentB) {
            this.studentB = studentB;
        }
    
        public StudentA() {
        }
    
        public StudentA(StudentB studentB) {
            this.studentB = studentB;
        }
    }

public class StudentB {
    
        private StudentC studentC ;
    
        public void setStudentC(StudentC studentC) {
            this.studentC = studentC;
        }
    
        public StudentB() {
        }
    
        public StudentB(StudentC studentC) {
            this.studentC = studentC;
        }
    }

public class StudentC {
    
        private StudentA studentA ;
    
        public void setStudentA(StudentA studentA) {
            this.studentA = studentA;
        }
    
        public StudentC() {
        }
    
        public StudentC(StudentA studentA) {
            this.studentA = studentA;
        }
    }

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

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

下面是测试类：

执行结果报错信息为：

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容器先][Spring 1]创建单例StudentA，StudentA依赖StudentB，然后将A放在“当前创建Bean池”中，此时创建StudentB,StudentB依赖StudentC ,然后将B放在“当前创建Bean池”中,此时创建StudentC，StudentC又依赖StudentA， 但是，此时Student已经在池中，所以会报错，，因为在池中的Bean都是未初始化完的，所以会依赖错误 ，（初始化完的Bean会从池中移除）

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

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

![1240 1][]

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

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

<bean id="a" class="com.zfx.student.StudentA" scope="singleton">
            <property name="studentB" ref="b"></property>
        </bean>
        <bean id="b" class="com.zfx.student.StudentB" scope="singleton">
            <property name="studentC" ref="c"></property>
        </bean>
        <bean id="c" class="com.zfx.student.StudentC" scope="singleton">
            <property name="studentA" ref="a"></property>
        </bean>

下面是测试类：

打印结果为：

com.zfx.student.StudentA@1fbfd6

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

我们结合上面那张图看，[Spring先是用构造实例化][Spring 2]Bean对象 ，此时Spring会将这个实例化结束的对象放到一个Map中，并且Spring提供了获取这个未设置属性的实例化对象引用的方法。

结合我们的实例来看，，当Spring实例化了StudentA、StudentB、StudentC后，紧接着会去设置对象的属性，此时StudentA依赖StudentB，就会去Map中取出存在里面的单例StudentB对象，以此类推，不会出来循环的问题喽、

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

/** Cache of singleton objects: bean name --> bean instance（缓存单例实例化对象的Map集合） */
        private final Map<String, Object> singletonObjects = new ConcurrentHashMap<String, Object>(64);
    
        /** Cache of singleton factories: bean name --> ObjectFactory（单例的工厂Bean缓存集合） */
        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);
    
        /** Set of registered singletons, containing the bean names in registration order（单例的实例化对象名称集合） */
        private final Set<String> registeredSingletons = new LinkedHashSet<String>(64);
        /**
         * 添加单例实例
         * 解决循环引用的问题
         * Add the given singleton factory for building the specified singleton
         * if necessary.
         * <p>To be called for eager registration of singletons, e.g. to be able to
         * resolve circular references.
         * @param beanName the name of the bean
         * @param singletonFactory the factory for the singleton object
         */
        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);
                }
            }
        }

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

修改配置文件为：

<bean id="a" class="com.zfx.student.StudentA" scope="prototype">
            <property name="studentB" ref="b"></property>
        </bean>
        <bean id="b" class="com.zfx.student.StudentB" scope="prototype">
            <property name="studentC" ref="c"></property>
        </bean>
        <bean id="c" class="com.zfx.student.StudentC" scope="prototype">
            <property name="studentA" ref="a"></property>
        </bean>

scope="prototype" 意思是 每次请求都会创建一个实例对象。

两者的区别是：有状态的bean都使用Prototype作用域，无状态的一般都使用singleton单例作用域。

测试用例：

public class Test {
        public static void main(String[] args) {
            ApplicationContext context = new ClassPathXmlApplicationContext("com/zfx/student/applicationContext.xml");
            //此时必须要获取Spring管理的实例，因为现在scope="prototype" 只有请求获取的时候才会实例化对象
            System.out.println(context.getBean("a", StudentA.class));
        }
    }

打印结果：

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

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

***扩展阅读***

[轻松了解Spring中的控制反转和依赖注入][Link 2]

[我故意写了个死循环][Link 3]

[Spring Boot教你一种方法生成全局唯一ID][Spring Boot_ID]

[SpringBoot几种定时任务的实现方式][SpringBoot]

[一张图看懂 SQL 的各种 join 用法][SQL _ join]

> 作者：学习园

转载于:https://my.oschina.net/javafirst/blog/3049038

[2019_Python_]: https://my.oschina.net/u/2663968/blog/3061697
[hot3.png]: /images/20220114/6d9f5b7afd344ea2a243dd09c5fa58e4.png
[1240]: /images/20220114/287b2d44b74540f488ada3746ce3adfd.png
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzU5NTAzNjM0Mw==&mid=2247486412&idx=1&sn=cf41ae28ebd559cf25795180e0563d2b&chksm=fe795a14c90ed3022b8ded02f53d83c1e9edd7dbeffe51874f5f308d7e31218c82b1656f7ffe&scene=21#wechat_redirect
[Spring]: http://mp.weixin.qq.com/s?__biz=MzU5NTAzNjM0Mw==&mid=2247486209&idx=1&sn=b38f8cab0bc2f00fb2818c4ed43e8431&chksm=fe795ad9c90ed3cf59ee5c0e779ebd58cd112670c37bc982f8a26cb5941e36c09100897d05ab&scene=21#wechat_redirect
[Spring 1]: http://mp.weixin.qq.com/s?__biz=MzU5NTAzNjM0Mw==&mid=2247485259&idx=2&sn=d663a263856f2a0fd9b96099b8ef8a44&chksm=fe795693c90edf85f6e0162d15aed593256bd5e7ab3aca4359c758b968714dc43e62b511509b&scene=21#wechat_redirect
[1240 1]: /images/20220114/8f1471b17bea470cade1c0169796201a.png
[Spring 2]: http://mp.weixin.qq.com/s?__biz=MzU5NTAzNjM0Mw==&mid=2247485155&idx=3&sn=421080b32ff7d8dc14d4b730b6a4c786&chksm=fe79573bc90ede2dede89aa625ec5991737a6b55124fca5bbcaa95e084ce979d0a4b9c4d4620&scene=21#wechat_redirect
[Link 2]: http://mp.weixin.qq.com/s?__biz=MzU5NTAzNjM0Mw==&mid=2247484841&idx=1&sn=a097d61981352017c94aec7664327e05&chksm=fe795471c90edd6701d98444751d6d49a9c3ebdaa57d4d3a24bb6bc7fa2d83325830699e8043&scene=21#wechat_redirect
[Link 3]: http://mp.weixin.qq.com/s?__biz=MzU5NTAzNjM0Mw==&mid=2247485849&idx=1&sn=cb3d28b9685fb925ebdb86470c23b6d6&chksm=fe795841c90ed1572a1a1417d54df6ef9cf4598835df4af3e605e2c8824d0ab10fd37b2c42a3&scene=21#wechat_redirect
[Spring Boot_ID]: http://mp.weixin.qq.com/s?__biz=MzU5NTAzNjM0Mw==&mid=2247485856&idx=1&sn=c78caf01dbba47e9980b3d609a42a006&chksm=fe795878c90ed16ecfd670cc88e2b8952ec724cd94ff13114d88be36ad3790a357bd27332528&scene=21#wechat_redirect
[SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzU5NTAzNjM0Mw==&mid=2247486385&idx=2&sn=d87c2f688c01a68ac13495e5f1c49a11&chksm=fe795a69c90ed37f22924c4582ddd0c3a1f8c433d5eb948cbd2953727fe645140f5ba9602911&scene=21#wechat_redirect
[SQL _ join]: http://mp.weixin.qq.com/s?__biz=MzU5NTAzNjM0Mw==&mid=2247486222&idx=2&sn=86d473e6bf331487f6bfe49620642593&chksm=fe795ad6c90ed3c0a551a1dbbbcf1c1a378055faead2ce61900e3ade024ddf3cea5aac08ec2a&scene=21#wechat_redirect