spring:我是如何解決循環依賴的?

1.由同事拋的一個問題開始

最近項目組的一個同事遇到了一個問題,問我的意見,一下子引起的我的興趣,因爲這個問題我也是第一次遇到。平時自認爲對spring循環依賴問題還是比較瞭解的,直到遇到這個和後面的幾個問題後,重新刷新了我的認識。

我們先看看當時出問題的代碼片段:


   
   
   
@Service
public class TestService1 {

@Autowired
private TestService2 testService2;

@Async
public void test1() {
}
}

   
   
   
@Service
public class TestService2 {

@Autowired
private TestService1 testService1;

public void test2() {
}
}

這兩段代碼中定義了兩個Service類:TestService1TestService2,在TestService1中注入了TestService2的實例,同時在TestService2中注入了TestService1的實例,這裏構成了循環依賴

只不過,這不是普通的循環依賴,因爲TestService1的test1方法上加了一個@Async註解。

大家猜猜程序啓動後運行結果會怎樣?

org.springframework.beans.factory.BeanCurrentlyInCreationException: Error creating bean with name 'testService1': Bean with name 'testService1' has been injected into other beans [testService2] in its raw version as part of a circular reference, but has eventually been wrapped. This means that said other beans do not use the final version of the bean. This is often the result of over-eager type matching - consider using 'getBeanNamesOfType' with the 'allowEagerInit' flag turned off, for example.

報錯了。。。原因是出現了循環依賴。

「不科學呀,spring不是號稱能解決循環依賴問題嗎,怎麼還會出現?」

如果把上面的代碼稍微調整一下:


   
   
   
@Service
public class TestService1 {

@Autowired
private TestService2 testService2;

public void test1() {
}
}

把TestService1的test1方法上的@Async註解去掉,TestService1TestService2都需要注入對方的實例,同樣構成了循環依賴。

但是重新啓動項目,發現它能夠正常運行。這又是爲什麼?

帶着這兩個問題,讓我們一起開始spring循環依賴的探祕之旅。

 

2.什麼是循環依賴?

循環依賴:說白是一個或多個對象實例之間存在直接或間接的依賴關係,這種依賴關係構成了構成一個環形調用。

第一種情況:自己依賴自己的直接依賴

第二種情況:兩個對象之間的直接依賴

第三種情況:多個對象之間的間接依賴

前面兩種情況的直接循環依賴比較直觀,非常好識別,但是第三種間接循環依賴的情況有時候因爲業務代碼調用層級很深,不容易識別出來。

 

3.循環依賴的N種場景

spring中出現循環依賴主要有以下場景:

單例的setter注入

這種注入方式應該是spring用的最多的,代碼如下:


   
   
   
@Service
public class TestService1 {

@Autowired
private TestService2 testService2;

public void test1() {
}
}

   
   
   
@Service
public class TestService2 {

@Autowired
private TestService1 testService1;

public void test2() {
}
}

這是一個經典的循環依賴,但是它能正常運行,得益於spring的內部機制,讓我們根本無法感知它有問題,因爲spring默默幫我們解決了。

spring內部有三級緩存:

  • singletonObjects 一級緩存,用於保存實例化、注入、初始化完成的bean實例
  • earlySingletonObjects 二級緩存,用於保存實例化完成的bean實例
  • singletonFactories 三級緩存,用於保存bean創建工廠,以便於後面擴展有機會創建代理對象。
下面用一張圖告訴你,spring是如何解決循環依賴的:

細心的朋友可能會發現在這種場景中第二級緩存作用不大。
那麼問題來了,爲什麼要用第二級緩存呢?
試想一下,如果出現以下這種情況,我們要如何處理?

@Service
public class TestService1 {

@Autowired
private TestService2 testService2;
@Autowired
private TestService3 testService3;

public void test1() {
}
}

@Service
public class TestService2 {

@Autowired
private TestService1 testService1;

public void test2() {
}
}

@Service
public class TestService3 {

@Autowired
private TestService1 testService1;

public void test3() {
}
}

TestService1依賴於TestService2和TestService3,而TestService2依賴於TestService1,同時TestService3也依賴於TestService1。
按照上圖的流程可以把TestService1注入到TestService2,並且TestService1的實例是從第三級緩存中獲取的。
假設不用第二級緩存,TestService1注入到TestService3的流程如圖:

TestService1注入到TestService3又需要從第三級緩存中獲取實例,而第三級緩存裏保存的並非真正的實例對象,而是 ObjectFactory 對象。說白了,兩次從三級緩存中獲取都是 ObjectFactory 對象,而通過它創建的實例對象每次可能都不一樣的。
這樣不是有問題?
爲了解決這個問題,spring引入的第二級緩存。上面圖1其實TestService1對象的實例已經被添加到第二級緩存中了,而在TestService1注入到TestService3時,只用從第二級緩存中獲取該對象即可。

還有個問題,第三級緩存中爲什麼要添加 ObjectFactory 對象,直接保存實例對象不行嗎?
答:不行,因爲假如你想對添加到三級緩存中的實例對象進行增強,直接用實例對象是行不通的。
針對這種場景spring是怎麼做的呢?
答案就在 AbstractAutowireCapableBeanFactory doCreateBean 方法的這段代碼中:

它定義了一個匿名內部類,通過 getEarlyBeanReference 方法獲取代理對象,其實底層是通過 AbstractAutoProxyCreator 類的 getEarlyBeanReference 生成代理對象。

多例的setter注入

這種注入方法偶然會有,特別是在多線程的場景下,具體代碼如下:

@Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
@Service
public class TestService1 {

@Autowired
private TestService2 testService2;

public void test1() {
}
}

@Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
@Service
public class TestService2 {

@Autowired
private TestService1 testService1;

public void test2() {
}
}

很多人說這種情況spring容器啓動會報錯,其實是不對的,我非常負責任的告訴你程序能夠正常啓動。
爲什麼呢?
其實在 AbstractApplicationContext 類的 refresh 方法中告訴了我們答案,它會調用 finishBeanFactoryInitialization 方法,該方法的作用是爲了spring容器啓動的時候提前初始化一些bean。該方法的內部又調用了 preInstantiateSingletons 方法

標紅的地方明顯能夠看出:非抽象、單例 並且非懶加載的類才能被提前初始bean。
而多例即 SCOPE_PROTOTYPE 類型的類,非單例,不會被提前初始化bean,所以程序能夠正常啓動。
如何讓他提前初始化bean呢?
只需要再定義一個單例的類,在它裏面注入TestService1

@Service
public class TestService3 {

@Autowired
private TestService1 testService1;
}

重新啓動程序,執行結果:

   
   
   
Requested bean is currently in creation: Is there an unresolvable circular reference?
果然出現了循環依賴。
注意:這種循環依賴問題是無法解決的,因爲它沒有用緩存,每次都會生成一個新對象。

構造器注入

這種注入方式現在其實用的已經非常少了,但是我們還是有必要了解一下,看看如下代碼:

@Service
public class TestService1 {

public TestService1(TestService2 testService2) {
}
}

@Service
public class TestService2 {

public TestService2(TestService1 testService1) {
}
}

運行結果:

   
   
   
Requested bean is currently in creation: Is there an unresolvable circular reference?
出現了循環依賴,爲什麼呢?
從圖中的流程看出構造器注入沒能添加到三級緩存,也沒有使用緩存,所以也無法解決循環依賴問題。

單例的代理對象setter注入

這種注入方式其實也比較常用,比如平時使用: @Async 註解的場景,會通過 AOP 自動生成代理對象。
我那位同事的問題也是這種情況。

@Service
public class TestService1 {

@Autowired
private TestService2 testService2;

@Async
public void test1() {
}
}

@Service
public class TestService2 {

@Autowired
private TestService1 testService1;

public void test2() {
}
}

從前面得知程序啓動會報錯,出現了循環依賴:

   
   
   
org.springframework.beans.factory.BeanCurrentlyInCreationException: Error creating bean with name 'testService1': Bean with name 'testService1' has been injected into other beans [testService2] in its raw version as part of a circular reference, but has eventually been wrapped. This means that said other beans do not use the final version of the bean. This is often the result of over-eager type matching - consider using 'getBeanNamesOfType' with the 'allowEagerInit' flag turned off, for example.
爲什麼會循環依賴呢?
答案就在下面這張圖中:
說白了,bean初始化完成之後,後面還有一步去檢查:第二級緩存 和 原始對象 是否相等。由於它對前面流程來說無關緊要,所以前面的流程圖中省略了,但是在這裏是關鍵點,我們重點說說:
那位同事的問題正好是走到這段代碼,發現第二級緩存 和 原始對象不相等,所以拋出了循環依賴的異常。
如果這時候把TestService1改個名字,改成:TestService6,其他的都不變。

@Service
publicclass TestService6 {

@Autowired
private TestService2 testService2;

@Async
public void test1() {
}
}

再重新啓動一下程序,神奇般的好了。
what? 這又是爲什麼?
這就要從spring的bean加載順序說起了,默認情況下,spring是按照文件完整路徑遞歸查找的,按路徑+文件名排序,排在前面的先加載。所以TestService1比TestService2先加載,而改了文件名稱之後,TestService2比TestService6先加載。
爲什麼TestService2比TestService6先加載就沒問題呢?
答案在下面這張圖中:
這種情況testService6中其實第二級緩存是空的,不需要跟原始對象判斷,所以不會拋出循環依賴。

DependsOn循環依賴

還有一種有些特殊的場景,比如我們需要在實例化Bean A之前,先實例化Bean B,這個時候就可以使用 @DependsOn 註解。

@DependsOn(value = "testService2")
@Service
public class TestService1 {

@Autowired
private TestService2 testService2;

public void test1() {
}
}

@DependsOn(value = "testService1")
@Service
public class TestService2 {

@Autowired
private TestService1 testService1;

public void test2() {
}
}

程序啓動之後,執行結果:

   
   
   
Circular depends-on relationship between 'testService2' and 'testService1'
這個例子中本來如果TestService1和TestService2都沒有加 @DependsOn 註解是沒問題的,反而加了這個註解會出現循環依賴問題。
這又是爲什麼?
答案在 AbstractBeanFactory 類的 doGetBean 方法的這段代碼中:

它會檢查dependsOn的實例有沒有循環依賴,如果有循環依賴則拋異常。

 

4.出現循環依賴如何解決?

項目中如果出現循環依賴問題,說明是spring默認無法解決的循環依賴,要看項目的打印日誌,屬於哪種循環依賴。目前包含下面幾種情況:

生成代理對象產生的循環依賴

這類循環依賴問題解決方法很多,主要有:
  1. 使用 @Lazy 註解,延遲加載
  2. 使用 @DependsOn 註解,指定加載先後關係
  3. 修改文件名稱,改變循環依賴類的加載順序

使用@DependsOn產生的循環依賴

這類循環依賴問題要找到 @DependsOn 註解循環依賴的地方,迫使它不循環依賴就可以解決問題。

多例循環依賴

這類循環依賴問題可以通過把bean改成單例的解決。

構造器循環依賴

這類循環依賴問題可以通過使用 @Lazy 註解解決。

有道無術,術可成;有術無道,止於術

歡迎大家關注Java之道公衆號


好文章,我在看❤️

本文分享自微信公衆號 - Hollis(hollischuang)。
如有侵權,請聯繫 [email protected] 刪除。
本文參與“OSC源創計劃”,歡迎正在閱讀的你也加入,一起分享。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章