Spring原始碼解析-applicationContext.xml載入和bean的註冊
Spring原始碼解析-applicationContext.xml載入和bean的註冊
萬事開頭難，就要從頭開始
Spring對於從事Java開發的boy來說，再熟悉不過了，對於我們這個牛逼的框架的介紹就不在這裡複述了，Spring這個大雜燴，怎麼去使用怎麼去配置，各種百度谷歌都能查到很多大牛教程，但是，當我們按著教程一步步的把spring的開發框架搭建起來的時候，有沒有一種想搞明白spring的衝動，當然了，spring原始碼是個難啃的骨頭，食之有味，棄之可惜。而筆者今天只是對spring的冰山一角進行解析。萬事開頭難，就要從開頭開始，而筆者認為spring開頭就是如何載入配置檔案，並初始化配置檔案裡面的bean當然了包括了我們用**@Service、@Component**等註解註解的bean，spring在容器啟動的時候就要去載入這些內容，然後統一管理這些bean，這也就是spring的一個重要概念bean的容器。
applicationContext.xml到底是如何載入的呢？我把他簡化成以下流程，當然了每個環節裡Spring的實現都是錯綜複雜的，也是很佩服寫Spring的大神，什麼時候才能達到他們的十分之一的功力，欽佩的同時只能默默的跟他們學習。
Spring初始化
當我們初學Spring的教程的時候，教程裡面肯定會有這樣的一步騷操作，就是新建一個applicationContext.xml檔案，當然了這是Spring裡必須要有的一個檔案，在這個檔案裡面我們可以進行bean的配置等等工作，讓Spring來管理我們的Bean。然後，這個檔案放在哪裡也是個比較講究的事情，可能對於初學者來說可額能會往WEB-INF資料夾一放就了事了，確實這樣是可以的，因為Spring預設的位置就是這個，但是我們一般不這麼做，一般會把這個檔案放在resource裡面，那這樣子做的話，你就要指定位置，讓Spring知道你這個檔案的位置，這就有了下面一段程式碼，我們的Spring專案都會在web.xml配置這樣的程式碼：
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:applicationContext.xml</param-value>
</context-param>
那問題來了，當Tomcat啟動的時候，spring是怎麼去初始化應用的上下文的呢？答案就在類ContextLoader.java裡面。當Tomcat啟動時候會呼叫該類裡面的一個方法public WebApplicationContext initWebApplicationContext(ServletContext servletContext)
public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
......
this.context = createWebApplicationContext(servletContext);//主要程式碼，建立web應用上下文
......
configureAndRefreshWebApplicationContext(cwac, servletContext);//配置引數並呼叫初始化方法
......
}
在這個方法裡面有兩句重要程式碼，第一句createWebApplicationContext(servletContext)，這個會根據你配置的contextClass建立一個WebApplicationContext物件，但是我們一般不會配置這個引數，所以Spring預設會建立一個XMLWebApplicationContext物件，而這個就是後續操作的的重要物件，然後接下來一句重要程式碼configureAndRefreshWebApplicationContext(cwac, servletContext)這個就會去讀取我們在web.xml裡面配置的引數並set到變數裡頭去，這樣Spring就能找到我們專案的applicationContext.xml檔案了，到底如何找到下面會講。接下來我們來看下configureAndRefreshWebApplicationContext方法的實現如下：
protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) {
if (ObjectUtils.identityToString(wac).equals(wac.getId())) {
// The application context id is still set to its original default value
// -> assign a more useful id based on available information
String idParam = sc.getInitParameter(CONTEXT_ID_PARAM);
if (idParam != null) {
wac.setId(idParam);
}
else {
// Generate default id...
wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +
ObjectUtils.getDisplayString(sc.getContextPath()));
}
}
wac.setServletContext(sc);
String configLocationParam = sc.getInitParameter(CONFIG_LOCATION_PARAM);
if (configLocationParam != null) {
wac.setConfigLocation(configLocationParam);
}
// The wac environment's #initPropertySources will be called in any case when the context
// is refreshed; do it eagerly here to ensure servlet property sources are in place for
// use in any post-processing or initialization that occurs below prior to #refresh
ConfigurableEnvironment env = wac.getEnvironment();
if (env instanceof ConfigurableWebEnvironment) {
((ConfigurableWebEnvironment) env).initPropertySources(sc, null);
}
customizeContext(sc, wac);
wac.refresh();
}
在這個方法中我們只要關注兩個地方，第一個：
String configLocationParam = sc.getInitParameter(CONFIG_LOCATION_PARAM);
if (configLocationParam != null) {
wac.setConfigLocation(configLocationParam);
}
這塊程式碼塊就是，講我們配置在web.xml裡面的引數set到我們的變數中去。第二個地方就是：
wac.refresh();
呼叫這個執行後續的載入檔案操作等後續操作。
Spring是如何找到applicationContext.xml檔案
其實，從refresh到Spring裡去查詢配置檔案路徑之間，有很多步驟，這些也都要花點時間去理解的，在這裡不展開講，我們只要知道，XmlWebApplicationContext會委託給XmlBeanDefinitionReader類去解析配置檔案，在XmlWebApplicationContext類裡面有個方法loadBeanDefinitions如下：
protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws IOException {
String[] configLocations = getConfigLocations();
if (configLocations != null) {
for (String configLocation : configLocations) {
reader.loadBeanDefinitions(configLocation);
}
}
}
該方法就是將一個個的配置檔案委託給XmlBeanDefinitionReader去解析配置檔案，但是解析之前有句程式碼String[] configLocations = getConfigLocations();這個就是查詢我們的配置的檔案的方法，
protected String[] getConfigLocations() {
return (this.configLocations != null ? this.configLocations : getDefaultConfigLocations());
}
實現很簡單，就是我們有配置該位置地址就會去讀我們配置的路徑，否則就會去讀預設的配置檔案路徑，這就是開篇說道的要是沒配置路徑也能讀取到配置檔案，前提就是要跟Spring預設定義好的檔案路徑及檔名保持一致才行。getDefaultConfigLocations函式的實現也很簡單：
/** Default config location for the root context */
public static final String DEFAULT_CONFIG_LOCATION = "/WEB-INF/applicationContext.xml";
/** Default prefix for building a config location for a namespace */
public static final String DEFAULT_CONFIG_LOCATION_PREFIX = "/WEB-INF/";
/** Default suffix for building a config location for a namespace */
public static final String DEFAULT_CONFIG_LOCATION_SUFFIX = ".xml";
protected String[] getDefaultConfigLocations() {
if (getNamespace() != null) {
return new String[] {DEFAULT_CONFIG_LOCATION_PREFIX + getNamespace() + DEFAULT_CONFIG_LOCATION_SUFFIX};
}
else {
return new String[] {DEFAULT_CONFIG_LOCATION};
}
}
如果配置了namespace就會去找這個名字的xml配置檔案，如果沒有配置就去找預設的配置檔案。所以不管如何，這個配置檔案是必須在spring專案中的。至此，配置檔案基本將完，接下來就是重頭戲了，就是解析xml以及xml裡面的節點，並註冊到spring的bean容器中去。
將xml檔案轉成Document處理物件
如何將xml轉成Document物件，麻蛋，這個也是很複雜的操作，首先將resource讀取InputStream流，在將InputStream流包裝成InputSource物件，在處理成Document物件，直接上程式碼：
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<EncodedResource>(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();
}
}
}
接下來又到doLoadBeanDefinitions(inputSource, encodedResource.getResource());方法去了，該方法就是生成Doucument物件的，然後就是解析具體的節點了，部分原始碼如下：
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
Document doc = doLoadDocument(inputSource, resource);//這就是解析成Document物件的操作
return registerBeanDefinitions(doc, resource);
......
}
解析Document不展開講了，不是本篇的重點，重點是下面的，spring如何解析xml檔案的bean及註解的bean然後註冊到容器中去，registerBeanDefinitions(doc, resource)是下面的重點。
解析Document裡面的節點
XmlBeanDfinitionReader本身又不是直接取解析document的，他是委託給了DefaultBeanDefinitionDocumentReader類去實現，原始碼中，會去建立DefaultBeanDefinitionDocumentReader物件例項，然後呼叫例項的註冊方法，程式碼如下：
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;
}
在講解之前，我們必須知道，spring的xml檔案裡面有兩種型別的節點，一種是預設節點，相對於主節點之外的節點統稱自定義節點，這可以從原始碼裡面知道，而預設節點有以下幾個：beans、import、alias、bean這幾個節點是預設節點，而相對於這幾個節點之外的都是預設節點，applicationContext裡面有幾個自定義節點，如下：property-placeholder、property-override、annotation-config、component-scan、load-time-weaver、spring-configured、mbean-export、mbean-server，這裡面常見的有component-scan等，為什麼spring要分成預設和自定義節點呢，是因為自定義節點都有特定的業務，比如component-scan，他是去掃描程式包，載入用註解定義的bean，例如開發中的service等bean，所以這些自定義節點都配備瞭解析器，這些解析器預先初始化好的，解析到什麼節點就去獲取相應的解析器去處理相應的業務，自定義節點解析器配置如下：
@Override
public void init() {
registerBeanDefinitionParser("property-placeholder", new PropertyPlaceholderBeanDefinitionParser());
registerBeanDefinitionParser("property-override", new PropertyOverrideBeanDefinitionParser());
registerBeanDefinitionParser("annotation-config", new AnnotationConfigBeanDefinitionParser());
registerBeanDefinitionParser("component-scan", new ComponentScanBeanDefinitionParser());
registerBeanDefinitionParser("load-time-weaver", new LoadTimeWeaverBeanDefinitionParser());
registerBeanDefinitionParser("spring-configured", new SpringConfiguredBeanDefinitionParser());
registerBeanDefinitionParser("mbean-export", new MBeanExportBeanDefinitionParser());
registerBeanDefinitionParser("mbean-server", new MBeanServerBeanDefinitionParser());
}
從以上原始碼分析，我們可以得到一個推論：
我們自己可以自定義xml的節點，spring可以去解析我們自定義的xml節點。
哈哈，其實這個推論明顯成立，我們可以看到spring裡面到處都是這種自定義的節點的。
這裡又引申出一個問題：spring怎麼去區分預設節點和自定義節點的呢？答案是通過節點的namespaceUri屬性去判斷，namespaceUri是什麼東東？我們來看下，預設節點的namespaceUri是怎麼樣的，原始碼是這樣定義的：
public static final String BEANS_NAMESPACE_URI = "http://www.springframework.org/schema/beans";
是不是很熟悉，這貨就是我們配置檔案裡面的beans根節點會寫的東西，如下：
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">
</beans>
但是問題又來了，子節點上我們根本沒配置這貨，但是也能讀取到，以下是個人推論：
子節點會繼承父節點的屬性，這就說的通，子節點即使沒配置那一堆東西也能判斷為預設節點。
接下來，就是解析Document的元素，從root元素開始解析，這時候spring是建立了一個解析類的代理類，所有的比較和解析操作都有該類完成，我們來看下spring的原始碼實現：
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;
}
解析節點的過程是個遞迴的過程，每次都要記錄節點的父節點，首先會建立一個delegate物件，然後再去解析節點，呼叫parseBeanDefinitions(root, this.delegate);這個方法；
繼續來看下parseBeanDefinitions(root, this.delegate);的實現：
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);
}
}
可以很清晰的看出，解析是分預設節點和自定義節點分開解析的，而自定義的節點的解析其實就是找到對應的解析器各自處理對應的業務，如component-scan會找到ComponentScanBeanDefinitionParser類來處理對應的掃描包註冊bean的操作，而預設的節點的處理有如下幾種，程式碼如下：
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
//處理import
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
importBeanDefinitionResource(ele);
}
//處理alias
else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
processAliasRegistration(ele);
}
//處理bean
else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
processBeanDefinition(ele, delegate);
}
//處理beans
else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
// recurse
doRegisterBeanDefinitions(ele);
}
}
import的處理相對其他幾種比較複雜點，但最終還是處理變成其他3種的處理，而beans的處理就重新遞迴上面提到的方法，最重要的是bean的處理，bean的處理其實就是下面要講的內容，解析bean並註冊bean的過程。
註冊bean
終於到了最後一個內容了，也是最重要的一個內容，上面講的所有都是為了這個而服務的，讀取配置檔案也是為了載入bean，然後註冊到spring的容器裡面，讓spring統一管理我們定義的bean。大家都很明白，spring的bean的容器，但是如果沒有去看原始碼的話，是不是都認為spring，是把每個例項物件註冊到容器裡面然後統一管理的？我就是這麼想的，也見識了我多麼的無知。其實，spring其實不是這樣的做的，spring註冊的bean最終是個bean的定義，即BeanDefinition這個例項，並不是一個個的具體例項。所謂的註冊，其實就是把各種這些例項用一個Map來管理，所以，spring的bean的容器的底層儲存其實是用Map來實現的（這個之前面試被問過）。接下來，看看原始碼的實現：
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
if (bdHolder != null) {
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
try {
// Register the final decorated instance.
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
}
catch (BeanDefinitionStoreException ex) {
getReaderContext().error("Failed to register bean definition with name '" +
bdHolder.getBeanName() + "'", ele, ex);
}
// Send registration event.
getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
}
}
從原始碼裡可以看出，bean的解析類代理會去解析ele元素，並返回一個BeanDefinitionHolder的例項，而這個BeanDefinitionHolder我們可以簡單理解為BeanDefinition物件的持有物件。然後，通過呼叫BeanDefinitionReaderUtils工具類去執行具體的註冊操作。繼續看BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry())這個的實現如下：
public static void registerBeanDefinition(
BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
throws BeanDefinitionStoreException {
// Register bean definition under primary name.
String beanName = definitionHolder.getBeanName();
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
// Register aliases for bean name, if any.
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
for (String alias : aliases) {
registry.registerAlias(beanName, alias);
}
}
}
從上面程式碼中，spring註冊bean其實註冊的是BeanDfinition，註冊bean其實就是繫結bean的name和BeanDfinition的關係。這也就說明了另外一件事，我們的service或者component的名字是不能一樣的，及時在不同的包裡面，不然會報衝突的。因為，Map的key不能重複，這是鐵律。那麼，我們繼續看看bean的具體註冊過程，程式碼如下：
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
throws BeanDefinitionStoreException {
Assert.hasText(beanName