Spring 循环依赖

最新推荐文章于 2024-09-17 14:51:09 发布

carl-zhao

最新推荐文章于 2024-09-17 14:51:09 发布

阅读量3.1k

点赞数

分类专栏： Spring Framework 文章标签： spring IOC DI 循环依赖

Spring Framework 专栏收录该内容

54 篇文章 2 订阅

订阅专栏

循环依赖就是循环引用，就是两个或多个Bean相互之间的持有对方，比如CircleA引用CircleB，CircleB引用CircleC，CircleC引用CircleA，则它们最终反映为一个环。此处不是循环调用，循环调用是方法之间的环调用。如下图所示：

这里写图片描述

循环调用是无法解决的，除非有终结条件，否则就是死循环，最终导致内存溢出错误。

Spring容器循环依赖包括构造器循环依赖和setter循环依赖，那Spring容器如何解决循环依赖呢？首先让我们来定义三个循环引用类：

CircleA.java

public class CircleA {

    private CircleB circleB;
    public CircleA() {
    }
    public CircleA(CircleB circleB) {
        this.circleB = circleB;
    }
    public void setCircleB(CircleB circleB)
    {
        this.circleB = circleB;
    }
    public void a() {
        circleB.b();
    }

}

CircleB.java

public class CircleB {

    private CircleC circleC;
    public CircleB() {
    }
    public CircleB(CircleC circleC) {
        this.circleC = circleC;
    }
    public void setCircleC(CircleC circleC)
    {
        this.circleC = circleC;
    }
    public void b() {
        circleC.c();
    }

}

CircleC.java

public class CircleC {

    private CircleA circleA;
    public CircleC() {
    }
    public CircleC(CircleA circleA) {
        this.circleA = circleA;
    }
    public void setCircleA(CircleA circleA)
    {
        this.circleA = circleA;
    }
    public void c() {
        circleA.a();
    }

}

1、构造器循环依赖

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

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

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

circleInjectByConstructor.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans 
       http://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="circleA" class="com.spring.framework.carl.ioc.CircleA">
        <constructor-arg index="0" ref="circleB" />
    </bean>

    <bean id="circleB" class="com.spring.framework.carl.ioc.CircleB">
        <constructor-arg index="0" ref="circleC" />
    </bean>

    <bean id="circleC" class="com.spring.framework.carl.ioc.CircleC">
        <constructor-arg index="0" ref="circleA" />
    </bean>

</beans>

测试方法：

@Test(expected = BeanCurrentlyInCreationException.class)
public void testCircleByConstructor() throws Throwable {
    try{
        new ClassPathXmlApplicationContext("circleInjectByConstructor.xml");
    } catch (Exception e){
        // 因为要在创建circle3时抛出；
        Throwable e1 = e.getCause().getCause().getCause();
        throw e1;
    }
}

让我们分析一下吧：

Spring容器创建“circleA” Bean，首先去“当前创建Bean池”查找是否当前Bean正在创建，如果没发现，则继续准备其需要的构造器参数“circleB”，并将“circleA” 标识符放到“当前创建Bean池”；
Spring容器创建“circleB” Bean，首先去“当前创建Bean池”查找是否当前Bean正在创建，如果没发现，则继续准备其需要的构造器参数“circleC”，并将“circleB” 标识符放到“当前创建Bean池”；
Spring容器创建“circleC” Bean，首先去“当前创建Bean池”查找是否当前Bean正在创建，如果没发现，则继续准备其需要的构造器参数“circleA”，并将“circleC” 标识符放到“当前创建Bean池”；
到此为止Spring容器要去创建“circleA”Bean，发现该Bean 标识符在“当前创建Bean池”中，因为表示循环依赖，抛出BeanCurrentlyInCreationException。

2、setter循环依赖(singleton)

setter循环依赖：表示通过setter注入方式构成的循环依赖。

对于setter注入造成的依赖是通过Spring容器提前暴露刚完成构造器注入但未完成其他步骤（如setter注入）的Bean来完成的，而且只能解决单例作用域的Bean循环依赖。

如下代码所示，通过提前暴露一个单例工厂方法，从而使其他Bean能引用到该Bean。

addSingletonFactory(beanName, new ObjectFactory() {  
    public Object getObject() throws BeansException {  
        return getEarlyBeanReference(beanName, mbd, bean);  
    }  
});

具体步骤如下：

Spring容器创建单例“circleA” Bean，首先根据无参构造器创建Bean，并暴露一个“ObjectFactory ”用于返回一个提前暴露一个创建中的Bean，并将“circleA” 标识符放到“当前创建Bean池”；然后进行setter注入“circleB”；
Spring容器创建单例“circleB” Bean，首先根据无参构造器创建Bean，并暴露一个“ObjectFactory”用于返回一个提前暴露一个创建中的Bean，并将“circleB” 标识符放到“当前创建Bean池”，然后进行setter注入“circleC”；
Spring容器创建单例“circleC” Bean，首先根据无参构造器创建Bean，并暴露一个“ObjectFactory ”用于返回一个提前暴露一个创建中的Bean，并将“circleC” 标识符放到“当前创建Bean池”，然后进行setter注入“circleA”；进行注入“circleA”时由于提前暴露了“ObjectFactory”工厂从而使用它返回提前暴露一个创建中的Bean；
最后在依赖注入“circleB”和“circleA”，完成setter注入。

circleInjectBySetterSingleton.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans 
       http://www.springframework.org/schema/beans/spring-beans.xsd">


    <bean id="circleA" class="com.spring.framework.carl.ioc.CircleA">
        <property name="circleB" ref="circleB" />
    </bean>

    <bean id="circleB" class="com.spring.framework.carl.ioc.CircleB">
        <property name="circleC" ref="circleC" />
    </bean>

    <bean id="circleC" class="com.spring.framework.carl.ioc.CircleC">
        <property name="circleA" ref="circleA" />
    </bean>

</beans>

测试方法：

@Test
public void testCircleBySetterSingleton(){
    new ClassPathXmlApplicationContext("circleInjectBySetterSingleton.xml");
}

3、setter循环依赖(非singleton)

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

circleInjectBySetterNotSingleton.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans 
       http://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="circleA" class="com.spring.framework.carl.ioc.CircleA" scope="prototype">
        <property name="circleB" ref="circleB" />
    </bean>

    <bean id="circleB" class="com.spring.framework.carl.ioc.CircleB" scope="prototype">
        <property name="circleC" ref="circleC" />
    </bean>

    <bean id="circleC" class="com.spring.framework.carl.ioc.CircleC" scope="prototype">
        <property name="circleA" ref="circleA" />
    </bean>

</beans>

测试方法：

@Test(expected = BeanCurrentlyInCreationException.class)
public void testCircleBySetterNotSingleton() throws Throwable {
    try {
        ApplicationContext context = new ClassPathXmlApplicationContext("circleInjectBySetterNotSingleton.xml");
        System.out.println(context.getBean("circleA"));
    } catch (Exception e){
        // 因为要在创建circle3时抛出；
        Throwable e1 = e.getCause().getCause().getCause();
        throw e1;
    }
}

4、setter循环依赖(singleton设置不允许依赖注入)

在Spring IOC中对于singleton作用域Bean,可以通过setAllowCircularReferences(false);来禁用循环引用：

测试方法：

@Test(expected = BeanCurrentlyInCreationException.class)  
public void testCircleBySetterAndSingleton2() throws Throwable {  
    try {  
        ClassPathXmlApplicationContext ctx =  
new ClassPathXmlApplicationContext();  
        ctx.setConfigLocation("chapter3/circleInjectBySetterAndSingleton.xml");  
        ctx.refresh();  
    }  
    catch (Exception e) {  
        Throwable e1 = e.getCause().getCause().getCause();  
        throw e1;  
    }  
}

5、循环调用

循环调用是无法解决的，除非有终结条件，否则就是死循环，最终导致内存溢出错误。

测试方法：

@Test(expected = StackOverflowError.class)
public void testCircleInvokeMethod(){
    ApplicationContext context = new ClassPathXmlApplicationContext("circleInjectBySetterSingleton.xml");
    CircleA circleA = context.getBean("circleA", CircleA.class);
    circleA.a();
}

补充：出现循环依赖是设计上的问题，一定要避免！

请参考《敏捷软件开发：原则、模式与实践》中的“无环依赖”原则