Spring源碼學習-IOC（xml方式獲取註冊BeanDefinition）

爲何寫這篇文章

  用了這麼長時間的Spring框架，對於如何配置使用是瞭然於胸，可是問到爲何就一臉懵逼了。因此最近開始學習Spring源碼，網上對於Spring源碼分析也有很是多的資料，學習的時候也有作過一些參考。但別人的東西永遠是別人的，只有本身真正去看過理解了，才能成爲本身的。寫這個也是爲了加深本身的理解。

概念理解

  概念理解這部分分享的是Iteye的開濤這位技術牛人對Spring框架的IOC的理解，寫得很是通俗易懂，如下內容所有來自原文，原文地址：jinnianshilongnian.iteye.com/blog/141384…

1.一、IoC是什麼

  Ioc—Inversion of Control，即「控制反轉」，不是什麼技術，而是一種設計思想。在Java開發中，Ioc意味着將你設計好的對象交給容器控制，而不是傳統的在你的對象內部直接控制。如何理解好Ioc呢？理解好Ioc的關鍵是要明確「誰控制誰，控制什麼，爲什麼是反轉（有反轉就應該有正轉了），哪些方面反轉了」，那咱們來深刻分析一下：

  ●誰控制誰，控制什麼：傳統Java SE程序設計，咱們直接在對象內部經過new進行建立對象，是程序主動去建立依賴對象；而IoC是有專門一個容器來建立這些對象，即由Ioc容器來控制對 象的建立；誰控制誰？固然是IoC 容器控制了對象；控制什麼？那就是主要控制了外部資源獲取（不僅是對象包括好比文件等）。

  ●爲什麼是反轉，哪些方面反轉了：有反轉就有正轉，傳統應用程序是由咱們本身在對象中主動控制去直接獲取依賴對象，也就是正轉；而反轉則是由容器來幫忙建立及注入依賴對象；爲什麼是反轉？由於由容器幫咱們查找及注入依賴對象，對象只是被動的接受依賴對象，因此是反轉；哪些方面反轉了？依賴對象的獲取被反轉了。

  用圖例說明一下，傳統程序設計如圖2-1，都是主動去建立相關對象而後再組合起來：

圖1-1 傳統應用程序示意圖
複製代碼

  當有了IoC/DI的容器後，在客戶端類中再也不主動去建立這些對象了，如圖2-2所示:

圖1-2有IoC/DI容器後程序結構示意圖
複製代碼

1.二、IoC能作什麼

  IoC 不是一種技術，只是一種思想，一個重要的面向對象編程的法則，它能指導咱們如何設計出鬆耦合、更優良的程序。傳統應用程序都是由咱們在類內部主動建立依賴對象，從而致使類與類之間高耦合，難於測試；有了IoC容器後，把建立和查找依賴對象的控制權交給了容器，由容器進行注入組合對象，因此對象與對象之間是 鬆散耦合，這樣也方便測試，利於功能複用，更重要的是使得程序的整個體系結構變得很是靈活。

  其實IoC對編程帶來的最大改變不是從代碼上，而是從思想上，發生了「主從換位」的變化。應用程序本來是老大，要獲取什麼資源都是主動出擊，可是在IoC/DI思想中，應用程序就變成被動的了，被動的等待IoC容器來建立並注入它所須要的資源了。

  IoC很好的體現了面向對象設計法則之一—— 好萊塢法則：「別找咱們，咱們找你」；即由IoC容器幫對象找相應的依賴對象並注入，而不是由對象主動去找。

1.三、IoC和DI

  DI—Dependency Injection，即「依賴注入」：組件之間依賴關係由容器在運行期決定，形象的說，即由容器動態的將某個依賴關係注入到組件之中。依賴注入的目的並不是爲軟件系統帶來更多功能，而是爲了提高組件重用的頻率，併爲系統搭建一個靈活、可擴展的平臺。經過依賴注入機制，咱們只須要經過簡單的配置，而無需任何代碼就可指定目標須要的資源，完成自身的業務邏輯，而不須要關心具體的資源來自何處，由誰實現。

  理解DI的關鍵是：「誰依賴誰，爲何須要依賴，誰注入誰，注入了什麼」，那咱們來深刻分析一下：

  ●誰依賴於誰：固然是應用程序依賴於IoC容器；

  ●爲何須要依賴：應用程序須要IoC容器來提供對象須要的外部資源；

  ●誰注入誰：很明顯是IoC容器注入應用程序某個對象，應用程序依賴的對象；

  ●注入了什麼：就是注入某個對象所須要的外部資源（包括對象、資源、常量數據）。

  IoC和DI由什麼關係呢？其實它們是同一個概念的不一樣角度描述，因爲控制反轉概念比較含糊（可能只是理解爲容器控制對象這一個層面，很難讓人想到誰來維護對象關係），因此2004年大師級人物Martin Fowler又給出了一個新的名字：「依賴注入」，相對IoC 而言，「依賴注入」明確描述了「被注入對象依賴IoC容器配置依賴對象」。

  看過不少對Spring的Ioc理解的文章，好多人對Ioc和DI的解釋都晦澀難懂，反正就是一種說不清，道不明的感受，讀完以後依然是一頭霧水，感受就是開濤這位技術牛人寫得特別通俗易懂，他清楚地解釋了IoC(控制反轉) 和DI(依賴注入)中的每個字，讀完以後給人一種豁然開朗的感受。我相信對於初學Spring框架的人對Ioc的理解應該是有很大幫助的。

源碼學習

首先要明白幾個類的含義：

1.Beandefinition :bean定義，全部經過xml配置和掃描到的bean的都會被解析爲BeanDefinition的實例存儲在BeanFactory中。BeanDefinition中定義了全部的配置信息。下面是一部分獲取屬性的方法

/**
	 * Return the current bean class name of this bean definition.
	 * <p>Note that this does not have to be the actual class name used at runtime, in
	 * case of a child definition overriding/inheriting the class name from its parent.
	 * Also, this may just be the class that a factory method is called on, or it may
	 * even be empty in case of a factory bean reference that a method is called on.
	 * Hence, do <i>not</i> consider this to be the definitive bean type at runtime but
	 * rather only use it for parsing purposes at the individual bean definition level.
	 * @see #getParentName()
	 * @see #getFactoryBeanName()
	 * @see #getFactoryMethodName()
	 */
       @Nullable
	String getBeanClassName();
	/**
	 * Return the name of the current target scope for this bean,
	 * or {@code null} if not known yet.
	 */
	@Nullable
	String getScope();
	/**
	 * Return whether this bean should be lazily initialized, i.e. not
	 * eagerly instantiated on startup. Only applicable to a singleton bean.
	 */
	boolean isLazyInit();
	/**
	 * Return the bean names that this bean depends on.
	 */
	@Nullable
	String[] getDependsOn();
複製代碼

2.BeanDefinitionRegistry:BeanDefinition註冊器，實現了該接口就能夠對BeanDefinition進行註冊

/**
	 * Register a new bean definition with this registry.
	 * Must support RootBeanDefinition and ChildBeanDefinition.
	 * @param beanName the name of the bean instance to register
	 * @param beanDefinition definition of the bean instance to register
	 * @throws BeanDefinitionStoreException if the BeanDefinition is invalid
	 * @throws BeanDefinitionOverrideException if there is already a BeanDefinition
	 * for the specified bean name and we are not allowed to override it
	 * @see GenericBeanDefinition
	 * @see RootBeanDefinition
	 * @see ChildBeanDefinition
	 */
	void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
			throws BeanDefinitionStoreException;
複製代碼

3.DefaultListableBeanFactory：BeanFactory的默認實現，同時還實現了BeanDefinitionRegistry。 DefaultListableBeanFactory定義了一個Map用於存放BeanDefinition

2.1 入口在哪

ApplicationContext:
複製代碼

//xml配置方式 配置文件
ApplicationContext context = new ClassPathXmlApplicationContext("application.xml");

//註解配置方式 掃描包
ApplicationContext context2 = new AnnotationConfigApplicationContext("com.study.spring");
複製代碼

2.2 xml方式怎麼解析並註冊BeanDefinition

這裏我根據調用鏈畫了一個粗略的流程圖

從方法和參數上咱們能夠看出這 4 部分分別是作什麼：
    第一部分：初始化 IOC 容器，建立了內部的 BeanFactory，而後將加載 xml 的工做委託給了
XmlBeanDefinitionReader。
    第二部分： XmlBeanDefinitionReader 完成了對輸入數據：字符串 -> Resource -> EncodedResource ->
InputSource -> Document 的轉變。
    第三部分： DefaultBeanDefinitionDocumentReader 完成對 Document 中元素的解析，得到 Bean 定義等
信息。
第四部分：就是簡單的完成 bean 定義的註冊。
接下來，你就能夠針對每一部分去看你感興趣的處理邏輯、數據結構了。
好比：你可能對第三部分 Document 中元素的解析很感興趣，想搞清楚它是如何解析 xml 文檔中的各類標
籤元素的。
複製代碼

下面來看幾段代碼

AbstractBeanDefinitionReader:遍歷全部的配置文件獲取beanDefinition
複製代碼

public int loadBeanDefinitions(String... locations) throws BeanDefinitionStoreException {
		Assert.notNull(locations, "Location array must not be null");
		int count = 0;
		for (String location : locations) {
			count += loadBeanDefinitions(location);
		}
		return count;
	}
	
	@Override
	public int loadBeanDefinitions(Resource... resources) throws BeanDefinitionStoreException {
		Assert.notNull(resources, "Resource array must not be null");
		int count = 0;
		for (Resource resource : resources) {
			count += loadBeanDefinitions(resource);
		}
		return count;
	}
	
複製代碼

轉換爲Document準備解析
複製代碼

DefaultBeanDefinitionDocumentReader：解析xml
複製代碼

/**
	 * Parse the elements at the root level in the document:
	 * "import", "alias", "bean".
	 * @param root the DOM root element of the document
	 */
	protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {//解析<beans>
		if (delegate.isDefaultNamespace(root)) {
			NodeList nl = root.getChildNodes();
			for (int i = 0; i < nl.getLength(); i++) {
				Node node = nl.item(i);
				if (node instanceof Element) {
					Element ele = (Element) node;
					if (delegate.isDefaultNamespace(ele)) {
						parseDefaultElement(ele, delegate);//解析spring下定義的標籤
					}
					else {
						delegate.parseCustomElement(ele);//解析自定義的標籤，經過自定義NamespaceHandler接口的實現解析自定義標籤
					}
				}
			}
		}
		else {
			delegate.parseCustomElement(root);
		}
	}
	
	
	private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
		if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {//解析<import>
			importBeanDefinitionResource(ele);
		}
		else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {//解析<alias>
			processAliasRegistration(ele);
		}
		else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {//解析<bean>
			processBeanDefinition(ele, delegate);
		}
		else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {//解析<beans>
			// recurse
			doRegisterBeanDefinitions(ele);
		}
	}

複製代碼

最後就是DefaultListableBeanFactory的registerBeanDefinition方法把Beandefinition放入到beanDefinitionMap中。
    這就完成了整個根據xml配置獲取並註冊BeanDefinition的過程。
複製代碼