???????Spring是通過IoC容器對Bean進行管理的，而Bean的初始化主要分為兩個過程：Bean的注冊和Bean實例化。Bean的注冊主要是指Spring通過讀取配置文件獲取各個bean的聲明信息，并且對這些信息進行注冊的過程。Bean的實例化則指的是Spring通過Bean的注冊信息對各個Bean進行實例化的過程。本文主要講解Spring是如何注冊Bean，并且為后續的Bean實例化做準備的。
???????Spring提供了BeanFactory對Bean進行獲取，但Bean的注冊和管理并不是在BeanFactory中進行的，而是在BeanDefinitionRegistry中進行的，這里BeanFactory只是提供了一個查閱的功能。如果把整個IoC容器比作一個圖書館的話，BeanFactory只是提供給學生查閱書籍的管理員，而BeanDefinitionRegistry則是注冊所有圖書信息的圖書管理軟件。Spring的Bean信息是注冊在一個個BeanDefinitioin中的，其就相當于一本本的圖書，在圖書管理軟件中是注冊備案了的。如下是IoC容器對Bean注冊進行管理的類結構圖：
IoC容器
1. bean聲明示例
???????首先我們看下如下利用配置文件聲明一個Bean，并且通過ClassPathXmlApplicationContext讀取該Bean的過程：
public class MockBusinessObject {}
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
<bean id="mockBO" class="MockBusinessObject"/>
</beans>
???????通過上述方式，我們就創建了一個MockBusinessObject的實例，通過如下代碼我們即可獲取該實例，并且使用該實例完成我們所需要的工作：
public class BeanApp {
public static void main(String[] args) {
ApplicationContext context = new ClassPathXmlApplicationContext("application.xml");
MockBusinessObject business = context.getBean(MockBusinessObject.class);
System.out.println(business);
}
}
???????這里我們選用的IoC容器是ClassPathXmlApplicationContext，Spring有兩種類型的Bean工廠：ApplicationContext和BeanFactory。這里ApplicationContext是繼承自BeanFactory的，因而其具有BeanFactory的全部功能。ApplicationContext和BeanFactory的主要區別有兩點：①ApplicationContext在注冊Bean之后還會立即初始化各個Bean的實例，BeanFactory只有在調用getBean()方法時才會開始實例化各個Bean；②ApplicationContext會自動檢測配置文件中聲明的BeanFactoryPostProcessor和BeanPostProcessor等實例，并且在實例化各個Bean的時候會自動調用這些配置文件中聲明的輔助bean實例，而BeanFactory必須手動調用其相應的方法才能將聲明的輔助Bean添加到IoC容器中。
2. 源碼解析
2.1 初始化BeanFactory信息
???????我們這里以ClassPathXmlApplicationContext為例，首先查看在構造該實例時Spring所做的工作：
public ClassPathXmlApplicationContext(
String[] configLocations, boolean refresh, @Nullable ApplicationContext parent)
throws BeansException {
super(parent);
setConfigLocations(configLocations); // 設置屬性文件路徑等
if (refresh) {
refresh(); // bean的注冊和初始化
}
}
???????通過跟蹤其源碼，我們最終看到上述代碼，setConfigLocations()方法主要是對設置配置文件的路徑，并且會對配置文件路徑中的占位符使用屬性文件中相關的屬性進行替換。這里的refresh()方法則主要是進行bean的注冊和初始化的，跟蹤其代碼如下：
@Override
public void refresh() throws BeansException, IllegalStateException {
synchronized (this.startupShutdownMonitor) {
// 準備Bean初始化相關的環境信息，其內部提供了一個空實現的initPropertySources()方法用于提供給用戶一個更改相關環境信息的機會
prepareRefresh();
// 創建BeanFactory實例，并且注冊xml文件中相關的bean信息
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
// 注冊Aware和Processor實例，并且注冊了后續處理請求所需的一些Editor信息
prepareBeanFactory(beanFactory);
try {
// 提供的一個空方法，用于供給子類對已經生成的BeanFactory的一些信息進行定制
postProcessBeanFactory(beanFactory);
// 調用BeanFactoryPostProcessor及其子接口的相關方法，這些接口提供了一個入口，提供給了調用方一個修改已經生成的BeanDefinition的入口
invokeBeanFactoryPostProcessors(beanFactory);
// 對BeanPostProcessor進行注冊
registerBeanPostProcessors(beanFactory);
// 初始化國際化所需的bean信息
initMessageSource();
// 初始化事件廣播器的bean信息
initApplicationEventMulticaster();
// 提供的一個空方法，供給子類用于提供自定義的bean信息，或者修改已有的bean信息
onRefresh();
// 注冊事件監聽器
registerListeners();
// 對已經注冊的非延遲（配置文件指定）bean的實例化
finishBeanFactoryInitialization(beanFactory);
// 清除緩存的資源信息，初始化一些聲明周期相關的bean，并且發布Context已被初始化的事件
finishRefresh();
}
catch (BeansException ex) {
if (logger.isWarnEnabled()) {
logger.warn("Exception encountered during context initialization - " +
"cancelling refresh attempt: " + ex);
}
// 發生異常則銷毀已經生成的bean
destroyBeans();
// 重置refresh字段信息
cancelRefresh(ex);
throw ex;
}
finally {
// 初始化一些緩存信息
resetCommonCaches();
}
}
}
???????可以看到，refresh()方法主要做了如下幾個工作：
- BeanFactory的初始化，并且加載配置文件中相關bean的信息；
- BeanFactoryPostProcessor和BeanPostProcessor和調用；
- 初始化國際化信息；
- 注冊和調用相關的監聽器；
- 實例化注冊的Bean信息；
???????對于bean所需實例化信息的注冊，我們主要關注obtainFreshBeanFactory()方法，逐步跟蹤其代碼如下：
protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {
refreshBeanFactory(); // 初始化BeanFactory并加載xml文件信息
// 獲取已生成的BeanFactory
ConfigurableListableBeanFactory beanFactory = getBeanFactory();
if (logger.isDebugEnabled()) {
logger.debug("Bean factory for " + getDisplayName() + ": " + beanFactory);
}
return beanFactory;
}
???????這里我們跟蹤refreshBeanFactory()方法如下：
@Override
protected final void refreshBeanFactory() throws BeansException {
if (hasBeanFactory()) { // 如果BeanFactory已經創建則對其進行銷毀
destroyBeans();
closeBeanFactory();
}
try {
// 創建BeanFactory實例
DefaultListableBeanFactory beanFactory = createBeanFactory();
beanFactory.setSerializationId(getId()); // 為當前BeanFactory設置一個標識id
customizeBeanFactory(beanFactory); // 設置BeanFacotry的定制化屬性信息
loadBeanDefinitions(beanFactory); // 加載xml文件信息
synchronized (this.beanFactoryMonitor) {
this.beanFactory = beanFactory;
}
}
catch (IOException ex) {
throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);
}
}
???????可以看到，這里的xml加載主要是在loadBeanDefinitions()方法中，跟蹤該方法如下：
@Override
protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException {
// 創建一個XmlBeanDefinitionReader用于讀取xml文件中的屬性
XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);
// 設置一些環境變量相關的信息
beanDefinitionReader.setEnvironment(this.getEnvironment());
beanDefinitionReader.setResourceLoader(this);
beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));
// 提供的一個可供子類繼承的方法，用于定制XmlBeanDefinitionReader相關的信息
initBeanDefinitionReader(beanDefinitionReader);
// 加載xml文件中的信息
loadBeanDefinitions(beanDefinitionReader);
}
????????可以看到，這里xml文件中的bean信息，Spring主要是委托給了XmlBeanDefinitionReader來進行。如下是繼續跟蹤loadBeanDefinitions()方法的代碼：
protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException, IOException {
Resource[] configResources = getConfigResources();
if (configResources != null) {
reader.loadBeanDefinitions(configResources);
}
String[] configLocations = getConfigLocations();
if (configLocations != null) {
reader.loadBeanDefinitions(configLocations);
}
}
@Override
public int loadBeanDefinitions(Resource... resources) throws BeanDefinitionStoreException {
Assert.notNull(resources, "Resource array must not be null");
int counter = 0;
for (Resource resource : resources) {
counter += loadBeanDefinitions(resource);
}
return counter;
}
???????這里XmlBeanDefinitionReader會依次讀取所指定的每個配置文件的bean信息，繼續跟蹤loadBeanDefinitions()如下：
public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
Assert.notNull(encodedResource, "EncodedResource must not be null");
if (logger.isInfoEnabled()) {
logger.info("Loading XML bean definitions from " + encodedResource.getResource());
}
Set<EncodedResource> currentResources = this.resourcesCurrentlyBeingLoaded.get();
if (currentResources == null) {
currentResources = new HashSet<>(4);
this.resourcesCurrentlyBeingLoaded.set(currentResources);
}
if (!currentResources.add(encodedResource)) {
throw new BeanDefinitionStoreException(
"Detected cyclic loading of " + encodedResource + " - check your import definitions!");
}
try {
InputStream inputStream = encodedResource.getResource().getInputStream();
try {
InputSource inputSource = new InputSource(inputStream);
if (encodedResource.getEncoding() != null) {
inputSource.setEncoding(encodedResource.getEncoding());
}
return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
}
finally {
inputStream.close();
}
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(
"IOException parsing XML document from " + encodedResource.getResource(), ex);
}
finally {
currentResources.remove(encodedResource);
if (currentResources.isEmpty()) {
this.resourcesCurrentlyBeingLoaded.remove();
}
}
}
???????上述代碼中，主要是將xml文件轉換為了一個InputStream，最終通過調用doLoadBeanDefinitions()方法進行bean信息的注冊。如下是doLoadBeanDefinitions()方法的實現：
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
try {
Document doc = doLoadDocument(inputSource, resource);
return registerBeanDefinitions(doc, resource);
}
catch (BeanDefinitionStoreException ex) {
throw ex;
}
catch (SAXParseException ex) {
throw new XmlBeanDefinitionStoreException(resource.getDescription(), "Line " + ex.getLineNumber() + " in XML document from " + resource + " is invalid", ex);
}
catch (SAXException ex) {
throw new XmlBeanDefinitionStoreException(resource.getDescription(), "XML document from " + resource + " is invalid", ex);
}
catch (ParserConfigurationException ex) {
throw new BeanDefinitionStoreException(resource.getDescription(), "Parser configuration exception parsing XML from " + resource, ex);
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(resource.getDescription(), "IOException parsing XML document from " + resource, ex);
}
catch (Throwable ex) {
throw new BeanDefinitionStoreException(resource.getDescription(), "Unexpected exception parsing XML document from " + resource, ex);
}
}
????????上述代碼中，首先將資源文件轉換為一個Document對象，該對象中保存有各個xml文件中各個節點和子節點的相關信息。通過轉換得到的Document對象，通過registerBeanDefinitions()方法完成Bean的注冊，如下是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;
}
????????如下是BeanDefinitionDocumentReader.registerBeanDefinitions()方法的實現：
@Override
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
this.readerContext = readerContext;
logger.debug("Loading bean definitions");
Element root = doc.getDocumentElement();
doRegisterBeanDefinitions(root);
}
2.2 解析xml文件
???????這里首先通過Document對象獲取到xml文件的根節點信息，然后通過doRegisterBeanDefinitions()方法轉換節點的bean信息：
protected void doRegisterBeanDefinitions(Element root) {
BeanDefinitionParserDelegate parent = this.delegate;
this.delegate = createDelegate(getReaderContext(), root, parent);
if (this.delegate.isDefaultNamespace(root)) {
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)) {
if (logger.isInfoEnabled()) {
logger.info("Skipped XML bean definition file due to specified profiles [" + profileSpec + "] not matching: " + getReaderContext().getResource());
}
return;
}
}
}
preProcessXml(root);
parseBeanDefinitions(root, this.delegate);
postProcessXml(root);
this.delegate = parent;
}
???????在doRegisterBeanDefinitions()方法中，其首先獲取當前xml文件是否為默認的命名空間，也即是否使用的是Spring的xsd文件聲明的bean，如果是的，則獲取當前是否有指定profile相關的信息，并且在環境變量中獲取當前是哪種profile，與命名空間中指定的profile進行比較，如果profile不匹配，則過濾掉當前的xml文件。
????????下面的preProcessorXml()和postProcessorXml()方法是兩個空方法，用于供給子類實現從而對獲取到的Document對象進行定制。真正的bean節點的讀取在parseBeanDefinitions()方法中：
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
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);
}
else {
delegate.parseCustomElement(ele);
}
}
}
}
else {
delegate.parseCustomElement(root);
}
}
???????這里在讀取bean節點的時候分為了兩種情形進行讀?。孩倌J的命名空間，也即Spring所提供的xsd命名空間的bean讀?。虎谧远x的命名空間定義的bean讀取。關于自定義命名空間bean的讀取我們在后續文章中會進行講解，本文主要講解使用Spring默認命名空間所定義的bean的讀取。如下是parseDefaultElement()方法的實現：
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
importBeanDefinitionResource(ele);
} else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
processAliasRegistration(ele);
} else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
processBeanDefinition(ele, delegate);
} else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
doRegisterBeanDefinitions(ele);
}
}
???????可以看到，在對xml節點的讀取的時候，其分為了四種情形：①讀取import節點所指定的xml文件信息；②讀取alias節點的信息；③讀取bean節點指定的信息；④讀取嵌套bean的信息。由于這里對bean節點的解析是較為復雜，并且最為重要的，本文主要對其余三種節點的解析進行講解，對bean節點的解析將放入下一篇文章進行講解。
2.2.1 讀取import節點指定的bean信息
protected void importBeanDefinitionResource(Element ele) {
String location = ele.getAttribute(RESOURCE_ATTRIBUTE);
if (!StringUtils.hasText(location)) {
getReaderContext().error("Resource location must not be empty", ele);
return;
}
// 處理import節點指定的路徑中的屬性占位符，將其替換為屬性文件中指定屬性值
location = getReaderContext().getEnvironment().resolveRequiredPlaceholders(location);
Set<Resource> actualResources = new LinkedHashSet<>(4);
// 處理路徑信息，判斷其為相對路徑還是絕對路徑
boolean absoluteLocation = false;
try {
absoluteLocation = ResourcePatternUtils.isUrl(location) || ResourceUtils.toURI(location).isAbsolute();
} catch (URISyntaxException ex) {}
if (absoluteLocation) { // 如果是絕對路徑，則直接讀取該文件
try {
// 遞歸調用loadBeanDefinitions()方法加載import所指定的文件中的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 {
try {
int importCount;
Resource relativeResource = getReaderContext().getResource()
.createRelative(location); // 判斷是否為相對路徑
// 如果是相對路徑，則調用loadBeanDefinitions()方法加載該文件中的bean信息
if (relativeResource.exists()) {
importCount = getReaderContext().getReader()
.loadBeanDefinitions(relativeResource);
actualResources.add(relativeResource);
}
else {
// 如果相對路徑，也不是絕對路徑，則將該路徑當做一個外部url進行請求讀取
String baseLocation = getReaderContext().getResource()
.getURL().toString();
// 繼續調用loadBeanDefinitions()方法讀取下載得到的xml文件信息
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文件讀取完成事件的監聽器
getReaderContext().fireImportProcessed(location, actResArray, extractSource(ele));
}
???????可以看到，對import節點的解析，主要思路還是判斷import節點中指定的路徑是相對路徑還是絕對路徑，如果都不是，則將其作為一個外部URL進行讀取，最終將讀取得到的文件還是使用loadBeanDefinitions()進行遞歸調用讀取該文件中的bean信息。
2.2.2 讀取alias節點指定的信息
protected void processAliasRegistration(Element ele) {
String name = ele.getAttribute(NAME_ATTRIBUTE); // 獲取name屬性的值
String alias = ele.getAttribute(ALIAS_ATTRIBUTE); // 獲取alias屬性的值
boolean valid = true;
if (!StringUtils.hasText(name)) {
getReaderContext().error("Name must not be empty", ele);
valid = false;
}
if (!StringUtils.hasText(alias)) {
getReaderContext().error("Alias must not be empty", ele);
valid = false;
}
if (valid) {
try {
// 注冊別名信息
getReaderContext().getRegistry().registerAlias(name, alias);
}
catch (Exception ex) {
getReaderContext().error("Failed to register alias '" + alias +
"' for bean with name '" + name + "'", ele, ex);
}
// 激活對alias注冊完成進行監聽的監聽器
getReaderContext().fireAliasRegistered(name, alias, extractSource(ele));
}
}
如下是registerAlias()方法的最終實現：
@Override
public void registerAlias(String name, String alias) {
Assert.hasText(name, "'name' must not be empty");
Assert.hasText(alias, "'alias' must not be empty");
if (alias.equals(name)) {
this.aliasMap.remove(alias);
}
else {
String registeredName = this.aliasMap.get(alias);
if (registeredName != null) {
if (registeredName.equals(name)) {
// 如果已注冊，則直接返回
return;
}
if (!allowAliasOverriding()) {
throw new IllegalStateException("Cannot register alias '" + alias + "' for name '" + name + "': It is already registered for name '" + registeredName + "'.");
}
}
// 檢查是否有循環別名注冊
checkForAliasCircle(name, alias);
// 將別名作為key，目標bean名稱作為值注冊到存儲別名的Map中
this.aliasMap.put(alias, name);
}
}
???????可以看到，別名的注冊，其實就是將別名作為一個key，將目標bean的名稱作為值，存儲到一個Map中。這里需要注意的是，目標bean的名稱也可能是一個別名。
2.2.3 讀取嵌套beans信息
???????對于嵌套beans的解析，可以看到，其調用的是doRegisterBeanDefinitions()方法，該方法正是前面我們講解的開始對bean解析的方法，因而這里其實是使用遞歸對嵌套bean進行解析的。這里需要說明的是，一個xml文件，其根節點其實就是一個beans節點，而嵌套beans節點的節點名也是beans，因而嵌套beans其實也可以理解為一份單獨引入的xml文件，因而可以使用遞歸的方式對其進行讀取。
