spring學習——Ioc基礎四（Di之循環依賴）

1、 什麼是循環依賴

       循環依賴就是循環引用，就是兩個或多個Bean相互之間的持有對方，好比CircleA引用CircleB，CircleB引用CircleC，CircleC引用CircleA，則它們最終反映爲一個環。此處不是循環調用，循環調用是方法之間的環調用。如圖3-5所示：

 

圖3-5 循環引用

       循環調用是沒法解決的，除非有終結條件，不然就是死循環，最終致使內存溢出錯誤。

       Spring容器循環依賴包括構造器循環依賴和setter循環依賴，那Spring容器如何解決循環依賴呢？首先讓咱們來定義循環引用類：

package cn.javass.spring.chapter3.bean;  
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();  
    }  
}

package cn.javass.spring.chapter3.bean;  
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();  
    }  
}

package cn.javass.spring.chapter3.bean;  
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();  
    }  
}

2、Spring如何解決循環依

一、構造器循環依賴：表示經過構造器注入構成的循環依賴，此依賴是沒法解決的，只能拋出BeanCurrentlyInCreationException異常表示循環依賴。

如在建立CircleA類時，構造器須要CircleB類，那將去建立CircleB，在建立CircleB類時又發現須要CircleC類，則又去建立CircleC，最終在建立CircleC時發現又須要CircleA；從而造成一個環，沒辦法建立。

Spring容器將每個正在建立的Bean 標識符放在一個「當前建立Bean池」中，Bean標識符在建立過程當中將一直保持在這個池中，所以若是在建立Bean過程當中發現本身已經在「當前建立Bean池」裏時將拋出BeanCurrentlyInCreationException異常表示循環依賴；而對於建立完畢的Bean將從「當前建立Bean池」中清除掉。

       1）首先讓咱們看一下配置文件（chapter3/circleInjectByConstructor.xml）：

<bean id="circleA" class="cn.javass.spring.chapter3.bean.CircleA">  
    <constructor-arg index="0" ref="circleB"/>  
</bean>  
<bean id="circleB" class="cn.javass.spring.chapter3.bean.CircleB">  
    <constructor-arg index="0" ref="circleC"/>  
</bean>  
<bean id="circleC" class="cn.javass.spring.chapter3.bean.CircleC">  
    <constructor-arg index="0" ref="circleA"/>  
</bean>

     2）寫段測試代碼（cn.javass.spring.chapter3.CircleTest）測試一下吧：

@Test(expected = BeanCurrentlyInCreationException.class)  
public void testCircleByConstructor() throws Throwable {  
    try {  
          new ClassPathXmlApplicationContext("chapter3/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。

二、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注入。

         對於「prototype」做用域Bean，Spring容器沒法完成依賴注入，由於「prototype」做用域的Bean，Spring容器不進行緩存，所以沒法提早暴露一個建立中的Bean。

<!-- 定義Bean配置文件，注意scope都是「prototype」-->  
<bean id="circleA" class="cn.javass.spring.chapter3.bean.CircleA" scope="prototype">  
    <property name="circleB" ref="circleB"/>  
</bean>  
<bean id="circleB" class="cn.javass.spring.chapter3.bean.CircleB" scope="prototype">  
    <property name="circleC" ref="circleC"/>  
</bean>  
<bean id="circleC" class="cn.javass.spring.chapter3.bean.CircleC" scope="prototype">  
    <property name="circleA" ref="circleA"/>  
</bean>

//測試代碼cn.javass.spring.chapter3.CircleTest  
@Test(expected = BeanCurrentlyInCreationException.class)  
public void testCircleBySetterAndPrototype () throws Throwable {  
    try {  
        ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext(  
        "chapter3/circleInjectBySetterAndPrototype.xml");  
        System.out.println(ctx.getBean("circleA"));  
    }catch (Exception e) {  
        Throwable e1 = e.getCause().getCause().getCause();  
        throw e1;  
    }  
}

對於「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;  
    }  
}

補充：出現循環依賴是設計上的問題，必定要避免！

請參Kao《敏捷軟件開發：原則、模式與實踐》中的「無環依賴」原則

包之間的依賴結構必須是一個直接的無環圖形（DAG）。也就是說，在依賴結構中不容許出現環（循環依賴）。