展開說說，Spring Bean IOC、AOP 循環依賴

作者：小傅哥
部落格：//bugstack.cn

沉澱、分享、成長，讓自己和他人都能有所收穫！😄

一、前言

延遲滿足能給你帶來什麼？

大學有四年時間，但幾乎所有人都是臨近畢業才發現找一份好工作費勁，尤其是我能非常熟悉的軟體開發行業，即使是畢業了還需要額外花錢到培訓機構，在學一遍編程技術才能出去找工作。好像在校這幾年壓根就沒學到什麼！

就我個人而言可能是因為上學期間喜歡編程，也從師哥、師姐那裡聽到一些關於畢業後找工作的不容易，也了解了一些社會上對程式設計師開發技能的要求級別。也就是得到了這些消息，又加上自己樂於折騰，我給自己定了一個每天都能完成的小目標：

紅塵世界幾個王，我自不服迎頭上。
日敲程式碼兩百行，衝進世界五百強。

哈哈哈，就這麼每天兩百行程式碼，一個月就是6千行，一年就是6萬行，三年後開始實習就有18萬行，一個應屆實習生有將近20萬行程式碼的敲擊量，幾乎已經可以非常熟練的完成各類簡單的工作，在加上實習中對整個項目流程真正的斷鏈後，找一個正經的開發工作，還是很容易的。

而這時候找工作的容易，就來自於你一直以來的學習和沉澱，但如果你沒經過這些努力，可能等畢業後就會變得非常慌亂，最後沒辦法只能去一些機構再學習一遍。

二、面試題

謝飛機，小記！，以前感覺Spring沒啥，看過一篇getBean，我的天！

謝飛機：面試官，最近我看了 Spring 的 getBean 發現這裡好多東西，還有一個是要解決循環依賴的，這玩意麵試有啥要問的嗎？

面試官：有哇，Spring 是如何解決循環依賴的？

謝飛機：嗯，通過三級快取提前暴露對象解決的。

面試官：可以哈，那這三個快取里都存放了什麼樣的對象資訊呢？

謝飛機：一級快取存放的是完整對象，也叫成品對象。二級快取存放的是半成品對象，就是那些屬性還沒賦值的對象。三級快取存放的是 ObjectFactory<?> 類型的 lambda 表達式，就是這用於處理 AOP 循環依賴的。

面試官：可以呀，謝飛機有所準備嘛！那如果沒有三級快取，只有二級或者一級，能解決循環依賴嗎？

謝飛機：其實我看過資料了，可以解決，只不過 Spring 要保證幾個事情，只有一級快取處理流程沒法拆分，複雜度也會增加，同時半成品對象可能會有空指針異常。而將半成品與成品對象分開，處理起來也更加優雅、簡單、易擴展。另外 Spring 的兩大特性中不僅有 IOC 還有 AOP，也就是基於位元組碼增強後的方法，該存放到哪，而三級快取最主要，要解決的循環依賴就是對 AOP 的處理，但如果把 AOP 代理對象的創建提前，那麼二級快取也一樣可以解決。但是，這就違背了 Spring 創建對象的原則，Spring 更喜歡把所有的普通 Bean 都初始化完成，在處理代理對象的初始化。

面試官：飛機，不錯嘛，這次了解了不少。那問個簡單的，你擼過循環依賴的解決方案？

謝飛機：哦哦，這沒有，沒實踐過！！！確實應該搞一下，試試。

三、什麼是循環依賴？

1. 問題描述

了解問題的本質再分析問題，往往更利於對問題有更深入的了解和研究。所以我們在分析 Spring 關於循環依賴的源碼之前，先要了解下什麼是循環依賴。

  • 循環依賴分為三種，自身依賴於自身、互相循環依賴、多組循環依賴。
  • 但無論循環依賴的數量有多少，循環依賴的本質是一樣的。就是你的完整創建依賴於我，而我的完整創建也依賴於你，但我們互相沒法解耦，最終導致依賴創建失敗。
  • 所以 Spring 提供了除了構造函數注入和原型注入外的，setter循環依賴注入解決方案。那麼我們也可以先來嘗試下這樣的依賴，如果是我們自己處理的話該怎麼解決。

2. 問題體現

public class ABTest {

    public static void main(String[] args) {
        new ClazzA();
    }

}

class ClazzA {

    private ClazzB b = new ClazzB();

}

class ClazzB {

    private ClazzA a = new ClazzA();

}
  • 這段程式碼就是循環依賴最初的模樣，你中有我，我中有你，運行就報錯 java.lang.StackOverflowError
  • 這樣的循環依賴程式碼是沒法解決的，當你看到 Spring 中提供了 get/set 或者註解，這樣之所以能解決，首先是進行了一定的解耦。讓類的創建和屬性的填充分離，先創建出半成品Bean，再處理屬性的填充，完成成品Bean的提供。

3. 問題處理

在這部分的程式碼中就一個核心目的，我們來自己解決一下循環依賴，方案如下：

public class CircleTest {

    private final static Map<String, Object> singletonObjects = new ConcurrentHashMap<>(256);

    public static void main(String[] args) throws Exception {
        System.out.println(getBean(B.class).getA());
        System.out.println(getBean(A.class).getB());
    }

    private static <T> T getBean(Class<T> beanClass) throws Exception {
        String beanName = beanClass.getSimpleName().toLowerCase();
        if (singletonObjects.containsKey(beanName)) {
            return (T) singletonObjects.get(beanName);
        }
        // 實例化對象入快取
        Object obj = beanClass.newInstance();
        singletonObjects.put(beanName, obj);
        // 屬性填充補全對象
        Field[] fields = obj.getClass().getDeclaredFields();
        for (Field field : fields) {
            field.setAccessible(true);
            Class<?> fieldClass = field.getType();
            String fieldBeanName = fieldClass.getSimpleName().toLowerCase();
            field.set(obj, singletonObjects.containsKey(fieldBeanName) ? singletonObjects.get(fieldBeanName) : getBean(fieldClass));
            field.setAccessible(false);
        }
        return (T) obj;
    }

}

class A {

    private B b;

    // ...get/set
}

class B {
    private A a;

		// ...get/set
}

  • 這段程式碼提供了 A、B 兩個類，互相有依賴。但在兩個類中的依賴關係使用的是 setter 的方式進行填充。也就是只有這樣才能避免兩個類在創建之初不非得強依賴於另外一個對象。

  • getBean，是整個解決循環依賴的核心內容，A 創建後填充屬性時依賴 B，那麼就去創建 B，在創建 B 開始填充時發現依賴於 A，但此時 A 這個半成品對象已經存放在快取到singletonObjects 中了，所以 B 可以正常創建，在通過遞歸把 A 也創建完整了。

四、源碼分析

1. 說說細節

通過上面的例子我們大概了解到，A和B互相依賴時，A創建完後填充屬性B，繼續創建B，再填充屬性A時就可以從快取中獲取了，如下：

那這個解決事循環依賴的事放到 Spring 中是什麼樣呢？展開細節！

雖然，解決循環依賴的核心原理一樣，但要放到支撐起整個 Spring 中 IOC、AOP 特性時，就會變得複雜一些，整個處理 Spring 循環依賴的過程如下；

  • 以上就是關於 Spring 中對於一個有循環依賴的對象獲取過程，也就是你想要的說說細節
  • 乍一看是挺多流程，但是這些也基本是你在調試程式碼時候必須經過的程式碼片段，拿到這份執行流程，再調試就非常方便了。

2. 處理過程

關於本章節涉及到的案例源碼分析，已更新到 github：//github.com/fuzhengwei/interview – interview-31

以下是單元測試中對AB依賴的獲取Bean操作，重點在於進入 getBean 的源碼跟進；

@Test
public void test_alias() {
    BeanFactory beanFactory = new ClassPathXmlApplicationContext("spring-config.xml");
    Bean_A bean_a = beanFactory.getBean("bean_a", Bean_A.class);
    logger.info("獲取 Bean 通過別名：{}", bean_a.getBean_b());
}

org.springframework.beans.factory.support.AbstractBeanFactory.java

@Override
public <T> T getBean(String name, Class<T> requiredType) throws BeansException {
	return doGetBean(name, requiredType, null, false);
}
  • 從 getBean 進入後，獲取 bean 的操作會進入到 doGetBean。
  • 之所以這樣包裝一層，是因為 doGetBean 有很多不同入參的重載方法，方便外部操作。

doGetBean 方法

protected <T> T doGetBean(
		final String name, final Class<T> requiredType, final Object[] args, boolean typeCheckOnly)
		throws BeansException {
	
  // 從快取中獲取 bean 實例
	Object sharedInstance = getSingleton(beanName);
	
			// mbd.isSingleton() 用於判斷 bean 是否是單例模式
			if (mbd.isSingleton()) {
			  // 獲取 bean 實例
				sharedInstance = getSingleton(beanName, new ObjectFactory<Object>() {
					@Override
					public Object getObject() throws BeansException {
						try {
						  // 創建 bean 實例，createBean 返回的 bean 實例化好的
							return createBean(beanName, mbd, args);
						}
						catch (BeansException ex) {
							destroySingleton(beanName);
							throw ex;
						}
					}
				});
				// 後續的處理操作
				bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
			}
			
	// ...

  // 返回 bean 實例
	return (T) bean;
}
  • 按照在源碼分析的流程圖中可以看到，這一部分是從 getSingleton 先判斷是否有實例對象，對於第一次進入是肯定沒有對象的，要繼續往下走。
  • 在判斷 mbd.isSingleton() 單例以後，開始使用基於 ObjectFactory 包裝的方式創建 createBean，進入後核心邏輯是開始執行 doCreateBean 操作。

doCreateBean 方法

protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final Object[] args)
		throws BeanCreationException {
	
	  // 創建 bean 實例，並將 bean 實例包裝到 BeanWrapper 對象中返回
		instanceWrapper = createBeanInstance(beanName, mbd, args);
	
		// 添加 bean 工廠對象到 singletonFactories 快取中
		addSingletonFactory(beanName, new ObjectFactory<Object>() {
			@Override
			public Object getObject() throws BeansException {
			  // 獲取原始對象的早期引用，在 getEarlyBeanReference 方法中，會執行 AOP 相關邏輯。若 bean 未被 AOP 攔截，getEarlyBeanReference 原樣返回 bean。
				return getEarlyBeanReference(beanName, mbd, bean);
			}
		});
		
	try {
	  // 填充屬性，解析依賴關係
		populateBean(beanName, mbd, instanceWrapper);
		if (exposedObject != null) {
			exposedObject = initializeBean(beanName, exposedObject, mbd);
		}
	}
	
	// 返回 bean 實例
	return exposedObject;
}
  • 在 doCreateBean 方法中包括的內容較多，但核心主要是創建實例、加入快取以及最終進行屬性填充，屬性填充就是把一個 bean 的各個屬性欄位涉及到的類填充進去。
  • createBeanInstance，創建 bean 實例，並將 bean 實例包裝到 BeanWrapper 對象中返回
  • addSingletonFactory，添加 bean 工廠對象到 singletonFactories 快取中
  • getEarlyBeanReference，獲取原始對象的早期引用，在 getEarlyBeanReference 方法中，會執行 AOP 相關邏輯。若 bean 未被 AOP 攔截，getEarlyBeanReference 原樣返回 bean。
  • populateBean，填充屬性，解析依賴關係。也就是從這開始去找尋 A 實例中屬性 B，緊接著去創建 B 實例，最後在返回回來。

getSingleton 三級快取

protected Object getSingleton(String beanName, boolean allowEarlyReference) {
  // 從 singletonObjects 獲取實例，singletonObjects 是成品 bean
	Object singletonObject = this.singletonObjects.get(beanName);
	// 判斷 beanName ，isSingletonCurrentlyInCreation 對應的 bean 是否正在創建中
	if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) {
		synchronized (this.singletonObjects) {
		  // 從 earlySingletonObjects 中獲取提前曝光未成品的 bean
			singletonObject = this.earlySingletonObjects.get(beanName);
			if (singletonObject == null && allowEarlyReference) {
			  // 獲取相應的 bean 工廠
				ObjectFactory<?> singletonFactory = this.singletonFactories.get(beanName);
				if (singletonFactory != null) {
				  // 提前曝光 bean 實例，主要用於解決AOP循環依賴
					singletonObject = singletonFactory.getObject();
					
					// 將 singletonObject 放入快取中，並將 singletonFactory 從快取中移除
					this.earlySingletonObjects.put(beanName, singletonObject);
					this.singletonFactories.remove(beanName);
				}
			}
		}
	}
	return (singletonObject != NULL_OBJECT ? singletonObject : null);
}
  • singletonObjects.get(beanName)，從 singletonObjects 獲取實例，singletonObjects 是成品 bean
  • isSingletonCurrentlyInCreation，判斷 beanName ，isSingletonCurrentlyInCreation 對應的 bean 是否正在創建中
  • allowEarlyReference，從 earlySingletonObjects 中獲取提前曝光未成品的 bean
  • singletonFactory.getObject()，提前曝光 bean 實例，主要用於解決AOP循環依賴

綜上，是一個處理循環依賴的程式碼流程，這部分提取出來的內容主要為核心內容，並沒與長篇大論的全部拆取出來，大家在調試的時候會涉及的比較多，儘可能要自己根據流程圖操作調試幾遍。

3. 依賴解析

綜上從我們自己去嘗試解決循環依賴，學習了循環依賴的核心解決原理。又分析了 Spring 解決的循環依賴的處理過程以及核心源碼的分析。那麼接下來我們在總結下三級快取分別不同的處理過程，算是一個總結，也方便大家理解。

1. 一級快取能解決嗎？

  • 其實只有一級快取並不是不能解決循環依賴，就像我們自己做的例子一樣。
  • 但是在 Spring 中如果像我們例子里那麼處理，就會變得非常麻煩，而且也可能會出現 NPE 問題。
  • 所以如圖按照 Spring 中程式碼處理的流程，我們去分析一級快取這樣存放成品 Bean 的流程中，是不能解決循環依賴的問題的。因為 A 的成品創建依賴於 B，B的成品創建又依賴於 A，當需要補全B的屬性時 A 還是沒有創建完，所以會出現死循環。

2. 二級快取能解決嗎？

  • 有了二級快取其實這個事處理起來就容易了，一個快取用於存放成品對象，另外一個快取用於存放半成品對象。
  • A 在創建半成品對象後存放到快取中，接下來補充 A 對象中依賴 B 的屬性。
  • B 繼續創建，創建的半成品同樣放到快取中，在補充對象的 A 屬性時，可以從半成品快取中獲取，現在 B 就是一個完整對象了，而接下來像是遞歸操作一樣 A 也是一個完整對象了。

3. 三級快取解決什麼？

  • 有了二級快取都能解決 Spring 依賴了，怎麼要有三級快取呢。其實我們在前面分析源碼時也提到過，三級快取主要是解決 Spring AOP 的特性。AOP 本身就是對方法的增強，是 ObjectFactory<?> 類型的 lambda 表達式，而 Spring 的原則又不希望將此類類型的 Bean 前置創建，所以要存放到三級快取中處理。
  • 其實整體處理過程類似，唯獨是 B 在填充屬性 A 時，先查詢成品快取、再查半成品快取，最後在看看有沒有單例工程類在三級快取中。最終獲取到以後調用 getObject 方法返回代理引用或者原始引用。
  • 至此也就解決了 Spring AOP 所帶來的三級快取問題。本章節涉及到的 AOP 依賴有源碼例子，可以進行調試

五、總結

  • 回顧本文基本以實際操作的例子開始，引導大家對循環依賴有一個整體的認識，也對它的解決方案可以上手的例子，這樣對後續的關於 Spring 對循環依賴的解決也就不會那麼陌生了。
  • 通篇全文下來大家也可以看到，三級快取並不是非必須不可，只不過在滿足 Spring 自身創建的原則下，是必須的。如果你可以下載 Spring 源碼對這部分程式碼進行改動下，提前創建 AOP 對象保存到快取中，那麼二級快取一樣可以解決循環依賴問題。
  • 關於循環依賴可能並不是一個好的編碼方式，如果在自己的程式中還是要儘可能使用更合理的設計模式規避循環依賴，可能這些方式會增加程式碼量，但在維護上會更加方便。當然這不是強制，可以根據你的需要而來。

六、系列推薦

Tags:

VirMach 便宜 VPS

QNews

QNews