spring源碼分析(二)
目錄
五昔驱、Spring 源碼解讀
--5.1郎任、什么是IOC/DI
--5.2哈踱、Spring IOC 體系結(jié)構(gòu)
----(1) BeanFactory
----(2) BeanDefinition
--5.3箩退、IOC 容器的初始化
----1丑罪、XmlBeanFactory(屌絲IOC)的整個(gè)流程
----2传黄、FileSystemXmlApplicationContext 的IOC 容器流程
------① 高富帥IOC 解剖
------② 設(shè)置資源加載器和資源定位
------③AbstractApplicationContext 的refresh 函數(shù)載入Bean 定義過(guò)程
------④ AbstractApplicationContext 子類(lèi)的refreshBeanFactory()方法
------⑤ AbstractRefreshableApplicationContext 子類(lèi)的loadBeanDefinitions 方法
------⑥ AbstractBeanDefinitionReader 讀取Bean 定義資源
------⑦ 資源加載器獲取要讀入的資源
------⑧ XmlBeanDefinitionReader 加載Bean 定義資源
------⑨ DocumentLoader 將Bean 定義資源轉(zhuǎn)換為Document 對(duì)象
------⑩ XmlBeanDefinitionReader 解析載入的Bean 定義資源文件
------⑩① DefaultBeanDefinitionDocumentReader 對(duì)Bean 定義的Document 對(duì)象解析
------⑩② BeanDefinitionParserDelegate 解析Bean 定義資源文件中的<Bean>元素
------⑩③ BeanDefinitionParserDelegate 解析<property>元素
------⑩④ 解析<property>元素的子元素
------⑩⑤ 解析<list>子元素
------⑩⑥ 解析過(guò)后的BeanDefinition 在IOC 容器中的注冊(cè)
------⑩⑦ DefaultListableBeanFactory 向IOC 容器注冊(cè)解析后的BeanDefinition
------⑩⑧ 總結(jié)
五鬓长、Spring 源碼解讀
5.1、什么是IOC/DI尝江?
IOC(Inversion of Control)控制反轉(zhuǎn):所謂控制反轉(zhuǎn)涉波,就是把原先我們代碼里面需要實(shí)現(xiàn)的對(duì)象創(chuàng)建、依賴的代碼炭序,反轉(zhuǎn)給容器來(lái)幫忙實(shí)現(xiàn)啤覆。那么必然的我們需要?jiǎng)?chuàng)建一個(gè)容器,同時(shí)需要一種描述來(lái)讓容器知道需要?jiǎng)?chuàng)建的對(duì)象與對(duì)象的關(guān)系惭聂。這個(gè)描述最具體表現(xiàn)就是我們可配置的文件窗声。
DI(Dependency Injection)依賴注入:就是指對(duì)象是被動(dòng)接受依賴類(lèi)而不是自己主動(dòng)去找,換句話說(shuō)就是指對(duì)象不是從容器中查找它依賴的類(lèi)辜纲,而是在容器實(shí)例化對(duì)象的時(shí)候主動(dòng)將它依賴的類(lèi)注入給它笨觅。
先從我們自己設(shè)計(jì)這樣一個(gè)視角來(lái)考慮:
對(duì)象和對(duì)象關(guān)系怎么表示?
可以用xml 耕腾, properties 文件等語(yǔ)義化配置文件表示见剩。
描述對(duì)象關(guān)系的文件存放在哪里?
可能是classpath 扫俺, filesystem 苍苞,或者是URL 網(wǎng)絡(luò)資源, servletContext 等狼纬。
回到正題羹呵,有了配置文件,還需要對(duì)配置文件解析疗琉。
不同的配置文件對(duì)對(duì)象的描述不一樣冈欢,如標(biāo)準(zhǔn)的,自定義聲明式的盈简,如何統(tǒng)一凑耻?
在內(nèi)部需要有一個(gè)統(tǒng)一的關(guān)于對(duì)象的定義犯戏,所有外部的描述都必須轉(zhuǎn)化成統(tǒng)一的描述定義。
如何對(duì)不同的配置文件進(jìn)行解析拳话?
需要對(duì)不同的配置文件語(yǔ)法先匪,采用不同的解析器
5.2、Spring IOC 體系結(jié)構(gòu)
(1) BeanFactory
Spring Bean 的創(chuàng)建是典型的工廠模式弃衍,這一系列的Bean 工廠呀非,也即IOC 容器為開(kāi)發(fā)者管理對(duì)象間的依賴關(guān)系提供了很多便利和基礎(chǔ)服務(wù),在Spring 中有許多的IOC 容器的實(shí)現(xiàn)供用戶選擇和使用镜盯,其相互關(guān)系如下:
其中BeanFactory 作為最頂層的一個(gè)接口類(lèi)岸裙,它定義了IOC 容器的基本功能規(guī)范崩哩,BeanFactory 有三個(gè)子類(lèi):ListableBeanFactory
泉褐、HierarchicalBeanFactory
和AutowireCapableBeanFactory
。但是從上圖中我們可以發(fā)現(xiàn)最終的默認(rèn)實(shí)現(xiàn)類(lèi)是DefaultListableBeanFactory
萍程,他實(shí)現(xiàn)了所有的接口艺糜。那為何要定義這么多層次的接口呢剧董?查閱這些接口的源碼和說(shuō)明發(fā)現(xiàn),每個(gè)接口都有他使用的場(chǎng)合破停,它主要是為了區(qū)分在Spring 內(nèi)部在操作過(guò)程中對(duì)象的傳遞和轉(zhuǎn)化過(guò)程中翅楼,對(duì)對(duì)象的數(shù)據(jù)訪問(wèn)所做的限制。
ListableBeanFactory
接口表示這些Bean 是可列表的
HierarchicalBeanFactory
表示的是這些Bean 是有繼承關(guān)系的真慢,也就是每個(gè)Bean 有可能有父Bean毅臊。
AutowireCapableBeanFactory
接口定義Bean 的自動(dòng)裝配規(guī)則。
這四個(gè)接口共同定義了Bean 的集合黑界、Bean 之間的關(guān)系管嬉、以及Bean 行為.
最基本的IOC 容器接口BeanFactory
public interface BeanFactory {
//對(duì)FactoryBean 的轉(zhuǎn)義定義,因?yàn)槿绻褂胋ean 的名字檢索FactoryBean 得到的對(duì)象是工廠生成的對(duì)象朗鸠,
//如果需要得到工廠本身蚯撩,需要轉(zhuǎn)義
String FACTORY_BEAN_PREFIX = "&";
//根據(jù)bean 的名字,獲取在IOC 容器中得到bean 實(shí)例
Object getBean(String name) throws BeansException;
//根據(jù)bean 的名字和Class 類(lèi)型來(lái)得到bean 實(shí)例童社,增加了類(lèi)型安全驗(yàn)證機(jī)制求厕。
Object getBean(String name, Class requiredType) throws BeansException;
//提供對(duì)bean 的檢索著隆,看看是否在IOC 容器有這個(gè)名字的bean
boolean containsBean(String name);
//根據(jù)bean 名字得到bean 實(shí)例扰楼,并同時(shí)判斷這個(gè)bean 是不是單例
boolean isSingleton(String name) throws NoSuchBeanDefinitionException;
//得到bean 實(shí)例的Class 類(lèi)型
Class getType(String name) throws NoSuchBeanDefinitionException;
//得到bean 的別名,如果根據(jù)別名檢索美浦,那么其原名也會(huì)被檢索出來(lái)
String[] getAliases(String name);
}
在BeanFactory 里只對(duì)IOC 容器的基本行為作了定義弦赖,根本不關(guān)心你的bean 是如何定義怎樣加載的。正如我們只關(guān)心工廠里得到什么的產(chǎn)品對(duì)象浦辨,至于工廠是怎么生產(chǎn)這些對(duì)象的蹬竖,這個(gè)基本的接口不關(guān)心。
而要知道工廠是如何產(chǎn)生對(duì)象的,我們需要看具體的IOC 容器實(shí)現(xiàn)币厕,Spring 提供了許多IOC 容器的實(shí)現(xiàn)列另。比如XmlBeanFactory,ClasspathXmlApplicationContext 等旦装。其中XmlBeanFactory 就是針對(duì)最基本的IOC 容器的實(shí)現(xiàn)页衙,這個(gè)IOC 容器可以讀取XML 文件定義的BeanDefinition(XML 文件中對(duì)bean的描述),如果說(shuō)XmlBeanFactory
是容器中的屌絲,ApplicationContext
應(yīng)該算容器中的高帥富.
ApplicationContext 是Spring 提供的一個(gè)高級(jí)的IOC 容器阴绢,它除了能夠提供IOC 容器的基本功能外店乐,還為用戶提供了以下的附加服務(wù)。
從ApplicationContext 接口的實(shí)現(xiàn)呻袭,我們看出其特點(diǎn):
- 支持信息源眨八,可以實(shí)現(xiàn)國(guó)際化。(實(shí)現(xiàn)MessageSource 接口)
- 訪問(wèn)資源左电。(實(shí)現(xiàn)ResourcePatternResolver 接口廉侧,這個(gè)后面要講)
- 支持應(yīng)用事件。(實(shí)現(xiàn)ApplicationEventPublisher 接口)
(2) BeanDefinition
SpringIOC 容器管理了我們定義的各種Bean 對(duì)象及其相互的關(guān)系篓足,Bean 對(duì)象在Spring 實(shí)現(xiàn)中是以BeanDefinition
來(lái)描述的伏穆,其繼承體系如下:
Bean 的解析過(guò)程非常復(fù)雜,功能被分的很細(xì)纷纫,因?yàn)檫@里需要被擴(kuò)展的地方很多枕扫,必須保證有足夠的靈活性,以應(yīng)對(duì)可能的變化辱魁。Bean 的解析主要就是對(duì)Spring 配置文件的解析烟瞧。這個(gè)解析過(guò)程主要通過(guò)下圖中的類(lèi)完成:
5.3、IOC 容器的初始化
IOC 容器的初始化包括BeanDefinition 的Resource 定位染簇、載入和注冊(cè)這三個(gè)基本的過(guò)程参滴。我們以ApplicationContext 為例講解,ApplicationContext
系列容器也許是我們最熟悉的锻弓,因?yàn)閣eb 項(xiàng)目中使用的XmlWebApplicationContext 就屬于這個(gè)繼承體系砾赔,還有ClasspathXmlApplicationContext 等
其繼承體系如下圖所示:
ApplicationContext 允許上下文嵌套,通過(guò)保持父上下文可以維持一個(gè)上下文體系青灼。對(duì)于bean 的查找可以在這個(gè)上下文體系中發(fā)生暴心,首先檢查當(dāng)前上下文,其次是父上下文杂拨,逐級(jí)向上专普,這樣為不同的Spring應(yīng)用提供了一個(gè)共享的bean 定義環(huán)境。
下面我們分別簡(jiǎn)單地演示一下兩種ioc 容器的創(chuàng)建過(guò)程
1弹沽、XmlBeanFactory(屌絲IOC)的整個(gè)流程
通過(guò)XmlBeanFactory
的源碼檀夹,我們可以發(fā)現(xiàn):
public class XmlBeanFactory extends DefaultListableBeanFactory{
private final XmlBeanDefinitionReader reader;
public XmlBeanFactory(Resource resource)throws BeansException{
this(resource, null);
}
public XmlBeanFactory(Resource resource, BeanFactory parentBeanFactory)
throws BeansException{
super(parentBeanFactory);
this.reader = new XmlBeanDefinitionReader(this);
this.reader.loadBeanDefinitions(resource);
}
}
調(diào)用全過(guò)程還原筋粗,定位、載入炸渡、注冊(cè)
//根據(jù)Xml 配置文件創(chuàng)建Resource 資源對(duì)象娜亿,該對(duì)象中包含了BeanDefinition 的信息
ClassPathResource resource =new ClassPathResource("application-context.xml");
//創(chuàng)建DefaultListableBeanFactory
DefaultListableBeanFactory factory =new DefaultListableBeanFactory();
//創(chuàng)建XmlBeanDefinitionReader 讀取器,用于載入BeanDefinition蚌堵。之所以需要BeanFactory 作為參數(shù)暇唾,是因?yàn)闀?huì)將讀取的信息回調(diào)配置給factory
XmlBeanDefinitionReader reader =new XmlBeanDefinitionReader(factory);
//XmlBeanDefinitionReader 執(zhí)行載入BeanDefinition 的方法,最后會(huì)完成Bean 的載入和注冊(cè)辰斋。完成后Bean 就成功的放置到IOC 容器當(dāng)中策州,以后我們就可以從中取得Bean 來(lái)使用
reader.loadBeanDefinitions(resource);
通過(guò)前面的源碼,this.reader = new XmlBeanDefinitionReader(this); 中其中this 傳的是factory 對(duì)象
2宫仗、FileSystemXmlApplicationContext 的IOC 容器流程
① 高富帥IOC 解剖
ApplicationContext =new FileSystemXmlApplicationContext(xmlPath);
調(diào)用構(gòu)造函數(shù):
/**
* Create a new FileSystemXmlApplicationContext, loading the definitions
* from the given XML files and automatically refreshing the context.
* @param configLocations array of file paths
* @throws BeansException if context creation failed
*/
public FileSystemXmlApplicationContext(String... configLocations) throws BeansException {
this(configLocations, true, null);
}
實(shí)際調(diào)用
public FileSystemXmlApplicationContext(String[] configLocations, boolean refresh,ApplicationContext parent) throws BeansException {
super(parent);
setConfigLocations(configLocations);
if (refresh) {
refresh();
}
}
② 設(shè)置資源加載器和資源定位
通過(guò)分析FileSystemXmlApplicationContext 的源代碼可以知道够挂,在創(chuàng)建
FileSystemXmlApplicationContext
容器時(shí),構(gòu)造方法做以下兩項(xiàng)重要工作:
首先藕夫,調(diào)用父類(lèi)容器的構(gòu)造方法(super(parent)方法)為容器設(shè)置好Bean 資源加載器孽糖。
其次,再調(diào)用父類(lèi)AbstractRefreshableConfigApplicationContext 的
setConfigLocations(configLocations)方法設(shè)置Bean 定義資源文件的定位路徑毅贮。
通過(guò)追蹤FileSystemXmlApplicationContext 的繼承體系办悟,發(fā)現(xiàn)其父類(lèi)的父類(lèi)
AbstractApplicationContext
中初始化IOC 容器所做的主要源碼如下:
public abstract class AbstractApplicationContext extends DefaultResourceLoader implements ConfigurableApplicationContext, DisposableBean {
//靜態(tài)初始化塊,在整個(gè)容器創(chuàng)建過(guò)程中只執(zhí)行一次
static {
//為了避免應(yīng)用程序在Weblogic8.1 關(guān)閉時(shí)出現(xiàn)類(lèi)加載異常加載問(wèn)題滩褥,加載IoC 容
//器關(guān)閉事件(ContextClosedEvent)類(lèi)
ContextClosedEvent.class.getName();
}
public AbstractApplicationContext() {
this.resourcePatternResolver = getResourcePatternResolver();
}
//FileSystemXmlApplicationContext 調(diào)用父類(lèi)構(gòu)造方法調(diào)用的就是該方法
public AbstractApplicationContext(ApplicationContext parent) {
this();
setParent(parent);
}
//獲取一個(gè)Spring Source 的加載器用于讀入Spring Bean 定義資源文件
protected ResourcePatternResolver getResourcePatternResolver() {
//AbstractApplicationContext 繼承DefaultResourceLoader病蛉,因此也是一個(gè)資源加載器
//Spring 資源加載器,其getResource(String location)方法用于載入資源
return new PathMatchingResourcePatternResolver(this);
}
……
}
AbstractApplicationContext 構(gòu)造方法中調(diào)用PathMatchingResourcePatternResolver
的構(gòu)造方法創(chuàng)建Spring 資源加載器:
public PathMatchingResourcePatternResolver(ResourceLoader resourceLoader) {
Assert.notNull(resourceLoader, "ResourceLoader must not be null");
//設(shè)置Spring 的資源加載器
this.resourceLoader = resourceLoader;
}
在設(shè)置容器的資源加載器之后瑰煎,接下來(lái)FileSystemXmlApplicationContet 執(zhí)行setConfigLocations 方法通過(guò)調(diào)用其父類(lèi)AbstractRefreshableConfigApplicationContext 的方法進(jìn)行對(duì)Bean 定義資源文件
的定位铺然,該方法的源碼如下:
//處理單個(gè)資源文件路徑為一個(gè)字符串的情況
public void setConfigLocation(String location) {
//String CONFIG_LOCATION_DELIMITERS = ",; /t/n";
//即多個(gè)資源文件路徑之間用” ,; /t/n”分隔,解析成數(shù)組形式
setConfigLocations(StringUtils.tokenizeToStringArray(location, CONFIG_LOCATION_DELIMITERS));
}
//解析Bean 定義資源文件的路徑酒甸,處理多個(gè)資源文件字符串?dāng)?shù)組
public void setConfigLocations(String[] locations) {
if (locations != null) {
Assert.noNullElements(locations, "Config locations must not be null");
this.configLocations = new String[locations.length];
for (int i = 0; i < locations.length; i++) {
// resolvePath 為同一個(gè)類(lèi)中將字符串解析為路徑的方法
this.configLocations[i] = resolvePath(locations[i]).trim();
}
}else {
this.configLocations = null;
}
}
通過(guò)這兩個(gè)方法的源碼我們可以看出魄健,我們既可以使用一個(gè)字符串來(lái)配置多個(gè)Spring Bean 定義資源文件,也可以使用字符串?dāng)?shù)組插勤,即下面兩種方式都是可以的:
A. ClasspathResource res = new ClasspathResource(“a.xml,b.xml,……”);
多個(gè)資源文件路徑之間可以是用” ,; /t/n”等分隔沽瘦。
B.ClasspathResource res = new ClasspathResource(newString[{“a.xml”,”b.xml”,……});
至此,Spring IOC 容器在初始化時(shí)將配置的Bean 定義資源文件定位為Spring 封裝的Resource农尖。
③AbstractApplicationContext 的refresh 函數(shù)載入Bean 定義過(guò)程:
Spring IOC 容器對(duì)Bean 定義資源的載入是從refresh()函數(shù)開(kāi)始的refresh()是一個(gè)模板方法析恋,refresh()方法的作用是:在創(chuàng)建IOC 容器前,如果已經(jīng)有容器存在卤橄,則需要把已有的容器銷(xiāo)毀和關(guān)閉绿满,以保證在refresh 之后使用的是新建立起來(lái)的IOC 容器。refresh
的作用類(lèi)似于對(duì)IOC 容器的重啟窟扑,在新建立好的容器中對(duì)容器進(jìn)行初始化喇颁,對(duì)Bean 定義資源進(jìn)行載入
FileSystemXmlApplicationContext 通過(guò)調(diào)用其父AbstractApplicationContext 的refresh()函數(shù)啟動(dòng)整個(gè)IoC 容器對(duì)Bean 定義的載入過(guò)程:
public void refresh() throws BeansException, IllegalStateException {
synchronized (this.startupShutdownMonitor) {
//調(diào)用容器準(zhǔn)備刷新的方法,獲取容器的當(dāng)時(shí)時(shí)間嚎货,同時(shí)給容器設(shè)置同步標(biāo)識(shí)
prepareRefresh();
//告訴子類(lèi)啟動(dòng)refreshBeanFactory()方法橘霎,Bean 定義資源文件的載入從
//子類(lèi)的refreshBeanFactory()方法啟動(dòng)
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
//為BeanFactory 配置容器特性,例如類(lèi)加載器殖属、事件處理器等
prepareBeanFactory(beanFactory);
try {
//為容器的某些子類(lèi)指定特殊的BeanPost 事件處理器
postProcessBeanFactory(beanFactory);
//調(diào)用所有注冊(cè)的BeanFactoryPostProcessor 的Bean
invokeBeanFactoryPostProcessors(beanFactory);
//為BeanFactory 注冊(cè)BeanPost 事件處理器.
//BeanPostProcessor 是Bean 后置處理器姐叁,用于監(jiān)聽(tīng)容器觸發(fā)的事件
registerBeanPostProcessors(beanFactory);
//初始化信息源,和國(guó)際化相關(guān).
initMessageSource();
//初始化容器事件傳播器.
initApplicationEventMulticaster();
//調(diào)用子類(lèi)的某些特殊Bean 初始化方法
onRefresh();
//為事件傳播器注冊(cè)事件監(jiān)聽(tīng)器.
registerListeners();
//初始化所有剩余的單例Bean.
finishBeanFactoryInitialization(beanFactory);
//初始化容器的生命周期事件處理器洗显,并發(fā)布容器的生命周期事件
finishRefresh();
} catch (BeansException ex) {
//銷(xiāo)毀以創(chuàng)建的單態(tài)Bean
destroyBeans();
//取消refresh 操作外潜,重置容器的同步標(biāo)識(shí).
cancelRefresh(ex);
throw ex;
}
}
}
refresh()方法主要為IOC 容器Bean 的生命周期管理提供條件,Spring IOC 容器載入Bean 定義資源文件從其子類(lèi)容器的refreshBeanFactory()方法啟動(dòng)挠唆,所以整個(gè)refresh()中
ConfigurableListableBeanFactory beanFactory=obtainFreshBeanFactory();
這句以后代碼的都是注冊(cè)容器的信息源和生命周期事件处窥,載入過(guò)程就是從這句代碼啟動(dòng)。
refresh()方法的作用是:在創(chuàng)建IOC 容器前玄组,如果已經(jīng)有容器存在滔驾,則需要把已有的容器銷(xiāo)毀和關(guān)閉,以保證在refresh 之后使用的是新建立起來(lái)的IOC 容器俄讹。refresh 的作用類(lèi)似于對(duì)IOC 容器的重啟哆致,在新建立好的容器中對(duì)容器進(jìn)行初始化,對(duì)Bean 定義資源進(jìn)行載入
AbstractApplicationContext 的obtainFreshBeanFactory()方法調(diào)用子類(lèi)容器的refreshBeanFactory()
方法患膛,啟動(dòng)容器載入Bean 定義資源文件的過(guò)程摊阀,代碼如下:
protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {
//這里使用了委派設(shè)計(jì)模式,父類(lèi)定義了抽象的refreshBeanFactory()方法踪蹬,具體實(shí)現(xiàn)調(diào)用子類(lèi)容器的
refreshBeanFactory()方法
refreshBeanFactory();
ConfigurableListableBeanFactory beanFactory = getBeanFactory();
if (logger.isDebugEnabled()) {
logger.debug("Bean factory for " + getDisplayName() + ": " + beanFactory);
}
return beanFactory;
}
④ AbstractApplicationContext 子類(lèi)的refreshBeanFactory()方法:
AbstractApplicationContext 類(lèi)中只抽象定義了refreshBeanFactory()方法驹溃,容器真正調(diào)用的是其子類(lèi)AbstractRefreshableApplicationContext 實(shí)現(xiàn)的refreshBeanFactory()方法,方法的源碼如下:
protected final void refreshBeanFactory() throws BeansException {
if (hasBeanFactory()) {//如果已經(jīng)有容器延曙,銷(xiāo)毀容器中的bean豌鹤,關(guān)閉容器
destroyBeans();
closeBeanFactory();
}
try {
//創(chuàng)建IOC 容器
DefaultListableBeanFactory beanFactory = createBeanFactory();
beanFactory.setSerializationId(getId());
//對(duì)IOC 容器進(jìn)行定制化,如設(shè)置啟動(dòng)參數(shù)枝缔,開(kāi)啟注解的自動(dòng)裝配等
customizeBeanFactory(beanFactory);
//調(diào)用載入Bean 定義的方法布疙,主要這里又使用了一個(gè)委派模式,在當(dāng)前類(lèi)中只定義了抽象的loadBeanDefinitions
方法愿卸,具體的實(shí)現(xiàn)調(diào)用子類(lèi)容器
loadBeanDefinitions(beanFactory);
synchronized (this.beanFactoryMonitor) {
this.beanFactory = beanFactory;
}
}catch (IOException ex) {
throw new ApplicationContextException("I/O error parsing bean definition source for " +
getDisplayName(), ex);
}
}
在這個(gè)方法中灵临,先判斷BeanFactory 是否存在,如果存在則先銷(xiāo)毀beans 并關(guān)閉beanFactory趴荸,接著創(chuàng)建DefaultListableBeanFactory儒溉,并調(diào)用loadBeanDefinitions(beanFactory)裝載bean 定義。
⑤ AbstractRefreshableApplicationContext 子類(lèi)的loadBeanDefinitions 方法:
AbstractRefreshableApplicationContext 中只定義了抽象的loadBeanDefinitions 方法发钝,容器真正調(diào)用的是其子類(lèi)AbstractXmlApplicationContext 對(duì)該方法的實(shí)現(xiàn)AbstractXmlApplicationContext 的主要源碼如下:
loadBeanDefinitions
方法同樣是抽象方法顿涣,是由其子類(lèi)實(shí)現(xiàn)的波闹,也即在
AbstractXmlApplicationContext 中。
public abstract class AbstractXmlApplicationContext extends AbstractRefreshableConfigApplicationContext {
……
//實(shí)現(xiàn)父類(lèi)抽象的載入Bean 定義方法
@Override
protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException,IOException {
//創(chuàng)建XmlBeanDefinitionReader涛碑,即創(chuàng)建Bean 讀取器精堕,并通過(guò)回調(diào)設(shè)置到容器中去,容器使用該讀取器讀取Bean 定義資源
XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);
//為Bean 讀取器設(shè)置Spring 資源加載器蒲障,AbstractXmlApplicationContext 的
//祖先父類(lèi)AbstractApplicationContext 繼承DefaultResourceLoader歹篓,因此,容器本身也是一個(gè)資源加載器
beanDefinitionReader.setEnvironment(this.getEnvironment());
beanDefinitionReader.setResourceLoader(this);
//為Bean 讀取器設(shè)置SAX xml 解析器
beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));
//當(dāng)Bean 讀取器讀取Bean 定義的Xml 資源文件時(shí)揉阎,啟用Xml 的校驗(yàn)機(jī)制
initBeanDefinitionReader(beanDefinitionReader);
//Bean 讀取器真正實(shí)現(xiàn)加載的方法
loadBeanDefinitions(beanDefinitionReader);
}
//Xml Bean 讀取器加載Bean 定義資源
protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException,IOException {
//獲取Bean 定義資源的定位
Resource[] configResources = getConfigResources();
if (configResources != null) {
//Xml Bean 讀取器調(diào)用其父類(lèi)AbstractBeanDefinitionReader 讀取定位
//的Bean 定義資源
reader.loadBeanDefinitions(configResources);
}
//如果子類(lèi)中獲取的Bean 定義資源定位為空庄撮,則獲取FileSystemXmlApplicationContext 構(gòu)造方法中setConfigLocations 方法設(shè)置的資源
String[] configLocations = getConfigLocations();
if (configLocations != null) {
//Xml Bean 讀取器調(diào)用其父類(lèi)AbstractBeanDefinitionReader 讀取定位
//的Bean 定義資源
reader.loadBeanDefinitions(configLocations);
}
}
//這里又使用了一個(gè)委托模式,調(diào)用子類(lèi)的獲取Bean 定義資源定位的方法
//該方法在ClassPathXmlApplicationContext 中進(jìn)行實(shí)現(xiàn)毙籽,對(duì)于我們
//舉例分析源碼的FileSystemXmlApplicationContext 沒(méi)有使用該方法
protected Resource[] getConfigResources() {
return null;
}
……
}
Xml Bean 讀取器(XmlBeanDefinitionReader)調(diào)用其父類(lèi)AbstractBeanDefinitionReader的reader.loadBeanDefinitions 方法讀取Bean 定義資源洞斯。
由于我們使用FileSystemXmlApplicationContext 作為例子分析,因此getConfigResources 的返回值為null惧财,因此程序執(zhí)行reader.loadBeanDefinitions(configLocations)分支巡扇。
⑥ AbstractBeanDefinitionReader 讀取Bean 定義資源:
AbstractBeanDefinitionReader 的loadBeanDefinitions 方法源碼如下:
可以到org.springframework.beans.factory.support
看一下BeanDefinitionReader 的結(jié)構(gòu)
在其抽象父類(lèi)AbstractBeanDefinitionReader 中定義了載入過(guò)程
//重載方法,調(diào)用下面的loadBeanDefinitions(String, Set<Resource>);方法
public int loadBeanDefinitions(String location) throws BeanDefinitionStoreException {
return loadBeanDefinitions(location, null);
}
public int loadBeanDefinitions(String location, Set<Resource> actualResources) throws BeanDefinitionStoreException {
//獲取在IoC 容器初始化過(guò)程中設(shè)置的資源加載器
ResourceLoader resourceLoader = getResourceLoader();
if (resourceLoader == null) {
throw new BeanDefinitionStoreException(
"Cannot import bean definitions from location [" + location + "]: no ResourceLoader available");
}
if (resourceLoader instanceof ResourcePatternResolver) {
try {
//將指定位置的Bean 定義資源文件解析為Spring IOC 容器封裝的資源
//加載多個(gè)指定位置的Bean 定義資源文件
Resource[] resources = ((ResourcePatternResolver)
resourceLoader).getResources(location);
//委派調(diào)用其子類(lèi)XmlBeanDefinitionReader 的方法垮衷,實(shí)現(xiàn)加載功能
int loadCount = loadBeanDefinitions(resources);
if (actualResources != null) {
for (Resource resource : resources) {
actualResources.add(resource);
}
}
if (logger.isDebugEnabled()) {
logger.debug("Loaded " + loadCount + " bean definitions from location pattern [" +
location + "]");
}
return loadCount;
}catch (IOException ex) {
throw new BeanDefinitionStoreException(
"Could not resolve bean definition resource pattern [" + location + "]", ex);
}
}else {
//將指定位置的Bean 定義資源文件解析為Spring IOC 容器封裝的資源
//加載單個(gè)指定位置的Bean 定義資源文件
Resource resource = resourceLoader.getResource(location);
//委派調(diào)用其子類(lèi)XmlBeanDefinitionReader 的方法厅翔,實(shí)現(xiàn)加載功能
int loadCount = loadBeanDefinitions(resource);
if (actualResources != null) {
actualResources.add(resource);
}
if (logger.isDebugEnabled()) {
logger.debug("Loaded " + loadCount + " bean definitions from location [" + location + "]");
}
return loadCount;
}
}
//重載方法,調(diào)用loadBeanDefinitions(String);
public int loadBeanDefinitions(String... locations) throws BeanDefinitionStoreException {
Assert.notNull(locations, "Location array must not be null");
int counter = 0;
for (String location : locations) {
counter += loadBeanDefinitions(location);
}
return counter;
}
loadBeanDefinitions(Resource...resources)方法和上面分析的3 個(gè)方法類(lèi)似搀突,同樣也是調(diào)用XmlBeanDefinitionReader 的loadBeanDefinitions 方法刀闷。
從對(duì)AbstractBeanDefinitionReader 的loadBeanDefinitions 方法源碼分析可以看出該方法做了以下兩件事:
首先,調(diào)用資源加載器的獲取資源方法resourceLoader.getResource(location)仰迁,獲取到要加載的資源甸昏。
其次,真正執(zhí)行加載功能是其子類(lèi)XmlBeanDefinitionReader 的loadBeanDefinitions 方法徐许。
看到第8施蜜、16 行,結(jié)合上面的ResourceLoader 與ApplicationContext 的繼承系圖雌隅,可以知道此時(shí)調(diào)用的是DefaultResourceLoader 中的getSource()方法定位Resource翻默,因?yàn)镕ileSystemXmlApplicationContext 本身就是DefaultResourceLoader 的實(shí)現(xiàn)類(lèi),所以此時(shí)又回到了FileSystemXmlApplicationContext
中來(lái)恰起。
⑦ 資源加載器獲取要讀入的資源:
XmlBeanDefinitionReader 通過(guò)調(diào)用其父類(lèi)DefaultResourceLoader 的getResource 方法獲取要加載的資源修械,其源碼如下
//獲取Resource 的具體實(shí)現(xiàn)方法
public Resource getResource(String location) {
Assert.notNull(location, "Location must not be null");
//如果是類(lèi)路徑的方式,那需要使用ClassPathResource 來(lái)得到bean 文件的資源對(duì)象
if (location.startsWith(CLASSPATH_URL_PREFIX)) {
return new ClassPathResource(location.substring(CLASSPATH_URL_PREFIX.length()), getClassLoader());
}
try {
// 如果是URL 方式检盼,使用UrlResource 作為bean 文件的資源對(duì)象
URL url = new URL(location);
return new UrlResource(url);
}catch (MalformedURLException ex) {
}
//如果既不是classpath 標(biāo)識(shí)肯污,又不是URL 標(biāo)識(shí)的Resource 定位,則調(diào)用
//容器本身的getResourceByPath 方法獲取Resource
return getResourceByPath(location);
}
FileSystemXmlApplicationContext 容器提供了getResourceByPath 方法的實(shí)現(xiàn),就是為了處理既不是classpath 標(biāo)識(shí)蹦渣,又不是URL 標(biāo)識(shí)的Resource 定位這種情況哄芜。
protected Resource getResourceByPath(String path) {
if (path != null && path.startsWith("/")) {
path = path.substring(1);
}
//這里使用文件系統(tǒng)資源對(duì)象來(lái)定義bean 文件
return new FileSystemResource(path);
}
這樣,代碼就回到了FileSystemXmlApplicationContext 中來(lái)剂桥,他提供了FileSystemResource 來(lái)完成從文件系統(tǒng)得到配置文件的資源定義忠烛。
這樣属提,就可以從文件系統(tǒng)路徑上對(duì)IOC 配置文件進(jìn)行加載- 當(dāng)然我們可以按照這個(gè)邏輯從任何地方加載权逗,在Spring 中我們看到它提供的各種資源抽象,比如ClassPathResource, URLResource,FileSystemResource 等來(lái)供我們使用冤议。上面我們看到的是定位Resource 的一個(gè)過(guò)程斟薇,而這只是加載過(guò)程的一部分.
⑧ XmlBeanDefinitionReader 加載Bean 定義資源:
Bean 定義的Resource 得到了
繼續(xù)回到XmlBeanDefinitionReader 的loadBeanDefinitions(Resource …)方法看到代表bean 文件的資源定義以后的載入過(guò)程。
//XmlBeanDefinitionReader 加載資源的入口方法
public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {
//將讀入的XML 資源進(jìn)行特殊編碼處理
return loadBeanDefinitions(new EncodedResource(resource));
}
//這里是載入XML 形式Bean 定義資源文件方法
public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
.......
try {
//將資源文件轉(zhuǎn)為InputStream 的IO 流
InputStream inputStream = encodedResource.getResource().getInputStream();
try {
//從InputStream 中得到XML 的解析源
InputSource inputSource = new InputSource(inputStream);
if (encodedResource.getEncoding() != null) {
inputSource.setEncoding(encodedResource.getEncoding());
}
//這里是具體的讀取過(guò)程
return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
}finally {
//關(guān)閉從Resource 中得到的IO 流
inputStream.close();
}
}
.........
}
//從特定XML 文件中實(shí)際載入Bean 定義資源的方法
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
try {
int validationMode = getValidationModeForResource(resource);
//將XML 文件轉(zhuǎn)換為DOM 對(duì)象恕酸,解析過(guò)程由documentLoader 實(shí)現(xiàn)
Document doc = this.documentLoader.loadDocument(inputSource, this.entityResolver, this.errorHandler, validationMode,this.namespaceAware);
//這里是啟動(dòng)對(duì)Bean 定義解析的詳細(xì)過(guò)程堪滨,該解析過(guò)程會(huì)用到Spring 的Bean 配置規(guī)則
return registerBeanDefinitions(doc, resource);
}
.......
}
通過(guò)源碼分析,載入Bean 定義資源文件的最后一步是將Bean 定義資源轉(zhuǎn)換為Document 對(duì)象蕊温,該過(guò)程由documentLoader 實(shí)現(xiàn)
⑨ DocumentLoader 將Bean 定義資源轉(zhuǎn)換為Document 對(duì)象:
DocumentLoader 將Bean 定義資源轉(zhuǎn)換成Document 對(duì)象的源碼如下:
//使用標(biāo)準(zhǔn)的JAXP 將載入的Bean 定義資源轉(zhuǎn)換成document 對(duì)象
public Document loadDocument(InputSource inputSource, EntityResolver entityResolver,ErrorHandler errorHandler, int validationMode, boolean namespaceAware) throws Exception{
//創(chuàng)建文件解析器工廠
DocumentBuilderFactory factory = createDocumentBuilderFactory(validationMode,
namespaceAware);
if (logger.isDebugEnabled()) {
logger.debug("Using JAXP provider [" + factory.getClass().getName() + "]");
}
//創(chuàng)建文檔解析器
DocumentBuilder builder = createDocumentBuilder(factory, entityResolver, errorHandler);
//解析Spring 的Bean 定義資源
return builder.parse(inputSource);
}
protected DocumentBuilderFactory createDocumentBuilderFactory(int validationMode, boolean namespaceAware)
throws ParserConfigurationException {
//創(chuàng)建文檔解析工廠
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
factory.setNamespaceAware(namespaceAware);
//設(shè)置解析XML 的校驗(yàn)
if (validationMode != XmlValidationModeDetector.VALIDATION_NONE) {
factory.setValidating(true);
if (validationMode == XmlValidationModeDetector.VALIDATION_XSD) {
factory.setNamespaceAware(true);
try {
factory.setAttribute(SCHEMA_LANGUAGE_ATTRIBUTE, XSD_SCHEMA_LANGUAGE);
}catch (IllegalArgumentException ex) {
ParserConfigurationException pcex = new ParserConfigurationException(
"Unable to validate using XSD: Your JAXP provider [" + factory +
"] does not support XML Schema. Are you running on Java 1.with Apache Crimson?
" + "Upgrade to Apache Xerces (or Java 1.5) for full XSD support.");
pcex.initCause(ex);
throw pcex;
}
}
}
return factory;
}
該解析過(guò)程調(diào)用JavaEE 標(biāo)準(zhǔn)的JAXP 標(biāo)準(zhǔn)進(jìn)行處理袱箱。
至此Spring IOC 容器根據(jù)定位的Bean 定義資源文件,將其加載讀入并轉(zhuǎn)換成為Document 對(duì)象過(guò)程完成义矛。
接下來(lái)我們要繼續(xù)分析Spring IOC 容器將載入的Bean 定義資源文件轉(zhuǎn)換為Document 對(duì)象之后发笔,是如何將其解析為Spring IOC 管理的Bean 對(duì)象并將其注冊(cè)到容器中的。
⑩ XmlBeanDefinitionReader 解析載入的Bean 定義資源文件:
XmlBeanDefinitionReader 類(lèi)中的doLoadBeanDefinitions 方法是從特定XML 文件中實(shí)際載入Bean 定義資源的方法凉翻,該方法在載入Bean 定義資源之后將其轉(zhuǎn)換為Document 對(duì)象了讨,接下來(lái)調(diào)用registerBeanDefinitions
啟動(dòng)Spring IOC 容器對(duì)Bean 定義的解析過(guò)程,registerBeanDefinitions方法源碼如下:
//按照Spring 的Bean 語(yǔ)義要求將Bean 定義資源解析并轉(zhuǎn)換為容器內(nèi)部數(shù)據(jù)結(jié)構(gòu)
public int registerBeanDefinitions(Document doc, Resource resource) throws
BeanDefinitionStoreException {
//得到BeanDefinitionDocumentReader 來(lái)對(duì)xml 格式的BeanDefinition 解析
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
//獲得容器中注冊(cè)的Bean 數(shù)量
int countBefore = getRegistry().getBeanDefinitionCount();
//解析過(guò)程入口制轰,這里使用了委派模式前计,BeanDefinitionDocumentReader 只是個(gè)接口,
//具體的解析實(shí)現(xiàn)過(guò)程有實(shí)現(xiàn)類(lèi)DefaultBeanDefinitionDocumentReader 完成
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
//統(tǒng)計(jì)解析的Bean 數(shù)量
return getRegistry().getBeanDefinitionCount() - countBefore;
}
//創(chuàng)建BeanDefinitionDocumentReader 對(duì)象垃杖,解析Document 對(duì)象
protected BeanDefinitionDocumentReader createBeanDefinitionDocumentReader() {
return
BeanDefinitionDocumentReader.class.cast(BeanUtils.instantiateClass(this.documentReaderClass));
}
Bean 定義資源的載入解析分為以下兩個(gè)過(guò)程:
首先男杈,通過(guò)調(diào)用XML 解析器將Bean 定義資源文件轉(zhuǎn)換得到Document 對(duì)象,但是這些Document 對(duì)象并沒(méi)有按照Spring 的Bean 規(guī)則進(jìn)行解析调俘。這一步是載入的過(guò)程
其次伶棒,在完成通用的XML 解析之后,按照Spring 的Bean 規(guī)則對(duì)Document 對(duì)象進(jìn)行解析脉漏。
按照Spring 的Bean 規(guī)則對(duì)Document 對(duì)象解析的過(guò)程是在接口BeanDefinitionDocumentReader 的實(shí)現(xiàn)類(lèi)DefaultBeanDefinitionDocumentReader 中實(shí)現(xiàn)的苞冯。
⑩① DefaultBeanDefinitionDocumentReader 對(duì)Bean 定義的Document 對(duì)象解析:
BeanDefinitionDocumentReader 接口通過(guò)registerBeanDefinitions 方法調(diào)用其實(shí)現(xiàn)類(lèi)DefaultBeanDefinitionDocumentReader 對(duì)Document 對(duì)象進(jìn)行解析,解析的代碼如下:
//根據(jù)Spring DTD 對(duì)Bean 的定義規(guī)則解析Bean 定義Document 對(duì)象
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
//獲得XML 描述符
this.readerContext = readerContext;
logger.debug("Loading bean definitions");
//獲得Document 的根元素
Element root = doc.getDocumentElement();
//具體的解析過(guò)程由BeanDefinitionParserDelegate 實(shí)現(xiàn)侧巨,
//BeanDefinitionParserDelegate 中定義了Spring Bean 定義XML 文件的各種元素
BeanDefinitionParserDelegate delegate = createHelper(readerContext, root);
//在解析Bean 定義之前舅锄,進(jìn)行自定義的解析,增強(qiáng)解析過(guò)程的可擴(kuò)展性
preProcessXml(root);
//從Document 的根元素開(kāi)始進(jìn)行Bean 定義的Document 對(duì)象
parseBeanDefinitions(root, delegate);
//在解析Bean 定義之后,進(jìn)行自定義的解析皇忿,增加解析過(guò)程的可擴(kuò)展性
postProcessXml(root);
}
//創(chuàng)建BeanDefinitionParserDelegate畴蹭,用于完成真正的解析過(guò)程
protected BeanDefinitionParserDelegate createHelper(XmlReaderContext readerContext, Element root){
BeanDefinitionParserDelegate delegate = new BeanDefinitionParserDelegate(readerContext);
//BeanDefinitionParserDelegate 初始化Document 根元素
delegate.initDefaults(root);
return delegate;
}
//使用Spring 的Bean 規(guī)則從Document 的根元素開(kāi)始進(jìn)行Bean 定義的Document 對(duì)象
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
//Bean 定義的Document 對(duì)象使用了Spring 默認(rèn)的XML 命名空間
if (delegate.isDefaultNamespace(root)) {
//獲取Bean 定義的Document 對(duì)象根元素的所有子節(jié)點(diǎn)
NodeList nl = root.getChildNodes();
for (int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
//獲得Document 節(jié)點(diǎn)是XML 元素節(jié)點(diǎn)
if (node instanceof Element) {
Element ele = (Element) node;
//Bean 定義的Document 的元素節(jié)點(diǎn)使用的是Spring 默認(rèn)的XML 命名空間
if (delegate.isDefaultNamespace(ele)) {
//使用Spring 的Bean 規(guī)則解析元素節(jié)點(diǎn)
parseDefaultElement(ele, delegate);
}else {
//沒(méi)有使用Spring 默認(rèn)的XML 命名空間,則使用用戶自定義的解//析規(guī)則解析元素節(jié)點(diǎn)
delegate.parseCustomElement(ele);
}
}
}
}else {
//Document 的根節(jié)點(diǎn)沒(méi)有使用Spring 默認(rèn)的命名空間鳍烁,則使用用戶自定義的
//解析規(guī)則解析Document 根節(jié)點(diǎn)
delegate.parseCustomElement(root);
}
}
//使用Spring 的Bean 規(guī)則解析Document 元素節(jié)點(diǎn)
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
//如果元素節(jié)點(diǎn)是<Import>導(dǎo)入元素叨襟,進(jìn)行導(dǎo)入解析
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
importBeanDefinitionResource(ele);
}
//如果元素節(jié)點(diǎn)是<Alias>別名元素,進(jìn)行別名解析
else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
processAliasRegistration(ele);
}
//元素節(jié)點(diǎn)既不是導(dǎo)入元素幔荒,也不是別名元素糊闽,即普通的<Bean>元素,
//按照Spring 的Bean 規(guī)則解析元素
else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
processBeanDefinition(ele, delegate);
}
}
//解析<Import>導(dǎo)入元素爹梁,從給定的導(dǎo)入路徑加載Bean 定義資源到Spring IoC 容器中
protected void importBeanDefinitionResource(Element ele) {
//獲取給定的導(dǎo)入元素的location 屬性
String location = ele.getAttribute(RESOURCE_ATTRIBUTE);
//如果導(dǎo)入元素的location 屬性值為空右犹,則沒(méi)有導(dǎo)入任何資源,直接返回
if (!StringUtils.hasText(location)) {
getReaderContext().error("Resource location must not be empty", ele);
return;
}
//使用系統(tǒng)變量值解析location 屬性值
location = SystemPropertyUtils.resolvePlaceholders(location);
Set<Resource> actualResources = new LinkedHashSet<Resource>(4);
//標(biāo)識(shí)給定的導(dǎo)入元素的location 是否是絕對(duì)路徑
boolean absoluteLocation = false;
try {
absoluteLocation = ResourcePatternUtils.isUrl(location) ||
ResourceUtils.toURI(location).isAbsolute();
}
catch (URISyntaxException ex) {
//給定的導(dǎo)入元素的location 不是絕對(duì)路徑
}
//給定的導(dǎo)入元素的location 是絕對(duì)路徑
if (absoluteLocation) {
try {
//使用資源讀入器加載給定路徑的Bean 定義資源
int importCount = getReaderContext().getReader().loadBeanDefinitions(location,
actualResources);
if (logger.isDebugEnabled()) {
logger.debug("Imported " + importCount + " bean definitions from URL location [" + location + "]");
}
}catch (BeanDefinitionStoreException ex) {
getReaderContext().error(
"Failed to import bean definitions from URL location [" + location + "]", ele, ex);
}
}else {
//給定的導(dǎo)入元素的location 是相對(duì)路徑
try {
int importCount;
//將給定導(dǎo)入元素的location 封裝為相對(duì)路徑資源
Resource relativeResource = getReaderContext().getResource().createRelative(location);
//封裝的相對(duì)路徑資源存在
if (relativeResource.exists()) {
//使用資源讀入器加載Bean 定義資源
importCount = getReaderContext().getReader().loadBeanDefinitions(relativeResource);
actualResources.add(relativeResource);
}
//封裝的相對(duì)路徑資源不存在
else {
//獲取Spring IOC 容器資源讀入器的基本路徑
String baseLocation = getReaderContext().getResource().getURL().toString();
//根據(jù)Spring IoC 容器資源讀入器的基本路徑加載給定導(dǎo)入
//路徑的資源
importCount = getReaderContext().getReader().loadBeanDefinitions(
StringUtils.applyRelativePath(baseLocation, location), actualResources);
}
if (logger.isDebugEnabled()) {
logger.debug("Imported " + importCount + " bean definitions from relative location [" + location + "]");
}
}catch (IOException ex) {
getReaderContext().error("Failed to resolve current resource location", ele, ex);
}catch (BeanDefinitionStoreException ex) {
getReaderContext().error("Failed to import bean definitions from relative location [" + location + "]", ele, ex);
}
}
Resource[] actResArray = actualResources.toArray(new Resource[actualResources.size()]);
//在解析完<Import>元素之后姚垃,發(fā)送容器導(dǎo)入其他資源處理完成事件
getReaderContext().fireImportProcessed(location, actResArray, extractSource(ele));
}
//解析<Alias>別名元素念链,為Bean 向Spring IoC 容器注冊(cè)別名
protected void processAliasRegistration(Element ele) {
//獲取<Alias>別名元素中name 的屬性值
String name = ele.getAttribute(NAME_ATTRIBUTE);
//獲取<Alias>別名元素中alias 的屬性值
String alias = ele.getAttribute(ALIAS_ATTRIBUTE);
boolean valid = true;
//<alias>別名元素的name 屬性值為空
if (!StringUtils.hasText(name)) {
getReaderContext().error("Name must not be empty", ele);
valid = false;
}
//<alias>別名元素的alias 屬性值為空
if (!StringUtils.hasText(alias)) {
getReaderContext().error("Alias must not be empty", ele);
valid = false;
}
if (valid) {
try {
//向容器的資源讀入器注冊(cè)別名
getReaderContext().getRegistry().registerAlias(name, alias);
}
catch (Exception ex) {
getReaderContext().error("Failed to register alias '" + alias +
"' for bean with name '" + name + "'", ele, ex);
}
//在解析完<Alias>元素之后,發(fā)送容器別名處理完成事件
getReaderContext().fireAliasRegistered(name, alias, extractSource(ele));
}
}
//解析Bean 定義資源Document 對(duì)象的普通元素
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
// BeanDefinitionHolder 是對(duì)BeanDefinition 的封裝积糯,即Bean 定義的封裝類(lèi)
//對(duì)Document 對(duì)象中<Bean>元素的解析由BeanDefinitionParserDelegate 實(shí)現(xiàn)BeanDefinitionHolder
bdHolder = delegate.parseBeanDefinitionElement(ele);
if (bdHolder != null) {
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
try {
//向Spring IoC 容器注冊(cè)解析得到的Bean 定義掂墓,這是Bean 定義向IOC 容器注冊(cè)的入口
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder,
getReaderContext().getRegistry());
}
catch (BeanDefinitionStoreException ex) {
getReaderContext().error("Failed to register bean definition with name '" +
bdHolder.getBeanName() + "'", ele, ex);
}
//在完成向Spring IoC 容器注冊(cè)解析得到的Bean 定義之后,發(fā)送注冊(cè)事件
getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
}
}
通過(guò)上述Spring IOC 容器對(duì)載入的Bean 定義Document 解析可以看出看成,我們使用Spring 時(shí)君编,在Spring配置文件中可以使用<Import>元素來(lái)導(dǎo)入IOC 容器所需要的其他資源,Spring IoC 容器在解析時(shí)會(huì)首先將指定導(dǎo)入的資源加載進(jìn)容器中绍昂。使用<Ailas>別名時(shí)啦粹,Spring IOC 容器首先將別名元素所定義的別名注冊(cè)到容器中。
對(duì)于既不是<Import>元素窘游,又不是<Alias>元素的元素唠椭,即Spring 配置文件中普通的<Bean>元素的解析由BeanDefinitionParserDelegate 類(lèi)的parseBeanDefinitionElement 方法來(lái)實(shí)現(xiàn)。
⑩② BeanDefinitionParserDelegate 解析Bean 定義資源文件中的<Bean>元素:
Bean 定義資源文件中的<Import>和<Alias>元素解析在DefaultBeanDefinitionDocumentReader 中已經(jīng)完成忍饰,對(duì)Bean 定義資源文件中使用最多的<Bean>元素交由BeanDefinitionParserDelegate 來(lái)解析贪嫂,其解析實(shí)現(xiàn)的源碼如下:
//解析<Bean>元素的入口
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
return parseBeanDefinitionElement(ele, null);
}
//解析Bean 定義資源文件中的<Bean>元素,這個(gè)方法中主要處理<Bean>元素的id艾蓝,name
//和別名屬性
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition
containingBean) {
//獲取<Bean>元素中的id 屬性值
String id = ele.getAttribute(ID_ATTRIBUTE);
//獲取<Bean>元素中的name 屬性值
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
//獲取<Bean>元素中的alias 屬性值
List<String> aliases = new ArrayList<String>();
//將<Bean>元素中的所有name 屬性值存放到別名中
if (StringUtils.hasLength(nameAttr)) {
String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, BEAN_NAME_DELIMITERS);
aliases.addAll(Arrays.asList(nameArr));
}
String beanName = id;
//如果<Bean>元素中沒(méi)有配置id 屬性時(shí)力崇,將別名中的第一個(gè)值賦值給beanName
if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
beanName = aliases.remove(0);
if (logger.isDebugEnabled()) {
logger.debug("No XML 'id' specified - using '" + beanName +
"' as bean name and " + aliases + " as aliases");
}
}
//檢查<Bean>元素所配置的id 或者name 的唯一性,containingBean 標(biāo)識(shí)<Bean>
//元素中是否包含子<Bean>元素
if (containingBean == null) {
//檢查<Bean>元素所配置的id赢织、name 或者別名是否重復(fù)
checkNameUniqueness(beanName, aliases, ele);
}
//詳細(xì)對(duì)<Bean>元素中配置的Bean 定義進(jìn)行解析的地方
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName,
containingBean);
if (beanDefinition != null) {
if (!StringUtils.hasText(beanName)) {
try {
if (containingBean != null) {
//如果<Bean>元素中沒(méi)有配置id亮靴、別名或者name,且沒(méi)有包含子元素
//<Bean>元素于置,為解析的Bean 生成一個(gè)唯一beanName 并注冊(cè)
beanName = BeanDefinitionReaderUtils.generateBeanName(
beanDefinition, this.readerContext.getRegistry(), true);
}else {
//如果<Bean>元素中沒(méi)有配置id茧吊、別名或者name,且包含了子元素
//<Bean>元素,為解析的Bean 使用別名向IOC 容器注冊(cè)
beanName = this.readerContext.generateBeanName(beanDefinition);
//為解析的Bean 使用別名注冊(cè)時(shí)搓侄,為了向后兼容
//Spring1.2/2.0瞄桨,給別名添加類(lèi)名后綴
String beanClassName = beanDefinition.getBeanClassName();
if (beanClassName != null &&
beanName.startsWith(beanClassName) && beanName.length() >
beanClassName.length() &&
!this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {
aliases.add(beanClassName);
}
}
if (logger.isDebugEnabled()) {
logger.debug("Neither XML 'id' nor 'name' specified - " +
"using generated bean name [" + beanName + "]");
}
}catch (Exception ex) {
error(ex.getMessage(), ele);
return null;
}
}
String[] aliasesArray = StringUtils.toStringArray(aliases);
return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
}
//當(dāng)解析出錯(cuò)時(shí),返回null
return null;
}
//詳細(xì)對(duì)<Bean>元素中配置的Bean 定義其他屬性進(jìn)行解析讶踪,由于上面的方法中已經(jīng)對(duì)
//Bean 的id芯侥、name 和別名等屬性進(jìn)行了處理,該方法中主要處理除這三個(gè)以外的其他屬性數(shù)據(jù)
public AbstractBeanDefinition parseBeanDefinitionElement(
Element ele, String beanName, BeanDefinition containingBean) {
//記錄解析的<Bean>
this.parseState.push(new BeanEntry(beanName));
//這里只讀取<Bean>元素中配置的class 名字乳讥,然后載入到BeanDefinition 中去
//只是記錄配置的class 名字柱查,不做實(shí)例化,對(duì)象的實(shí)例化在依賴注入時(shí)完成
String className = null;
if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
}
try {
String parent = null;
//如果<Bean>元素中配置了parent 屬性雏婶,則獲取parent 屬性的值
if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
parent = ele.getAttribute(PARENT_ATTRIBUTE);
}
//根據(jù)<Bean>元素配置的class 名稱和parent 屬性值創(chuàng)建BeanDefinition
//為載入Bean 定義信息做準(zhǔn)備
AbstractBeanDefinition bd = createBeanDefinition(className, parent);
//對(duì)當(dāng)前的<Bean>元素中配置的一些屬性進(jìn)行解析和設(shè)置物赶,如配置的單態(tài)(singleton)屬性等
parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
//為<Bean>元素解析的Bean 設(shè)置description 信息
bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
//對(duì)<Bean>元素的meta(元信息)屬性解析
parseMetaElements(ele, bd);
//對(duì)<Bean>元素的lookup-method 屬性解析
parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
//對(duì)<Bean>元素的replaced-method 屬性解析
parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
//解析<Bean>元素的構(gòu)造方法設(shè)置
parseConstructorArgElements(ele, bd);
//解析<Bean>元素的<property>設(shè)置
parsePropertyElements(ele, bd);
//解析<Bean>元素的qualifier 屬性
parseQualifierElements(ele, bd);
//為當(dāng)前解析的Bean 設(shè)置所需的資源和依賴對(duì)象
bd.setResource(this.readerContext.getResource());
bd.setSource(extractSource(ele));
return bd;
}
catch (ClassNotFoundException ex) {
error("Bean class [" + className + "] not found", ele, ex);
}
catch (NoClassDefFoundError err) {
error("Class that bean class [" + className + "] depends on not found", ele, err);
}
catch (Throwable ex) {
error("Unexpected failure during bean definition parsing", ele, ex);
}
finally {
this.parseState.pop();
}
//解析<Bean>元素出錯(cuò)時(shí)白指,返回null
return null;
}
只要使用過(guò)Spring留晚,對(duì)Spring 配置文件比較熟悉的人,通過(guò)對(duì)上述源碼的分析告嘲,就會(huì)明白我們?cè)赟pring配置文件中<Bean>元素的中配置的屬性就是通過(guò)該方法解析和設(shè)置到Bean 中去的错维。
注意:在解析<Bean>元素過(guò)程中沒(méi)有創(chuàng)建和實(shí)例化Bean 對(duì)象,只是創(chuàng)建了Bean 對(duì)象的定義類(lèi)BeanDefinition橄唬,將<Bean>元素中的配置信息設(shè)置到BeanDefinition 中作為記錄赋焕,當(dāng)依賴注入時(shí)才使用這些記錄信息創(chuàng)建和實(shí)例化具體的Bean 對(duì)象。
上面方法中一些對(duì)一些配置如元信息(meta)仰楚、qualifier 等的解析隆判,我們?cè)赟pring 中配置時(shí)使用的也不多,我們?cè)谑褂肧pring 的<Bean>元素時(shí)僧界,配置最多的是<property>屬性侨嘀,因此我們下面繼續(xù)分析源碼,了解Bean 的屬性在解析時(shí)是如何設(shè)置的捂襟。
⑩③ BeanDefinitionParserDelegate 解析<property>元素:
BeanDefinitionParserDelegate 在解析<Bean>調(diào)parsePropertyElements 方法解析<Bean>元素中的<property>屬性子元素咬腕,解析源碼如下:
//解析<Bean>元素中的<property>子元素
public void parsePropertyElements(Element beanEle, BeanDefinition bd) {
//獲取<Bean>元素中所有的子元素
NodeList nl = beanEle.getChildNodes();
for (int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
//如果子元素是<property>子元素,則調(diào)用解析<property>子元素方法解析
if (isCandidateElement(node) && nodeNameEquals(node, PROPERTY_ELEMENT)) {
parsePropertyElement((Element) node, bd);
}
}
}
//解析<property>元素
public void parsePropertyElement(Element ele, BeanDefinition bd) {
//獲取<property>元素的名字
String propertyName = ele.getAttribute(NAME_ATTRIBUTE);
if (!StringUtils.hasLength(propertyName)) {
error("Tag 'property' must have a 'name' attribute", ele);
return;
}
this.parseState.push(new PropertyEntry(propertyName));
try {
//如果一個(gè)Bean 中已經(jīng)有同名的property 存在葬荷,則不進(jìn)行解析涨共,直接返回。
//即如果在同一個(gè)Bean 中配置同名的property宠漩,則只有第一個(gè)起作用
if (bd.getPropertyValues().contains(propertyName)) {
error("Multiple 'property' definitions for property '" + propertyName + "'", ele);
return;
}
//解析獲取property 的值
Object val = parsePropertyValue(ele, bd, propertyName);
//根據(jù)property 的名字和值創(chuàng)建property 實(shí)例
PropertyValue pv = new PropertyValue(propertyName, val);
//解析<property>元素中的屬性
parseMetaElements(ele, pv);
pv.setSource(extractSource(ele));
bd.getPropertyValues().addPropertyValue(pv);
}finally {
this.parseState.pop();
}
}
//解析獲取property 值
public Object parsePropertyValue(Element ele, BeanDefinition bd, String propertyName) {
String elementName = (propertyName != null) ?
"<property> element for property '" + propertyName + "'" :
"<constructor-arg> element";
//獲取<property>的所有子元素举反,只能是其中一種類(lèi)型:ref,value,list 等
NodeList nl = ele.getChildNodes();
Element subElement = null;
for (int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
//子元素不是description 和meta 屬性
if (node instanceof Element && !nodeNameEquals(node, DESCRIPTION_ELEMENT) &&
!nodeNameEquals(node, META_ELEMENT)) {
if (subElement != null) {
error(elementName + " must not contain more than one sub-element", ele);
}
else {//當(dāng)前<property>元素包含有子元素
subElement = (Element) node;
}
}
}
//判斷property 的屬性值是ref 還是value,不允許既是ref 又是value
boolean hasRefAttribute = ele.hasAttribute(REF_ATTRIBUTE);
boolean hasValueAttribute = ele.hasAttribute(VALUE_ATTRIBUTE);
if ((hasRefAttribute && hasValueAttribute) ||
((hasRefAttribute || hasValueAttribute) && subElement != null)) {
error(elementName +
" is only allowed to contain either 'ref' attribute OR 'value' attribute OR
sub-element", ele);
}
//如果屬性是ref扒吁,創(chuàng)建一個(gè)ref 的數(shù)據(jù)對(duì)象RuntimeBeanReference
//這個(gè)對(duì)象封裝了ref 信息
if (hasRefAttribute) {
String refName = ele.getAttribute(REF_ATTRIBUTE);
if (!StringUtils.hasText(refName)) {
error(elementName + " contains empty 'ref' attribute", ele);
}
//一個(gè)指向運(yùn)行時(shí)所依賴對(duì)象的引用
RuntimeBeanReference ref = new RuntimeBeanReference(refName);
//設(shè)置這個(gè)ref 的數(shù)據(jù)對(duì)象是被當(dāng)前的property 對(duì)象所引用
ref.setSource(extractSource(ele));
return ref;
}
//如果屬性是value火鼻,創(chuàng)建一個(gè)value 的數(shù)據(jù)對(duì)象TypedStringValue
//這個(gè)對(duì)象封裝了value 信息
else if (hasValueAttribute) {
//一個(gè)持有String 類(lèi)型值的對(duì)象
TypedStringValue valueHolder = new TypedStringValue(ele.getAttribute(VALUE_ATTRIBUTE));
//設(shè)置這個(gè)value 數(shù)據(jù)對(duì)象是被當(dāng)前的property 對(duì)象所引用
valueHolder.setSource(extractSource(ele));
return valueHolder;
}
//如果當(dāng)前<property>元素還有子元素
else if (subElement != null) {
//解析<property>的子元素
return parsePropertySubElement(subElement, bd);
}else {
//propery 屬性中既不是ref,也不是value 屬性,解析出錯(cuò)返回null
error(elementName + " must specify a ref or value", ele);
return null;
}
}
通過(guò)對(duì)上述源碼的分析凝危,我們可以了解在Spring 配置文件中波俄,<Bean>元素中<property>元素的相關(guān)配置是如何處理的:
a. ref 被封裝為指向依賴對(duì)象一個(gè)引用。
b.value 配置都會(huì)封裝成一個(gè)字符串類(lèi)型的對(duì)象蛾默。
c.ref 和value 都通過(guò)“解析的數(shù)據(jù)類(lèi)型屬性值.setSource(extractSource(ele));”方法將屬性值/引用與所引用的屬性關(guān)聯(lián)起來(lái)懦铺。
在方法的最后對(duì)于<property>元素的子元素通過(guò)parsePropertySubElement 方法解析,我們繼續(xù)分析該方法的源碼支鸡,了解其解析過(guò)程冬念。
⑩④ 解析<property>元素的子元素:
在BeanDefinitionParserDelegate 類(lèi)中的parsePropertySubElement 方法對(duì)<property>中的子元素解析,源碼如下:
//解析<property>元素中ref,value 或者集合等子元素
public Object parsePropertySubElement(Element ele, BeanDefinition bd, String defaultValueType) {
//如果<property>沒(méi)有使用Spring 默認(rèn)的命名空間牧挣,則使用用戶自定義的規(guī)則解析
//內(nèi)嵌元素
if (!isDefaultNamespace(ele)) {
return parseNestedCustomElement(ele, bd);
}
//如果子元素是bean急前,則使用解析<Bean>元素的方法解析
else if (nodeNameEquals(ele, BEAN_ELEMENT)) {
BeanDefinitionHolder nestedBd = parseBeanDefinitionElement(ele, bd);
if (nestedBd != null) {
nestedBd = decorateBeanDefinitionIfRequired(ele, nestedBd, bd);
}
return nestedBd;
}
//如果子元素是ref,ref 中只能有以下3 個(gè)屬性:bean瀑构、local裆针、parent
else if (nodeNameEquals(ele, REF_ELEMENT)) {
//獲取<property>元素中的bean 屬性值,引用其他解析的Bean 的名稱
//可以不再同一個(gè)Spring 配置文件中寺晌,具體請(qǐng)參考Spring 對(duì)ref 的配置規(guī)則
String refName = ele.getAttribute(BEAN_REF_ATTRIBUTE);
boolean toParent = false;
if (!StringUtils.hasLength(refName)) {
//獲取<property>元素中的local 屬性值世吨,引用同一個(gè)Xml 文件中配置
//的Bean 的id,local 和ref 不同呻征,local 只能引用同一個(gè)配置文件中的Bean
refName = ele.getAttribute(LOCAL_REF_ATTRIBUTE);
if (!StringUtils.hasLength(refName)) {
//獲取<property>元素中parent 屬性值耘婚,引用父級(jí)容器中的Bean
refName = ele.getAttribute(PARENT_REF_ATTRIBUTE);
toParent = true;
if (!StringUtils.hasLength(refName)) {
error("'bean', 'local' or 'parent' is required for <ref> element", ele);
return null;
}
}
}
//沒(méi)有配置ref 的目標(biāo)屬性值
if (!StringUtils.hasText(refName)) {
error("<ref> element contains empty target attribute", ele);
return null;
}
//創(chuàng)建ref 類(lèi)型數(shù)據(jù),指向被引用的對(duì)象
RuntimeBeanReference ref = new RuntimeBeanReference(refName, toParent);
//設(shè)置引用類(lèi)型值是被當(dāng)前子元素所引用
ref.setSource(extractSource(ele));
return ref;
}
//如果子元素是<idref>陆赋,使用解析ref 元素的方法解析
else if (nodeNameEquals(ele, IDREF_ELEMENT)) {
return parseIdRefElement(ele);
}
//如果子元素是<value>沐祷,使用解析value 元素的方法解析
else if (nodeNameEquals(ele, VALUE_ELEMENT)) {
return parseValueElement(ele, defaultValueType);
}
//如果子元素是null,為<property>設(shè)置一個(gè)封裝null 值的字符串?dāng)?shù)據(jù)
else if (nodeNameEquals(ele, NULL_ELEMENT)) {
TypedStringValue nullHolder = new TypedStringValue(null);
nullHolder.setSource(extractSource(ele));
return nullHolder;
}
//如果子元素是<array>攒岛,使用解析array 集合子元素的方法解析
else if (nodeNameEquals(ele, ARRAY_ELEMENT)) {
return parseArrayElement(ele, bd);
}
//如果子元素是<list>赖临,使用解析list 集合子元素的方法解析
else if (nodeNameEquals(ele, LIST_ELEMENT)) {
return parseListElement(ele, bd);
}
//如果子元素是<set>,使用解析set 集合子元素的方法解析
else if (nodeNameEquals(ele, SET_ELEMENT)) {
return parseSetElement(ele, bd);
}
//如果子元素是<map>阵子,使用解析map 集合子元素的方法解析
else if (nodeNameEquals(ele, MAP_ELEMENT)) {
return parseMapElement(ele, bd);
}
//如果子元素是<props>思杯,使用解析props 集合子元素的方法解析
else if (nodeNameEquals(ele, PROPS_ELEMENT)) {
return parsePropsElement(ele);
}
//既不是ref,又不是value挠进,也不是集合色乾,則子元素配置錯(cuò)誤,返回null
else {
error("Unknown property sub-element: [" + ele.getNodeName() + "]", ele);
return null;
}
}
通過(guò)上述源碼分析领突,我們明白了在Spring 配置文件中暖璧,對(duì)<property>元素中配置的Array、List君旦、Set澎办、Map嘲碱、Prop 等各種集合子元素的都通過(guò)上述方法解析,生成對(duì)應(yīng)的數(shù)據(jù)對(duì)象局蚀,比如ManagedList麦锯、ManagedArray量愧、ManagedSet 等钉鸯,這些Managed 類(lèi)是Spring 對(duì)象BeanDefiniton 的數(shù)據(jù)封裝,對(duì)集合數(shù)據(jù)類(lèi)型的具體解析有各自的解析方法實(shí)現(xiàn)音同,解析方法的命名非常規(guī)范千扶,一目了然料祠,我們對(duì)<list>集合元素的解析方法進(jìn)行源碼分析,了解其實(shí)現(xiàn)過(guò)程澎羞。
⑩⑤ 解析<list>子元素:
在BeanDefinitionParserDelegate 類(lèi)中的parseListElement 方法就是具體實(shí)現(xiàn)解析<property>元素中的<list>集合子元素髓绽,源碼如下:
//解析<list>集合子元素
public List parseListElement(Element collectionEle, BeanDefinition bd) {
//獲取<list>元素中的value-type 屬性,即獲取集合元素的數(shù)據(jù)類(lèi)型
String defaultElementType = collectionEle.getAttribute(VALUE_TYPE_ATTRIBUTE);
//獲取<list>集合元素中的所有子節(jié)點(diǎn)
NodeList nl = collectionEle.getChildNodes();
//Spring 中將List 封裝為ManagedList
ManagedList<Object> target = new ManagedList<Object>(nl.getLength());
target.setSource(extractSource(collectionEle));
//設(shè)置集合目標(biāo)數(shù)據(jù)類(lèi)型
target.setElementTypeName(defaultElementType);
target.setMergeEnabled(parseMergeAttribute(collectionEle));
//具體的<list>元素解析
parseCollectionElements(nl, target, bd, defaultElementType);
return target;
}
//具體解析<list>集合元素妆绞,<array>顺呕、<list>和<set>都使用該方法解析
protected void parseCollectionElements(NodeList elementNodes, Collection<Object> target, BeanDefinition bd, String defaultElementType) {
//遍歷集合所有節(jié)點(diǎn)
for (int i = 0; i < elementNodes.getLength(); i++) {
Node node = elementNodes.item(i);
//節(jié)點(diǎn)不是description 節(jié)點(diǎn)
if (node instanceof Element && !nodeNameEquals(node, DESCRIPTION_ELEMENT)) {
//將解析的元素加入集合中,遞歸調(diào)用下一個(gè)子元素
target.add(parsePropertySubElement((Element) node, bd, defaultElementType));
}
}
}
經(jīng)過(guò)對(duì)Spring Bean 定義資源文件轉(zhuǎn)換的Document 對(duì)象中的元素層層解析摆碉,Spring IOC 現(xiàn)在已經(jīng)將XML 形式定義的Bean 定義資源文件轉(zhuǎn)換為Spring IOC 所識(shí)別的數(shù)據(jù)結(jié)構(gòu)——BeanDefinition塘匣,它是Bean 定義資源文件中配置的POJO 對(duì)象在Spring IOC 容器中的映射,我們可以通過(guò)AbstractBeanDefinition 為入口巷帝,看到了IOC 容器進(jìn)行索引、查詢和操作扫夜。
通過(guò)Spring IOC 容器對(duì)Bean 定義資源的解析后楞泼,IOC 容器大致完成了管理Bean 對(duì)象的準(zhǔn)備工作,即初始化過(guò)程笤闯,但是最為重要的依賴注入還沒(méi)有發(fā)生堕阔,現(xiàn)在在IOC 容器中BeanDefinition 存儲(chǔ)的只是一些靜態(tài)信息,接下來(lái)需要向容器注冊(cè)Bean 定義信息才能全部完成IoC 容器的初始化過(guò)程
⑩⑥ 解析過(guò)后的BeanDefinition 在IOC 容器中的注冊(cè):
讓我們繼續(xù)跟蹤程序的執(zhí)行順序颗味,接下來(lái)會(huì)到我們第3 步中分析DefaultBeanDefinitionDocumentReader對(duì)Bean 定義轉(zhuǎn)換的Document 對(duì)象解析的流程中超陆,在其parseDefaultElement 方法中完成對(duì)Document對(duì)象的解析后得到封裝BeanDefinition 的BeanDefinitionHold 對(duì)象,然后調(diào)用BeanDefinitionReaderUtils 的registerBeanDefinition 方法向IOC 容器注冊(cè)解析的Bean浦马,BeanDefinitionReaderUtils 的注冊(cè)的源碼如下:
//將解析的BeanDefinitionHold 注冊(cè)到容器中
public static void registerBeanDefinition(BeanDefinitionHolder definitionHolder,
BeanDefinitionRegistry registry) throws BeanDefinitionStoreException {
//獲取解析的BeanDefinition 的名稱
String beanName = definitionHolder.getBeanName();
//向IOC 容器注冊(cè)BeanDefinition
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
//如果解析的BeanDefinition 有別名时呀,向容器為其注冊(cè)別名
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
for (String aliase : aliases) {
registry.registerAlias(beanName, aliase);
}
}
}
當(dāng)調(diào)用BeanDefinitionReaderUtils 向IOC 容器注冊(cè)解析的BeanDefinition 時(shí),真正完成注冊(cè)功能的是DefaultListableBeanFactory晶默。
⑩⑦ DefaultListableBeanFactory 向IOC 容器注冊(cè)解析后的BeanDefinition:
DefaultListableBeanFactory 中使用一個(gè)HashMap 的集合對(duì)象存放IOC 容器中注冊(cè)解析的BeanDefinition谨娜,向IOC 容器注冊(cè)的主要源碼如下:、
//存儲(chǔ)注冊(cè)信息的BeanDefinition
private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<String,
BeanDefinition>();
//向IoC 容器注冊(cè)解析的BeanDefiniton
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
throws BeanDefinitionStoreException {
Assert.hasText(beanName, "Bean name must not be empty");
Assert.notNull(beanDefinition, "BeanDefinition must not be null");
//校驗(yàn)解析的BeanDefiniton
if (beanDefinition instanceof AbstractBeanDefinition) {
try {
((AbstractBeanDefinition) beanDefinition).validate();
}
catch (BeanDefinitionValidationException ex) {
throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(),
beanName,"Validation of bean definition failed", ex);
}
}
//注冊(cè)的過(guò)程中需要線程同步磺陡,以保證數(shù)據(jù)的一致性
synchronized (this.beanDefinitionMap) {
Object oldBeanDefinition = this.beanDefinitionMap.get(beanName);
//檢查是否有同名的BeanDefinition 已經(jīng)在IOC 容器中注冊(cè)趴梢,如果已經(jīng)注冊(cè)漠畜,
//并且不允許覆蓋已注冊(cè)的Bean,則拋出注冊(cè)失敗異常
if (oldBeanDefinition != null) {
if (!this.allowBeanDefinitionOverriding) {
throw new BeanDefinitionStoreException(
beanDefinition.getResourceDescription(), beanName,
"Cannot register bean definition [" + beanDefinition + "] for bean '" +
beanName +
"': There is already [" + oldBeanDefinition + "] bound.");
}else {//如果允許覆蓋坞靶,則同名的Bean憔狞,后注冊(cè)的覆蓋先注冊(cè)的
if (this.logger.isInfoEnabled()) {
this.logger.info("Overriding bean definition for bean '" + beanName +
"': replacing [" + oldBeanDefinition + "] with [" + beanDefinition + "]");
}
}
}
//IOC 容器中沒(méi)有已經(jīng)注冊(cè)同名的Bean,按正常注冊(cè)流程注冊(cè)
else {
this.beanDefinitionNames.add(beanName);
this.frozenBeanDefinitionNames = null;
}
this.beanDefinitionMap.put(beanName, beanDefinition);
//重置所有已經(jīng)注冊(cè)過(guò)的BeanDefinition 的緩存
resetBeanDefinition(beanName);
}
}
至此彰阴,Bean 定義資源文件中配置的Bean 被解析過(guò)后躯喇,已經(jīng)注冊(cè)到IOC 容器中,被容器管理起來(lái)硝枉,真正完成了IOC 容器初始化所做的全部工作×觯現(xiàn)在IOC 容器中已經(jīng)建立了整個(gè)Bean 的配置信息,這些BeanDefinition 信息已經(jīng)可以使用妻味,并且可以被檢索正压,IOC 容器的作用就是對(duì)這些注冊(cè)的Bean 定義信息進(jìn)行處理和維護(hù)。這些的注冊(cè)的Bean 定義信息是IoC 容器控制反轉(zhuǎn)的基礎(chǔ)责球,正是有了這些注冊(cè)的數(shù)據(jù)焦履,容器才可以進(jìn)行依賴注入。
⑩⑧ 總結(jié):
現(xiàn)在通過(guò)上面的代碼雏逾,總結(jié)一下IOC 容器初始化的基本步驟:
1.初始化的入口在容器實(shí)現(xiàn)中的refresh()調(diào)用來(lái)完成
2.對(duì)bean 定義載入IOC 容器使用的方法是loadBeanDefinition
其中的大致過(guò)程如下:通過(guò)ResourceLoader 來(lái)完成資源文件位置的定位嘉裤,DefaultResourceLoader 是默認(rèn)的實(shí)現(xiàn),同時(shí)上下文本身就給出了ResourceLoader 的實(shí)現(xiàn)栖博,可以從類(lèi)路徑屑宠,文件系統(tǒng),URL 等方式來(lái)定為資源位置。如果是XmlBeanFactory 作為IOC 容器仇让,那么需要為它指定bean定義的資源典奉,也就是說(shuō)bean 定義文件時(shí)通過(guò)抽象成Resource 來(lái)被IOC 容器處理的,容器通過(guò)BeanDefinitionReader 來(lái)完成定義信息的解析和Bean 信息的注冊(cè),往往使用的是XmlBeanDefinitionReader 來(lái)解析bean 的xml 定義文件-實(shí)際的處理過(guò)程是委托給BeanDefinitionParserDelegate 來(lái)完成的丧叽,從而得到bean 的定義信息卫玖,這些信息在Spring 中使用BeanDefinition 對(duì)象來(lái)表示-這個(gè)名字可以讓我們想到loadBeanDefinition,RegisterBeanDefinition 這些相關(guān)方法-他們都是為處理BeanDefinitin 服務(wù)的,容器解析得到BeanDefinitionIoC 以后踊淳,需要把它在IOC 容器中注冊(cè)假瞬,這由IOC 實(shí)現(xiàn)BeanDefinitionRegistry 接口來(lái)實(shí)現(xiàn)。注冊(cè)過(guò)程就是在IOC 容器內(nèi)部維護(hù)的一個(gè)HashMap 來(lái)保存得到的BeanDefinition 的過(guò)程迂尝。這個(gè)HashMap 是IOC 容器持有bean 信息的場(chǎng)所脱茉,以后對(duì)bean 的操作都是圍繞這個(gè)HashMap 來(lái)實(shí)現(xiàn)的.
3.然后我們就可以通過(guò)BeanFactory 和ApplicationContext 來(lái)享受到SpringIOC 的服務(wù)了
在使用IOC容器的時(shí)候,我們注意到除了少量粘合代碼雹舀,絕大多數(shù)以正確IOC 風(fēng)格編寫(xiě)的應(yīng)用程序代碼完全不用關(guān)心如何到達(dá)工廠芦劣,因?yàn)槿萜鲗堰@些對(duì)象與容器管理的其他對(duì)象鉤在一起∷涤埽基本的策略是把工廠放到已知的地方虚吟,最好是放在對(duì)預(yù)期使用的上下文有意義的地方寸认,以及代碼將實(shí)際需要訪問(wèn)工廠的地方。Spring本身提供了對(duì)聲明式載入web 應(yīng)用程序用法的應(yīng)用程序上下文,并將其存儲(chǔ)在ServletContext 中的框架實(shí)現(xiàn)串慰。
在使用SpringIOC 容器的時(shí)候我們還需要區(qū)別兩個(gè)概念:
BeanFactory
和FactoryBean
偏塞,其中BeanFactory 指的是IOC 容器的編程抽象,比如ApplicationContext邦鲫,XmlBeanFactory 等灸叼,這些都是IOC 容器的具體表現(xiàn),需要使用什么樣的容器由客戶決定,但Spring 為我們提供了豐富的選擇庆捺。FactoryBean 只是一個(gè)可以在IOC 而容器中被管理的一個(gè)bean,是對(duì)各種處理過(guò)程和資源使用的抽象,FactoryBean 在需要時(shí)產(chǎn)生另一個(gè)對(duì)象古今,而不返回FactoryBean 本身,我們可以把它看成是一個(gè)抽象工廠,對(duì)它的調(diào)用返回的是工廠生產(chǎn)的產(chǎn)品滔以。所有的FactoryBean 都實(shí)現(xiàn)特殊的org.springframework.beans.factory.FactoryBean
接口捉腥,當(dāng)使用容器中FactoryBean 的時(shí)候,該容器不會(huì)返回FactoryBean 本身,而是返回其生成的對(duì)象你画。Spring 包括了大部分的通用資源和服務(wù)訪問(wèn)抽象的FactoryBean的實(shí)現(xiàn)抵碟,其中包括:對(duì)JNDI 查詢的處理,對(duì)代理對(duì)象的處理坏匪,對(duì)事務(wù)性代理的處理拟逮,對(duì)RMI 代理的處理等,這些我們都可以看成是具體的工廠,看成是Spring 為我們建立好的工廠适滓。也就是說(shuō)Spring 通過(guò)使用抽象工廠模式為我們準(zhǔn)備了一系列工廠來(lái)生產(chǎn)一些特定的對(duì)象,免除我們手工重復(fù)的工作敦迄,我們要使用時(shí)只需要在IOC 容器里配置好就能很方便的使用了