概要

Spring 框架使用了BeanFactory 進行載入 xml 和生成 bean 例項。下面我們分析下Spring載入xml檔案的過程。
spring 版本是最新的 4.3.9 release 版本

示例

XmlBeanFactory xbf = new XmlBeanFactory(new ClassPathResource("bean.xml"));
User user = User.class.cast(xbf.getBean("user"));
System.out.println(user);

我們通過XmlBeanFactory分析下xml的載入過程。通常我們開發的時候一般都是使用ClassPathXmlApplicationContext進行載入配置檔案的。原理都一樣，只不過ClassPathXmlApplicationContext寬展了好多功能。但載入xml的原理都一樣。

ClassPathResource 封裝了xml檔案資訊，可以呼叫getInputStream() 方法獲取檔案。

原始碼解析

XmlBeanFactory.java

從程式碼中發現XmlBeanFactory委託給XmlBeanDefintionReader進行處理

XmlBeanDefintionReader.java

1. 使用EncodeResource封裝資原始檔。如果指定編碼則使用指定編碼進行讀取資原始檔。
2. 判斷該資源是否已經載入過
3. 構造InputStream例項,然後呼叫 doLoadBeanDefinitions() 方法

InputSource 類結構

public class InputSource {
    private String publicId;
    private String systemId;
    private InputStream byteStream;
    private String encoding;
    private Reader characterStream;
    ....
}

使用SAX解析、驗證xml的時候需要使用到 publicId和systemId

doLoadBeanDefinitions() 方法

1. 使用SAX解析xml獲取Document物件
2. 根據返回的Document 註冊 Bean 資訊

doLoadDocument()

protected Document doLoadDocument(InputSource inputSource, Resource resource) throws Exception {
    return this.documentLoader.loadDocument(inputSource, getEntityResolver(), this.errorHandler,
            getValidationModeForResource(resource), isNamespaceAware());
}

getValidationModeForResource(resource)

判斷xml的文件驗證機制是DTD還是XSD
1.如果指定驗證模式則使用指定的。
2.如果沒有指定則呼叫 detectValidationMode 自動檢查
讀取xml檔案中的是否保護“DOCTYPE”，如果包含則是DTD，否則則是XSD

getEntityResolver() 方法

EntityResovle作用：SAX解析xml的時候首先讀取xml文件上的宣告，根據宣告找相應的DTD定義。預設尋找規則：首先通過網路下載相應的DTD，並認證。網路下載是一個不確定的過程（網速問題、網路中斷等），就會出現DTD找不到的情況。而EntityResovle提供了一個尋找DTD的自定義方法，一般我們回吧DTD放到專案中某資料夾下，直接讀取本地的DTD交給SAX解析即可。避免了網路交換過程。

loadDocument() 方法

通過SAX解析xml。構造DocumentBuilderFactory解析xml。

registerBeanDefinitions() 方法

public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
    BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
    int countBefore = getRegistry().getBeanDefinitionCount();
    documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
    return getRegistry().getBeanDefinitionCount() - countBefore;
    }

protected BeanDefinitionDocumentReader createBeanDefinitionDocumentReader() {
    return BeanDefinitionDocumentReader.class.cast(BeanUtils.instantiateClass(this.documentReaderClass));
}

1. 使用DefaultBeanDefinitionDocumentReader.class 構造BeanDefinitionDocumentReader 。
2. 記錄已經載入的Bean的個數
3. 載入及註冊Bean
4. 返回這次載入的Bean的個數

從當前程式碼中可以看出註冊載入Bean委託給 BeanDefinitionDocumentReader .registerBeanDefinitions() 方法處理

registerBeanDefinitions() 方法

public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
    this.readerContext = readerContext;
    Element root = doc.getDocumentElement();
    doRegisterBeanDefinitions(root);
}
protected void doRegisterBeanDefinitions(Element root) {
    BeanDefinitionParserDelegate parent = this.delegate;
    this.delegate = createDelegate(getReaderContext(), root, parent);
    if (this.delegate.isDefaultNamespace(root)) {
        //判斷xml的beans標籤屬性中是否有profile屬性，並驗證跟web.xml中配置的資訊是否匹配
        String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
        if (StringUtils.hasText(profileSpec)) {
            String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
                    profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
            if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
                return;
            }
        }
    }
    preProcessXml(root);
    parseBeanDefinitions(root, this.delegate);
    postProcessXml(root);
    this.delegate = parent;
}

profile 用法

<!-- spring的applicationContext.xml中配置 -->
<beans profile="development">
    ......
</beans>
<beans profile="produce">
    ......
</beans>

<!-- web專案的web.xml中配置 -->
<context-param>
    <param-name>spring.profiles.default</param-name>
    <param-value>production</param-value>
</context-param>

可以使用profile來進行切換線上配置和開發環境配置，方便開發使用

parseBeanDefinitions() 方法

判斷是自定義便籤還是系統預設標籤。
1.系統預設的標籤呼叫parseDefaultElement方法解析
2.使用者自定義標籤使用parseCustomElement方法解析

parseDefaultElement() 方法

1. 解析 import 標籤
2. 解析 alias 標籤
3. 解析 bean 標籤
4. 解析 beans 標籤

parseCustomElement() 方法

主要解析自定義的標籤內容
比如：

<!-- 使用者自定義標籤 -->
<bean id="xxx" class="test.XXX">
    <mybean:user username="zhangsan"/>
</bean>

<!-- 系統預設實現的自定義標籤 -->
<tx:annotation-driven />