Spring IOC設計原理解析:本文乃學習整理參考而來
一、 什麼是Ioc/DI?
二、 Spring IOC體系結構
(1) BeanFactory
(2) BeanDefinition
三、 IoC容器的初始化
1、 XmlBeanFactory(屌絲IOC)的整個流程
2、 FileSystemXmlApplicationContext 的IOC容器流程
1、高富帥IOC解剖
2、 設置資源加載器和資源定位
3、AbstractApplicationContext的refresh函數載入Bean定義過程:
4、AbstractApplicationContext子類的refreshBeanFactory()方法:
5、AbstractRefreshableApplicationContext子類的loadBeanDefinitions方法:
6、AbstractBeanDefinitionReader讀取Bean定義資源:
7、資源加載器獲取要讀入的資源:
8、XmlBeanDefinitionReader加載Bean定義資源:
9、DocumentLoader將Bean定義資源轉換為Document對象:
10、XmlBeanDefinitionReader解析載入的Bean定義資源文件:
11、DefaultBeanDefinitionDocumentReader對Bean定義的Document對象解析:
12、BeanDefinitionParserDelegate解析Bean定義資源文件中的<Bean>元素:
13、BeanDefinitionParserDelegate解析<property>元素:
14、解析<property>元素的子元素:
15、解析<list>子元素:
16、解析過後的BeanDefinition在IoC容器中的注冊:
17、DefaultListableBeanFactory向IoC容器注冊解析後的BeanDefinition:
總結:
四、IOC容器的依賴注入
1、依賴注入發生的時間
2、AbstractBeanFactory通過getBean向IoC容器獲取被管理的Bean:
3、AbstractAutowireCapableBeanFactory創建Bean實例對象:
4、createBeanInstance方法創建Bean的java實例對象:
5、SimpleInstantiationStrategy類使用默認的無參構造方法創建Bean實例化對象:
6、populateBean方法對Bean屬性的依賴注入:
7、BeanDefinitionValueResolver解析屬性值:
8、BeanWrapperImpl對Bean屬性的依賴注入:
五、IoC容器的高級特性
1、介紹
2、Spring IoC容器的lazy-init屬性實現預實例化:
(1) .refresh()
(2).finishBeanFactoryInitialization處理預實例化Bean:
(3) .DefaultListableBeanFactory對配置lazy-init屬性單態Bean的預實例化:
3、FactoryBean的實現:
(1).FactoryBean的源碼如下:
(2). AbstractBeanFactory的getBean方法調用FactoryBean:
(3)、AbstractBeanFactory生產Bean實例對象:
(4).工廠Bean的實現類getObject方法創建Bean實例對象:
4.BeanPostProcessor後置處理器的實現:
(1).BeanPostProcessor的源碼如下:
(2).AbstractAutowireCapableBeanFactory類對容器生成的Bean添加後置處理器:
(3).initializeBean方法為容器產生的Bean實例對象添加BeanPostProcessor後置處理器:
(4).AdvisorAdapterRegistrationManager在Bean對象初始化後注冊通知適配器:
5.Spring IoC容器autowiring實現原理:
(1). AbstractAutoWireCapableBeanFactory對Bean實例進行屬性依賴注入:
(2).Spring IoC容器根據Bean名稱或者類型進行autowiring自動依賴注入:
(3).DefaultSingletonBeanRegistry的registerDependentBean方法對屬性注入:
IoC 容器:最主要是完成了完成對象的創建和依賴的管理注入等等。
先從我們自己設計這樣一個視角來考慮:
所謂控制反轉,就是把原先我們代碼裡面需要實現的對象創建、依賴的代碼,反轉給容器來幫忙實現。那麼必然的我們需要創建一個容器,同時需要一種描述來讓容器知道需要創建的對象與對象的關系。這個描述最具體表現就是我們可配置的文件。
對象和對象關系怎麼表示?
可以用 xml , properties 文件等語義化配置文件表示。
描述對象關系的文件存放在哪裡?
可能是 classpath , filesystem ,或者是 URL 網絡資源, servletContext 等。
回到正題,有了配置文件,還需要對配置文件解析。
不同的配置文件對對象的描述不一樣,如標准的,自定義聲明式的,如何統一? 在內部需要有一個統一的關於對象的定義,所有外部的描述都必須轉化成統一的描述定義。
如何對不同的配置文件進行解析?需要對不同的配置文件語法,采用不同的解析器
(1) BeanFactory
Spring Bean的創建是典型的工廠模式,這一系列的Bean工廠,也即IOC容器為開發者管理對象間的依賴關系提供了很多便利和基礎服務,在Spring中有許多的IOC容器的實現供用戶選擇和使用,其相互關系如下:
其中BeanFactory作為最頂層的一個接口類,它定義了IOC容器的基本功能規范,BeanFactory 有三個子類:ListableBeanFactory、HierarchicalBeanFactory 和AutowireCapableBeanFactory。但是從上圖中我們可以發現最終的默認實現類是 DefaultListableBeanFactory,他實現了所有的接口。那為何要定義這麼多層次的接口呢?查閱這些接口的源碼和說明發現,每個接口都有他使用的場合,它主要是為了區分在 Spring 內部在操作過程中對象的傳遞和轉化過程中,對對象的數據訪問所做的限制。例如 ListableBeanFactory 接口表示這些 Bean 是可列表的,而 HierarchicalBeanFactory 表示的是這些 Bean 是有繼承關系的,也就是每個Bean 有可能有父 Bean。AutowireCapableBeanFactory 接口定義 Bean 的自動裝配規則。這四個接口共同定義了 Bean 的集合、Bean 之間的關系、以及 Bean 行為.
最基本的IOC容器接口BeanFactory
1 public interface BeanFactory { 2 3 //對FactoryBean的轉義定義,因為如果使用bean的名字檢索FactoryBean得到的對象是工廠生成的對象, 4 //如果需要得到工廠本身,需要轉義 5 String FACTORY_BEAN_PREFIX = "&"; 6 7 //根據bean的名字,獲取在IOC容器中得到bean實例 8 Object getBean(String name) throws BeansException; 9 10 //根據bean的名字和Class類型來得到bean實例,增加了類型安全驗證機制。 11 Object getBean(String name, Class requiredType) throws BeansException; 12 13 //提供對bean的檢索,看看是否在IOC容器有這個名字的bean 14 boolean containsBean(String name); 15 16 //根據bean名字得到bean實例,並同時判斷這個bean是不是單例 17 boolean isSingleton(String name) throws NoSuchBeanDefinitionException; 18 19 //得到bean實例的Class類型 20 Class getType(String name) throws NoSuchBeanDefinitionException; 21 22 //得到bean的別名,如果根據別名檢索,那麼其原名也會被檢索出來 23 String[] getAliases(String name); 24 }
在BeanFactory裡只對IOC容器的基本行為作了定義,根本不關心你的bean是如何定義怎樣加載的。正如我們只關心工廠裡得到什麼的產品對象,至於工廠是怎麼生產這些對象的,這個基本的接口不關心。
而要知道工廠是如何產生對象的,我們需要看具體的IOC容器實現,spring提供了許多IOC容器的實現。比如XmlBeanFactory,ClasspathXmlApplicationContext等。其中XmlBeanFactory就是針對最基本的ioc容器的實現,這個IOC容器可以讀取XML文件定義的BeanDefinition(XML文件中對bean的描述),如果說XmlBeanFactory是容器中的屌絲,ApplicationContext應該算容器中的高帥富.
ApplicationContext是Spring提供的一個高級的IoC容器,它除了能夠提供IoC容器的基本功能外,還為用戶提供了以下的附加服務。
從ApplicationContext接口的實現,我們看出其特點:
1. 支持信息源,可以實現國際化。(實現MessageSource接口)
2. 訪問資源。(實現ResourcePatternResolver接口,這個後面要講)
3. 支持應用事件。(實現ApplicationEventPublisher接口)
(2) BeanDefinition
SpringIOC容器管理了我們定義的各種Bean對象及其相互的關系,Bean對象在Spring實現中是以BeanDefinition來描述的,其繼承體系如下:
Bean 的解析過程非常復雜,功能被分的很細,因為這裡需要被擴展的地方很多,必須保證有足夠的靈活性,以應對可能的變化。Bean 的解析主要就是對 Spring 配置文件的解析。這個解析過程主要通過下圖中的類完成:
IoC容器的初始化包括BeanDefinition的Resource定位、載入和注冊這三個基本的過程。我們以ApplicationContext為例講解,ApplicationContext系列容器也許是我們最熟悉的,因為web項目中使用的XmlWebApplicationContext就屬於這個繼承體系,還有ClasspathXmlApplicationContext等,其繼承體系如下圖所示:
ApplicationContext允許上下文嵌套,通過保持父上下文可以維持一個上下文體系。對於bean的查找可以在這個上下文體系中發生,首先檢查當前上下文,其次是父上下文,逐級向上,這樣為不同的Spring應用提供了一個共享的bean定義環境。
下面我們分別簡單地演示一下兩種ioc容器的創建過程
1、XmlBeanFactory(屌絲IOC)的整個流程
通過XmlBeanFactory的源碼,我們可以發現:
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); } }
//根據Xml配置文件創建Resource資源對象,該對象中包含了BeanDefinition的信息 ClassPathResource resource =new ClassPathResource("application-context.xml"); //創建DefaultListableBeanFactory DefaultListableBeanFactory factory =new DefaultListableBeanFactory(); //創建XmlBeanDefinitionReader讀取器,用於載入BeanDefinition。之所以需要BeanFactory作為參數,是因為會將讀取的信息回調配置給factory XmlBeanDefinitionReader reader =new XmlBeanDefinitionReader(factory); //XmlBeanDefinitionReader執行載入BeanDefinition的方法,最後會完成Bean的載入和注冊。完成後Bean就成功的放置到IOC容器當中,以後我們就可以從中取得Bean來使用 reader.loadBeanDefinitions(resource);
通過前面的源碼,this.reader = new XmlBeanDefinitionReader(this); 中其中this 傳的是factory對象
2、FileSystemXmlApplicationContext 的IOC容器流程
1、高富帥IOC解剖
1 ApplicationContext =new FileSystemXmlApplicationContext(xmlPath);
先看其構造函數:
調用構造函數:
/** * 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); }
實際調用
public FileSystemXmlApplicationContext(String[] configLocations, boolean refresh, ApplicationContext parent) throws BeansException { super(parent); setConfigLocations(configLocations); if (refresh) { refresh(); } }
2、設置資源加載器和資源定位
通過分析FileSystemXmlApplicationContext的源代碼可以知道,在創建FileSystemXmlApplicationContext容器時,構造方法做以下兩項重要工作:
首先,調用父類容器的構造方法(super(parent)方法)為容器設置好Bean資源加載器。
然後,再調用父類AbstractRefreshableConfigApplicationContext的setConfigLocations(configLocations)方法設置Bean定義資源文件的定位路徑。
通過追蹤FileSystemXmlApplicationContext的繼承體系,發現其父類的父類AbstractApplicationContext中初始化IoC容器所做的主要源碼如下:
public abstract class AbstractApplicationContext extends DefaultResourceLoader implements ConfigurableApplicationContext, DisposableBean { //靜態初始化塊,在整個容器創建過程中只執行一次 static { //為了避免應用程序在Weblogic8.1關閉時出現類加載異常加載問題,加載IoC容 //器關閉事件(ContextClosedEvent)類 ContextClosedEvent.class.getName(); } //FileSystemXmlApplicationContext調用父類構造方法調用的就是該方法 public AbstractApplicationContext(ApplicationContext parent) { this.parent = parent; this.resourcePatternResolver = getResourcePatternResolver(); } //獲取一個Spring Source的加載器用於讀入Spring Bean定義資源文件 protected ResourcePatternResolver getResourcePatternResolver() { // AbstractApplicationContext繼承DefaultResourceLoader,也是一個S //Spring資源加載器,其getResource(String location)方法用於載入資源 return new PathMatchingResourcePatternResolver(this); } …… }
AbstractApplicationContext構造方法中調用PathMatchingResourcePatternResolver的構造方法創建Spring資源加載器:
public PathMatchingResourcePatternResolver(ResourceLoader resourceLoader) { Assert.notNull(resourceLoader, "ResourceLoader must not be null"); //設置Spring的資源加載器 this.resourceLoader = resourceLoader; }
在設置容器的資源加載器之後,接下來FileSystemXmlApplicationContet執行setConfigLocations方法通過調用其父類AbstractRefreshableConfigApplicationContext的方法進行對Bean定義資源文件的定位,該方法的源碼如下:
//處理單個資源文件路徑為一個字符串的情況 public void setConfigLocation(String location) { //String CONFIG_LOCATION_DELIMITERS = ",; /t/n"; //即多個資源文件路徑之間用” ,; /t/n”分隔,解析成數組形式 setConfigLocations(StringUtils.tokenizeToStringArray(location, CONFIG_LOCATION_DELIMITERS)); }
//解析Bean定義資源文件的路徑,處理多個資源文件字符串數組 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為同一個類中將字符串解析為路徑的方法 this.configLocations[i] = resolvePath(locations[i]).trim(); } } else { this.configLocations = null; } }
通過這兩個方法的源碼我們可以看出,我們既可以使用一個字符串來配置多個Spring Bean定義資源文件,也可以使用字符串數組,即下面兩種方式都是可以的:
a. ClasspathResource res = new ClasspathResource(“a.xml,b.xml,……”);
多個資源文件路徑之間可以是用” ,; /t/n”等分隔。
b. ClasspathResource res = new ClasspathResource(newString[]{“a.xml”,”b.xml”,……});
至此,Spring IoC容器在初始化時將配置的Bean定義資源文件定位為Spring封裝的Resource。
3、AbstractApplicationContext的refresh函數載入Bean定義過程:
Spring IoC容器對Bean定義資源的載入是從refresh()函數開始的,refresh()是一個模板方法,refresh()方法的作用是:在創建IoC容器前,如果已經有容器存在,則需要把已有的容器銷毀和關閉,以保證在refresh之後使用的是新建立起來的IoC容器。refresh的作用類似於對IoC容器的重啟,在新建立好的容器中對容器進行初始化,對Bean定義資源進行載入
FileSystemXmlApplicationContext通過調用其父類AbstractApplicationContext的refresh()函數啟動整個IoC容器對Bean定義的載入過程:
1 public void refresh() throws BeansException, IllegalStateException { 2 synchronized (this.startupShutdownMonitor) { 3 //調用容器准備刷新的方法,獲取容器的當時時間,同時給容器設置同步標識 4 prepareRefresh(); 5 //告訴子類啟動refreshBeanFactory()方法,Bean定義資源文件的載入從 6 //子類的refreshBeanFactory()方法啟動 7 ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory(); 8 //為BeanFactory配置容器特性,例如類加載器、事件處理器等 9 prepareBeanFactory(beanFactory); 10 try { 11 //為容器的某些子類指定特殊的BeanPost事件處理器 12 postProcessBeanFactory(beanFactory); 13 //調用所有注冊的BeanFactoryPostProcessor的Bean 14 invokeBeanFactoryPostProcessors(beanFactory); 15 //為BeanFactory注冊BeanPost事件處理器. 16 //BeanPostProcessor是Bean後置處理器,用於監聽容器觸發的事件 17 registerBeanPostProcessors(beanFactory); 18 //初始化信息源,和國際化相關. 19 initMessageSource(); 20 //初始化容器事件傳播器. 21 initApplicationEventMulticaster(); 22 //調用子類的某些特殊Bean初始化方法 23 onRefresh(); 24 //為事件傳播器注冊事件監聽器. 25 registerListeners(); 26 //初始化所有剩余的單態Bean. 27 finishBeanFactoryInitialization(beanFactory); 28 //初始化容器的生命周期事件處理器,並發布容器的生命周期事件 29 finishRefresh(); 30 } 31 catch (BeansException ex) { 32 //銷毀以創建的單態Bean 33 destroyBeans(); 34 //取消refresh操作,重置容器的同步標識. 35 cancelRefresh(ex); 36 throw ex; 37 } 38 } 39 }
refresh()方法主要為IoC容器Bean的生命周期管理提供條件,Spring IoC容器載入Bean定義資源文件從其子類容器的refreshBeanFactory()方法啟動,所以整個refresh()中“ConfigurableListableBeanFactory beanFactory =obtainFreshBeanFactory();”這句以後代碼的都是注冊容器的信息源和生命周期事件,載入過程就是從這句代碼啟動。
refresh()方法的作用是:在創建IoC容器前,如果已經有容器存在,則需要把已有的容器銷毀和關閉,以保證在refresh之後使用的是新建立起來的IoC容器。refresh的作用類似於對IoC容器的重啟,在新建立好的容器中對容器進行初始化,對Bean定義資源進行載入
AbstractApplicationContext的obtainFreshBeanFactory()方法調用子類容器的refreshBeanFactory()方法,啟動容器載入Bean定義資源文件的過程,代碼如下:
protected ConfigurableListableBeanFactory obtainFreshBeanFactory() { //這裡使用了委派設計模式,父類定義了抽象的refreshBeanFactory()方法,具體實現調用子類容器的refreshBeanFactory()方法 refreshBeanFactory(); ConfigurableListableBeanFactory beanFactory = getBeanFactory(); if (logger.isDebugEnabled()) { logger.debug("Bean factory for " + getDisplayName() + ": " + beanFactory); } return beanFactory; }
AbstractApplicationContext子類的refreshBeanFactory()方法:
AbstractApplicationContext類中只抽象定義了refreshBeanFactory()方法,容器真正調用的是其子類AbstractRefreshableApplicationContext實現的 refreshBeanFactory()方法,方法的源碼如下:
1 protected final void refreshBeanFactory() throws BeansException { 2 if (hasBeanFactory()) {//如果已經有容器,銷毀容器中的bean,關閉容器 3 destroyBeans(); 4 closeBeanFactory(); 5 } 6 try { 7 //創建IoC容器 8 DefaultListableBeanFactory beanFactory = createBeanFactory(); 9 beanFactory.setSerializationId(getId()); 10 //對IoC容器進行定制化,如設置啟動參數,開啟注解的自動裝配等 11 customizeBeanFactory(beanFactory); 12 //調用載入Bean定義的方法,主要這裡又使用了一個委派模式,在當前類中只定義了抽象的loadBeanDefinitions方法,具體的實現調用子類容器 13 loadBeanDefinitions(beanFactory); 14 synchronized (this.beanFactoryMonitor) { 15 this.beanFactory = beanFactory; 16 } 17 } 18 catch (IOException ex) { 19 throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex); 20 } 21 }
在這個方法中,先判斷BeanFactory是否存在,如果存在則先銷毀beans並關閉beanFactory,接著創建DefaultListableBeanFactory,並調用loadBeanDefinitions(beanFactory)裝載bean
定義。
5、AbstractRefreshableApplicationContext子類的loadBeanDefinitions方法:
AbstractRefreshableApplicationContext中只定義了抽象的loadBeanDefinitions方法,容器真正調用的是其子類AbstractXmlApplicationContext對該方法的實現,AbstractXmlApplicationContext的主要源碼如下:
loadBeanDefinitions方法同樣是抽象方法,是由其子類實現的,也即在AbstractXmlApplicationContext中。
1 public abstract class AbstractXmlApplicationContext extends AbstractRefreshableConfigApplicationContext { 2 …… 3 //實現父類抽象的載入Bean定義方法 4 @Override 5 protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException { 6 //創建XmlBeanDefinitionReader,即創建Bean讀取器,並通過回調設置到容器中去,容 器使用該讀取器讀取Bean定義資源 7 XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory); 8 //為Bean讀取器設置Spring資源加載器,AbstractXmlApplicationContext的 9 //祖先父類AbstractApplicationContext繼承DefaultResourceLoader,因此,容器本身也是一個資源加載器 10 beanDefinitionReader.setResourceLoader(this); 11 //為Bean讀取器設置SAX xml解析器 12 beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this)); 13 //當Bean讀取器讀取Bean定義的Xml資源文件時,啟用Xml的校驗機制 14 initBeanDefinitionReader(beanDefinitionReader); 15 //Bean讀取器真正實現加載的方法 16 loadBeanDefinitions(beanDefinitionReader); 17 } 18 //Xml Bean讀取器加載Bean定義資源 19 protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException, IOException { 20 //獲取Bean定義資源的定位 21 Resource[] configResources = getConfigResources(); 22 if (configResources != null) { 23 //Xml Bean讀取器調用其父類AbstractBeanDefinitionReader讀取定位 24 //的Bean定義資源 25 reader.loadBeanDefinitions(configResources); 26 } 27 //如果子類中獲取的Bean定義資源定位為空,則獲取FileSystemXmlApplicationContext構造方法中setConfigLocations方法設置的資源 28 String[] configLocations = getConfigLocations(); 29 if (configLocations != null) { 30 //Xml Bean讀取器調用其父類AbstractBeanDefinitionReader讀取定位 31 //的Bean定義資源 32 reader.loadBeanDefinitions(configLocations); 33 } 34 } 35 //這裡又使用了一個委托模式,調用子類的獲取Bean定義資源定位的方法 36 //該方法在ClassPathXmlApplicationContext中進行實現,對於我們 37 //舉例分析源碼的FileSystemXmlApplicationContext沒有使用該方法 38 protected Resource[] getConfigResources() { 39 return null; 40 } …… 41}
Xml Bean讀取器(XmlBeanDefinitionReader)調用其父類AbstractBeanDefinitionReader的 reader.loadBeanDefinitions方法讀取Bean定義資源。
由於我們使用FileSystemXmlApplicationContext作為例子分析,因此getConfigResources的返回值為null,因此程序執行reader.loadBeanDefinitions(configLocations)分支。
6、AbstractBeanDefinitionReader讀取Bean定義資源:
AbstractBeanDefinitionReader的loadBeanDefinitions方法源碼如下:
可以到org.springframework.beans.factory.support看一下BeanDefinitionReader的結構
在其抽象父類AbstractBeanDefinitionReader中定義了載入過程
1 //重載方法,調用下面的loadBeanDefinitions(String, Set<Resource>);方法 2 public int loadBeanDefinitions(String location) throws BeanDefinitionStoreException { 3 return loadBeanDefinitions(location, null); 4 } 5 public int loadBeanDefinitions(String location, Set<Resource> actualResources) throws BeanDefinitionStoreException { 6 //獲取在IoC容器初始化過程中設置的資源加載器 7 ResourceLoader resourceLoader = getResourceLoader(); 8 if (resourceLoader == null) { 9 throw new BeanDefinitionStoreException( 10 "Cannot import bean definitions from location [" + location + "]: no ResourceLoader available"); 11 } 12 if (resourceLoader instanceof ResourcePatternResolver) { 13 try { 14 //將指定位置的Bean定義資源文件解析為Spring IoC容器封裝的資源 15 //加載多個指定位置的Bean定義資源文件 16 Resource[] resources = ((ResourcePatternResolver) resourceLoader).getResources(location); 17 //委派調用其子類XmlBeanDefinitionReader的方法,實現加載功能 18 int loadCount = loadBeanDefinitions(resources); 19 if (actualResources != null) { 20 for (Resource resource : resources) { 21 actualResources.add(resource); 22 } 23 } 24 if (logger.isDebugEnabled()) { 25 logger.debug("Loaded " + loadCount + " bean definitions from location pattern [" + location + "]"); 26 } 27 return loadCount; 28 } 29 catch (IOException ex) { 30 throw new BeanDefinitionStoreException( 31 "Could not resolve bean definition resource pattern [" + location + "]", ex); 32 } 33 } 34 else { 35 //將指定位置的Bean定義資源文件解析為Spring IoC容器封裝的資源 36 //加載單個指定位置的Bean定義資源文件 37 Resource resource = resourceLoader.getResource(location); 38 //委派調用其子類XmlBeanDefinitionReader的方法,實現加載功能 39 int loadCount = loadBeanDefinitions(resource); 40 if (actualResources != null) { 41 actualResources.add(resource); 42 } 43 if (logger.isDebugEnabled()) { 44 logger.debug("Loaded " + loadCount + " bean definitions from location [" + location + "]"); 45 } 46 return loadCount; 47 } 48 } 49 //重載方法,調用loadBeanDefinitions(String); 50 public int loadBeanDefinitions(String... locations) throws BeanDefinitionStoreException { 51 Assert.notNull(locations, "Location array must not be null"); 52 int counter = 0; 53 for (String location : locations) { 54 counter += loadBeanDefinitions(location); 55 } 56 return counter; }
loadBeanDefinitions(Resource...resources)方法和上面分析的3個方法類似,同樣也是調用XmlBeanDefinitionReader的loadBeanDefinitions方法。
從對AbstractBeanDefinitionReader的loadBeanDefinitions方法源碼分析可以看出該方法做了以下兩件事:
首先,調用資源加載器的獲取資源方法resourceLoader.getResource(location),獲取到要加載的資源。
其次,真正執行加載功能是其子類XmlBeanDefinitionReader的loadBeanDefinitions方法。
看到第8、16行,結合上面的ResourceLoader與ApplicationContext的繼承關系圖,可以知道此時調用的是DefaultResourceLoader中的getSource()方法定位Resource,因為FileSystemXmlApplicationContext本身就是DefaultResourceLoader的實現類,所以此時又回到了FileSystemXmlApplicationContext中來。
7、資源加載器獲取要讀入的資源:
XmlBeanDefinitionReader通過調用其父類DefaultResourceLoader的getResource方法獲取要加載的資源,其源碼如下
1 //獲取Resource的具體實現方法 2 public Resource getResource(String location) { 3 Assert.notNull(location, "Location must not be null"); 4 //如果是類路徑的方式,那需要使用ClassPathResource 來得到bean 文件的資源對象 5 if (location.startsWith(CLASSPATH_URL_PREFIX)) { 6 return new ClassPathResource(location.substring(CLASSPATH_URL_PREFIX.length()), getClassLoader()); 7 } 8 try { 9 // 如果是URL 方式,使用UrlResource 作為bean 文件的資源對象 10 URL url = new URL(location); 11 return new UrlResource(url); 12 } 13 catch (MalformedURLException ex) { 14 } 15 //如果既不是classpath標識,又不是URL標識的Resource定位,則調用 16 //容器本身的getResourceByPath方法獲取Resource 17 return getResourceByPath(location); 18 19 }
FileSystemXmlApplicationContext容器提供了getResourceByPath方法的實現,就是為了處理既不是classpath標識,又不是URL標識的Resource定位這種情況。
protected Resource getResourceByPath(String path) { if (path != null && path.startsWith("/")) { path = path.substring(1); } //這裡使用文件系統資源對象來定義bean 文件 return new FileSystemResource(path); }
這樣代碼就回到了 FileSystemXmlApplicationContext 中來,他提供了FileSystemResource 來完成從文件系統得到配置文件的資源定義。
這樣,就可以從文件系統路徑上對IOC 配置文件進行加載 - 當然我們可以按照這個邏輯從任何地方加載,在Spring 中我們看到它提供 的各種資源抽象,比如ClassPathResource, URLResource,FileSystemResource 等來供我們使用。上面我們看到的是定位Resource 的一個過程,而這只是加載過程的一部分.
8、XmlBeanDefinitionReader加載Bean定義資源:
Bean定義的Resource得到了
繼續回到XmlBeanDefinitionReader的loadBeanDefinitions(Resource …)方法看到代表bean文件的資源定義以後的載入過程。
1 //XmlBeanDefinitionReader加載資源的入口方法 2 public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException { 3 //將讀入的XML資源進行特殊編碼處理 4 return loadBeanDefinitions(new EncodedResource(resource)); 5 } //這裡是載入XML形式Bean定義資源文件方法 6 public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException { 7 ....... 8 try { 9 //將資源文件轉為InputStream的IO流 10 InputStream inputStream = encodedResource.getResource().getInputStream(); 11 try { 12 //從InputStream中得到XML的解析源 13 InputSource inputSource = new InputSource(inputStream); 14 if (encodedResource.getEncoding() != null) { 15 inputSource.setEncoding(encodedResource.getEncoding()); 16 } 17 //這裡是具體的讀取過程 18 return doLoadBeanDefinitions(inputSource, encodedResource.getResource()); 19 } 20 finally { 21 //關閉從Resource中得到的IO流 22 inputStream.close(); 23 } 24 } 25 ......... 26} 27 //從特定XML文件中實際載入Bean定義資源的方法 28 protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource) 29 throws BeanDefinitionStoreException { 30 try { 31 int validationMode = getValidationModeForResource(resource); 32 //將XML文件轉換為DOM對象,解析過程由documentLoader實現 33 Document doc = this.documentLoader.loadDocument( 34 inputSource, this.entityResolver, this.errorHandler, validationMode, this.namespaceAware); 35 //這裡是啟動對Bean定義解析的詳細過程,該解析過程會用到Spring的Bean配置規則 36 return registerBeanDefinitions(doc, resource); 37 } 38 ....... }
通過源碼分析,載入Bean定義資源文件的最後一步是將Bean定義資源轉換為Document對象,該過程由documentLoader實現
9、DocumentLoader將Bean定義資源轉換為Document對象:
DocumentLoader將Bean定義資源轉換成Document對象的源碼如下:
1 //使用標准的JAXP將載入的Bean定義資源轉換成document對象 2 public Document loadDocument(InputSource inputSource, EntityResolver entityResolver, 3 ErrorHandler errorHandler, int validationMode, boolean namespaceAware) throws Exception { 4 //創建文件解析器工廠 5 DocumentBuilderFactory factory = createDocumentBuilderFactory(validationMode, namespaceAware); 6 if (logger.isDebugEnabled()) { 7 logger.debug("Using JAXP provider [" + factory.getClass().getName() + "]"); 8 } 9 //創建文檔解析器 10 DocumentBuilder builder = createDocumentBuilder(factory, entityResolver, errorHandler); 11 //解析Spring的Bean定義資源 12 return builder.parse(inputSource); 13 } 14 protected DocumentBuilderFactory createDocumentBuilderFactory(int validationMode, boolean namespaceAware) 15 throws ParserConfigurationException { 16 //創建文檔解析工廠 17 DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); 18 factory.setNamespaceAware(namespaceAware); 19 //設置解析XML的校驗 20 if (validationMode != XmlValidationModeDetector.VALIDATION_NONE) { 21 factory.setValidating(true); 22 if (validationMode == XmlValidationModeDetector.VALIDATION_XSD) { 23 factory.setNamespaceAware(true); 24 try { 25 factory.setAttribute(SCHEMA_LANGUAGE_ATTRIBUTE, XSD_SCHEMA_LANGUAGE); 26 } 27 catch (IllegalArgumentException ex) { 28 ParserConfigurationException pcex = new ParserConfigurationException( 29 "Unable to validate using XSD: Your JAXP provider [" + factory + 30 "] does not support XML Schema. Are you running on Java 1.4 with Apache Crimson? " + 31 "Upgrade to Apache Xerces (or Java 1.5) for full XSD support."); 32 pcex.initCause(ex); 33 throw pcex; 34 } 35 } 36 } 37 return factory; 38 }
該解析過程調用JavaEE標准的JAXP標准進行處理。
至此Spring IoC容器根據定位的Bean定義資源文件,將其加載讀入並轉換成為Document對象過程完成。
接下來我們要繼續分析Spring IoC容器將載入的Bean定義資源文件轉換為Document對象之後,是如何將其解析為Spring IoC管理的Bean對象並將其注冊到容器中的。
10、XmlBeanDefinitionReader解析載入的Bean定義資源文件:
XmlBeanDefinitionReader類中的doLoadBeanDefinitions方法是從特定XML文件中實際載入Bean定義資源的方法,該方法在載入Bean定義資源之後將其轉換為Document對象,接下來調用registerBeanDefinitions啟動Spring IoC容器對Bean定義的解析過程,registerBeanDefinitions方法源碼如下:
1 //按照Spring的Bean語義要求將Bean定義資源解析並轉換為容器內部數據結構 2 public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException { 3 //得到BeanDefinitionDocumentReader來對xml格式的BeanDefinition解析 4 BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader(); 5 //獲得容器中注冊的Bean數量 6 int countBefore = getRegistry().getBeanDefinitionCount(); 7 //解析過程入口,這裡使用了委派模式,BeanDefinitionDocumentReader只是個接口,//具體的解析實現過程有實現類DefaultBeanDefinitionDocumentReader完成 8 documentReader.registerBeanDefinitions(doc, createReaderContext(resource)); 9 //統計解析的Bean數量 10 return getRegistry().getBeanDefinitionCount() - countBefore; 11 } 12 //創建BeanDefinitionDocumentReader對象,解析Document對象 13 protected BeanDefinitionDocumentReader createBeanDefinitionDocumentReader() { 14 return BeanDefinitionDocumentReader.class.cast(BeanUtils.instantiateClass(this.documentReaderClass)); }
Bean定義資源的載入解析分為以下兩個過程:
首先,通過調用XML解析器將Bean定義資源文件轉換得到Document對象,但是這些Document對象並沒有按照Spring的Bean規則進行解析。這一步是載入的過程
其次,在完成通用的XML解析之後,按照Spring的Bean規則對Document對象進行解析。
按照Spring的Bean規則對Document對象解析的過程是在接口BeanDefinitionDocumentReader的實現類DefaultBeanDefinitionDocumentReader中實現的。
11、DefaultBeanDefinitionDocumentReader對Bean定義的Document對象解析:
BeanDefinitionDocumentReader接口通過registerBeanDefinitions方法調用其實現類DefaultBeanDefinitionDocumentReader對Document對象進行解析,解析的代碼如下:
1 //根據Spring DTD對Bean的定義規則解析Bean定義Document對象 2 public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) { 3 //獲得XML描述符 4 this.readerContext = readerContext; 5 logger.debug("Loading bean definitions"); 6 //獲得Document的根元素 7 Element root = doc.getDocumentElement(); 8 //具體的解析過程由BeanDefinitionParserDelegate實現, 9 //BeanDefinitionParserDelegate中定義了Spring Bean定義XML文件的各種元素 10 BeanDefinitionParserDelegate delegate = createHelper(readerContext, root); 11 //在解析Bean定義之前,進行自定義的解析,增強解析過程的可擴展性 12 preProcessXml(root); 13 //從Document的根元素開始進行Bean定義的Document對象 14 parseBeanDefinitions(root, delegate); 15 //在解析Bean定義之後,進行自定義的解析,增加解析過程的可擴展性 16 postProcessXml(root); 17 } 18 //創建BeanDefinitionParserDelegate,用於完成真正的解析過程 19 protected BeanDefinitionParserDelegate createHelper(XmlReaderContext readerContext, Element root) { 20 BeanDefinitionParserDelegate delegate = new BeanDefinitionParserDelegate(readerContext); 21 //BeanDefinitionParserDelegate初始化Document根元素 22 delegate.initDefaults(root); 23 return delegate; 24 } 25 //使用Spring的Bean規則從Document的根元素開始進行Bean定義的Document對象 26 protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) { 27 //Bean定義的Document對象使用了Spring默認的XML命名空間 28 if (delegate.isDefaultNamespace(root)) { 29 //獲取Bean定義的Document對象根元素的所有子節點 30 NodeList nl = root.getChildNodes(); 31 for (int i = 0; i < nl.getLength(); i++) { 32 Node node = nl.item(i); 33 //獲得Document節點是XML元素節點 34 if (node instanceof Element) { 35 Element ele = (Element) node; 36 //Bean定義的Document的元素節點使用的是Spring默認的XML命名空間 37 if (delegate.isDefaultNamespace(ele)) { 38 //使用Spring的Bean規則解析元素節點 39 parseDefaultElement(ele, delegate); 40 } 41 else { 42 //沒有使用Spring默認的XML命名空間,則使用用戶自定義的解//析規則解析元素節點 43 delegate.parseCustomElement(ele); 44 } 45 } 46 } 47 } 48 else { 49 //Document的根節點沒有使用Spring默認的命名空間,則使用用戶自定義的 50 //解析規則解析Document根節點 51 delegate.parseCustomElement(root); 52 } 53 } 54 //使用Spring的Bean規則解析Document元素節點 55 private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) { 56 //如果元素節點是<Import>導入元素,進行導入解析 57 if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) { 58 importBeanDefinitionResource(ele); 59 } 60 //如果元素節點是<Alias>別名元素,進行別名解析 61 else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) { 62 processAliasRegistration(ele); 63 } 64 //元素節點既不是導入元素,也不是別名元素,即普通的<Bean>元素, 65 //按照Spring的Bean規則解析元素 66 else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) { 67 processBeanDefinition(ele, delegate); 68 } 69 } 70 //解析<Import>導入元素,從給定的導入路徑加載Bean定義資源到Spring IoC容器中 71 protected void importBeanDefinitionResource(Element ele) { 72 //獲取給定的導入元素的location屬性 73 String location = ele.getAttribute(RESOURCE_ATTRIBUTE); 74 //如果導入元素的location屬性值為空,則沒有導入任何資源,直接返回 75 if (!StringUtils.hasText(location)) { 76 getReaderContext().error("Resource location must not be empty", ele); 77 return; 78 } 79 //使用系統變量值解析location屬性值 80 location = SystemPropertyUtils.resolvePlaceholders(location); 81 Set<Resource> actualResources = new LinkedHashSet<Resource>(4); 82 //標識給定的導入元素的location是否是絕對路徑 83 boolean absoluteLocation = false; 84 try { 85 absoluteLocation = ResourcePatternUtils.isUrl(location) || ResourceUtils.toURI(location).isAbsolute(); 86 } 87 catch (URISyntaxException ex) { 88 //給定的導入元素的location不是絕對路徑 89 } 90 //給定的導入元素的location是絕對路徑 91 if (absoluteLocation) { 92 try { 93 //使用資源讀入器加載給定路徑的Bean定義資源 94 int importCount = getReaderContext().getReader().loadBeanDefinitions(location, actualResources); 95 if (logger.isDebugEnabled()) { 96 logger.debug("Imported " + importCount + " bean definitions from URL location [" + location + "]"); 97 } 98 } 99 catch (BeanDefinitionStoreException ex) { 100 getReaderContext().error( 101 "Failed to import bean definitions from URL location [" + location + "]", ele, ex); 102 } 103 } 104 else { 105 //給定的導入元素的location是相對路徑 106 try { 107 int importCount; 108 //將給定導入元素的location封裝為相對路徑資源 109 Resource relativeResource = getReaderContext().getResource().createRelative(location); 110 //封裝的相對路徑資源存在 111 if (relativeResource.exists()) { 112 //使用資源讀入器加載Bean定義資源 113 importCount = getReaderContext().getReader().loadBeanDefinitions(relativeResource); 114 actualResources.add(relativeResource); 115 } 116 //封裝的相對路徑資源不存在 117 else { 118 //獲取Spring IoC容器資源讀入器的基本路徑 119 String baseLocation = getReaderContext().getResource().getURL().toString(); 120 //根據Spring IoC容器資源讀入器的基本路徑加載給定導入 121 //路徑的資源 122 importCount = getReaderContext().getReader().loadBeanDefinitions( 123 StringUtils.applyRelativePath(baseLocation, location), actualResources); 124 } 125 if (logger.isDebugEnabled()) { 126 logger.debug("Imported " + importCount + " bean definitions from relative location [" + location + "]"); 127 } 128 } 129 catch (IOException ex) { 130 getReaderContext().error("Failed to resolve current resource location", ele, ex); 131 } 132 catch (BeanDefinitionStoreException ex) { 133 getReaderContext().error("Failed to import bean definitions from relative location [" + location + "]", 134 ele, ex); 135 } 136 } 137 Resource[] actResArray = actualResources.toArray(new Resource[actualResources.size()]); 138 //在解析完<Import>元素之後,發送容器導入其他資源處理完成事件 139 getReaderContext().fireImportProcessed(location, actResArray, extractSource(ele)); 140 } 141 //解析<Alias>別名元素,為Bean向Spring IoC容器注冊別名 142 protected void processAliasRegistration(Element ele) { 143 //獲取<Alias>別名元素中name的屬性值 144 String name = ele.getAttribute(NAME_ATTRIBUTE); 145 //獲取<Alias>別名元素中alias的屬性值 146 String alias = ele.getAttribute(ALIAS_ATTRIBUTE); 147 boolean valid = true; 148 //<alias>別名元素的name屬性值為空 149 if (!StringUtils.hasText(name)) { 150 getReaderContext().error("Name must not be empty", ele); 151 valid = false; 152 } 153 //<alias>別名元素的alias屬性值為空 154 if (!StringUtils.hasText(alias)) { 155 getReaderContext().error("Alias must not be empty", ele); 156 valid = false; 157 } 158 if (valid) { 159 try { 160 //向容器的資源讀入器注冊別名 161 getReaderContext().getRegistry().registerAlias(name, alias); 162 } 163 catch (Exception ex) { 164 getReaderContext().error("Failed to register alias '" + alias + 165 "' for bean with name '" + name + "'", ele, ex); 166 } 167 //在解析完<Alias>元素之後,發送容器別名處理完成事件 168 getReaderContext().fireAliasRegistered(name, alias, extractSource(ele)); 169 } 170 } 171 //解析Bean定義資源Document對象的普通元素 172 protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) { 173 // BeanDefinitionHolder是對BeanDefinition的封裝,即Bean定義的封裝類 174 //對Document對象中<Bean>元素的解析由BeanDefinitionParserDelegate實現 BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele); 175 if (bdHolder != null) { 176 bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder); 177 try { 178 //向Spring IoC容器注冊解析得到的Bean定義,這是Bean定義向IoC容器注冊的入口
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry()); 179 } 180 catch (BeanDefinitionStoreException ex) { 181 getReaderContext().error("Failed to register bean definition with name '" + 182 bdHolder.getBeanName() + "'", ele, ex); 183 } 184 //在完成向Spring IoC容器注冊解析得到的Bean定義之後,發送注冊事件 185 getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder)); 186 } 187 }
通過上述Spring IoC容器對載入的Bean定義Document解析可以看出,我們使用Spring時,在Spring配置文件中可以使用<Import>元素來導入IoC容器所需要的其他資源,Spring IoC容器在解析時會首先將指定導入的資源加載進容器中。使用<Ailas>別名時,Spring IoC容器首先將別名元素所定義的別名注冊到容器中。
對於既不是<Import>元素,又不是<Alias>元素的元素,即Spring配置文件中普通的<Bean>元素的解析由BeanDefinitionParserDelegate類的parseBeanDefinitionElement方法來實現。
12、BeanDefinitionParserDelegate解析Bean定義資源文件中的<Bean>元素:
Bean定義資源文件中的<Import>和<Alias>元素解析在DefaultBeanDefinitionDocumentReader中已經完成,對Bean定義資源文件中使用最多的<Bean>元素交由BeanDefinitionParserDelegate來解析,其解析實現的源碼如下:
1 //解析<Bean>元素的入口 2 public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) { 3 return parseBeanDefinitionElement(ele, null); 4 } 5 //解析Bean定義資源文件中的<Bean>元素,這個方法中主要處理<Bean>元素的id,name 6 //和別名屬性 7 public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) { 8 //獲取<Bean>元素中的id屬性值 9 String id = ele.getAttribute(ID_ATTRIBUTE); 10 //獲取<Bean>元素中的name屬性值 11 String nameAttr = ele.getAttribute(NAME_ATTRIBUTE); 12 ////獲取<Bean>元素中的alias屬性值 13 List<String> aliases = new ArrayList<String>(); 14 //將<Bean>元素中的所有name屬性值存放到別名中 15 if (StringUtils.hasLength(nameAttr)) { 16 String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, BEAN_NAME_DELIMITERS); 17 aliases.addAll(Arrays.asList(nameArr)); 18 } 19 String beanName = id; 20 //如果<Bean>元素中沒有配置id屬性時,將別名中的第一個值賦值給beanName 21 if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) { 22 beanName = aliases.remove(0); 23 if (logger.isDebugEnabled()) { 24 logger.debug("No XML 'id' specified - using '" + beanName + 25 "' as bean name and " + aliases + " as aliases"); 26 } 27 } 28 //檢查<Bean>元素所配置的id或者name的唯一性,containingBean標識<Bean> 29 //元素中是否包含子<Bean>元素 30 if (containingBean == null) { 31 //檢查<Bean>元素所配置的id、name或者別名是否重復 32 checkNameUniqueness(beanName, aliases, ele); 33 } 34 //詳細對<Bean>元素中配置的Bean定義進行解析的地方 35 AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean); 36 if (beanDefinition != null) { 37 if (!StringUtils.hasText(beanName)) { 38 try { 39 if (containingBean != null) { 40 //如果<Bean>元素中沒有配置id、別名或者name,且沒有包含子//<Bean>元素,為解析的Bean生成一個唯一beanName並注冊 41 beanName = BeanDefinitionReaderUtils.generateBeanName( 42 beanDefinition, this.readerContext.getRegistry(), true); 43 } 44 else { 45 //如果<Bean>元素中沒有配置id、別名或者name,且包含了子//<Bean>元素,為解析的Bean使用別名向IoC容器注冊 46 beanName = this.readerContext.generateBeanName(beanDefinition); 47 //為解析的Bean使用別名注冊時,為了向後兼容 //Spring1.2/2.0,給別名添加類名後綴 48 String beanClassName = beanDefinition.getBeanClassName(); 49 if (beanClassName != null && 50 beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() && 51 !this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) { 52 aliases.add(beanClassName); 53 } 54 } 55 if (logger.isDebugEnabled()) { 56 logger.debug("Neither XML 'id' nor 'name' specified - " + 57 "using generated bean name [" + beanName + "]"); 58 } 59 } 60 catch (Exception ex) { 61 error(ex.getMessage(), ele); 62 return null; 63 } 64 } 65 String[] aliasesArray = StringUtils.toStringArray(aliases); 66 return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray); 67 } 68 //當解析出錯時,返回null 69 return null; 70 } 71 //詳細對<Bean>元素中配置的Bean定義其他屬性進行解析,由於上面的方法中已經對//Bean的id、name和別名等屬性進行了處理,該方法中主要處理除這三個以外的其他屬性數據 72 public AbstractBeanDefinition parseBeanDefinitionElement( 73 Element ele, String beanName, BeanDefinition containingBean) { 74 //記錄解析的<Bean> 75 this.parseState.push(new BeanEntry(beanName)); 76 //這裡只讀取<Bean>元素中配置的class名字,然後載入到BeanDefinition中去 77 //只是記錄配置的class名字,不做實例化,對象的實例化在依賴注入時完成 78 String className = null; 79 if (ele.hasAttribute(CLASS_ATTRIBUTE)) { 80 className = ele.getAttribute(CLASS_ATTRIBUTE).trim(); 81 } 82 try { 83 String parent = null; 84 //如果<Bean>元素中配置了parent屬性,則獲取parent屬性的值 85 if (ele.hasAttribute(PARENT_ATTRIBUTE)) { 86 parent = ele.getAttribute(PARENT_ATTRIBUTE); 87 } 88 //根據<Bean>元素配置的class名稱和parent屬性值創建BeanDefinition 89 //為載入Bean定義信息做准備 90 AbstractBeanDefinition bd = createBeanDefinition(className, parent); 91 //對當前的<Bean>元素中配置的一些屬性進行解析和設置,如配置的單態(singleton)屬性等 92 parseBeanDefinitionAttributes(ele, beanName, containingBean, bd); 93 //為<Bean>元素解析的Bean設置description信息 bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT)); 94 //對<Bean>元素的meta(元信息)屬性解析 95 parseMetaElements(ele, bd); 96 //對<Bean>元素的lookup-method屬性解析 97 parseLookupOverrideSubElements(ele, bd.getMethodOverrides()); 98 //對<Bean>元素的replaced-method屬性解析 99 parseReplacedMethodSubElements(ele, bd.getMethodOverrides()); 100 //解析<Bean>元素的構造方法設置 101 parseConstructorArgElements(ele, bd); 102 //解析<Bean>元素的<property>設置 103 parsePropertyElements(ele, bd); 104 //解析<Bean>元素的qualifier屬性 105 parseQualifierElements(ele, bd); 106 //為當前解析的Bean設置所需的資源和依賴對象 107 bd.setResource(this.readerContext.getResource()); 108 bd.setSource(extractSource(ele)); 109 return bd; 110 } 111 catch (ClassNotFoundException ex) { 112 error("Bean class [" + className + "] not found", ele, ex); 113 } 114 catch (NoClassDefFoundError err) { 115 error("Class that bean class [" + className + "] depends on not found", ele, err); 116 } 117 catch (Throwable ex) { 118 error("Unexpected failure during bean definition parsing", ele, ex); 119 } 120 finally { 121 this.parseState.pop(); 122 } 123 //解析<Bean>元素出錯時,返回null 124 return null; 125 }
只要使用過Spring,對Spring配置文件比較熟悉的人,通過對上述源碼的分析,就會明白我們在Spring配置文件中<Bean>元素的中配置的屬性就是通過該方法解析和設置到Bean中去的。
注意:在解析<Bean>元素過程中沒有創建和實例化Bean對象,只是創建了Bean對象的定義類BeanDefinition,將<Bean>元素中的配置信息設置到BeanDefinition中作為記錄,當依賴注入時才使用這些記錄信息創建和實例化具體的Bean對象。
上面方法中一些對一些配置如元信息(meta)、qualifier等的解析,我們在Spring中配置時使用的也不多,我們在使用Spring的<Bean>元素時,配置最多的是<property>屬性,因此我們下面繼續分析源碼,了解Bean的屬性在解析時是如何設置的。
13、BeanDefinitionParserDelegate解析<property>元素:
BeanDefinitionParserDelegate在解析<Bean>調用parsePropertyElements方法解析<Bean>元素中的<property>屬性子元素,解析源碼如下:
1 //解析<Bean>元素中的<property>子元素 2 public void parsePropertyElements(Element beanEle, BeanDefinition bd) { 3 //獲取<Bean>元素中所有的子元素 4 NodeList nl = beanEle.getChildNodes(); 5 for (int i = 0; i < nl.getLength(); i++) { 6 Node node = nl.item(i); 7 //如果子元素是<property>子元素,則調用解析<property>子元素方法解析 8 if (isCandidateElement(node) && nodeNameEquals(node, PROPERTY_ELEMENT)) { 9 parsePropertyElement((Element) node, bd); 10 } 11 } 12 } 13 //解析<property>元素 14 public void parsePropertyElement(Element ele, BeanDefinition bd) { 15 //獲取<property>元素的名字 16 String propertyName = ele.getAttribute(NAME_ATTRIBUTE); 17 if (!StringUtils.hasLength(propertyName)) { 18 error("Tag 'property' must have a 'name' attribute", ele); 19 return; 20 } 21 this.parseState.push(new PropertyEntry(propertyName)); 22 try { 23 //如果一個Bean中已經有同名的property存在,則不進行解析,直接返回。 24 //即如果在同一個Bean中配置同名的property,則只有第一個起作用 25 if (bd.getPropertyValues().contains(propertyName)) { 26 error("Multiple 'property' definitions for property '" + propertyName + "'", ele); 27 return; 28 } 29 //解析獲取property的值 30 Object val = parsePropertyValue(ele, bd, propertyName); 31 //根據property的名字和值創建property實例 32 PropertyValue pv = new PropertyValue(propertyName, val); 33 //解析<property>元素中的屬性 34 parseMetaElements(ele, pv); 35 pv.setSource(extractSource(ele)); 36 bd.getPropertyValues().addPropertyValue(pv); 37 } 38 finally { 39 this.parseState.pop(); 40 } 41 } 42 //解析獲取property值 43 public Object parsePropertyValue(Element ele, BeanDefinition bd, String propertyName) { 44 String elementName = (propertyName != null) ? 45 "<property> element for property '" + propertyName + "'" : 46 "<constructor-arg> element"; 47 //獲取<property>的所有子元素,只能是其中一種類型:ref,value,list等 48 NodeList nl = ele.getChildNodes(); 49 Element subElement = null; 50 for (int i = 0; i < nl.getLength(); i++) { 51 Node node = nl.item(i); 52 //子元素不是description和meta屬性 53 if (node instanceof Element && !nodeNameEquals(node, DESCRIPTION_ELEMENT) && 54 !nodeNameEquals(node, META_ELEMENT)) { 55 if (subElement != null) { 56 error(elementName + " must not contain more than one sub-element", ele); 57 } 58 else {//當前<property>元素包含有子元素 59 subElement = (Element) node; 60 } 61 } 62 } 63 //判斷property的屬性值是ref還是value,不允許既是ref又是value 64 boolean hasRefAttribute = ele.hasAttribute(REF_ATTRIBUTE); 65 boolean hasValueAttribute = ele.hasAttribute(VALUE_ATTRIBUTE); 66 if ((hasRefAttribute && hasValueAttribute) || 67 ((hasRefAttribute || hasValueAttribute) && subElement != null)) { 68 error(elementName + 69 " is only allowed to contain either 'ref' attribute OR 'value' attribute OR sub-element", ele); 70 } 71 //如果屬性是ref,創建一個ref的數據對象RuntimeBeanReference,這個對象 72 //封裝了ref信息 73 if (hasRefAttribute) { 74 String refName = ele.getAttribute(REF_ATTRIBUTE); 75 if (!StringUtils.hasText(refName)) { 76 error(elementName + " contains empty 'ref' attribute", ele); 77 } 78 //一個指向運行時所依賴對象的引用 79 RuntimeBeanReference ref = new RuntimeBeanReference(refName); 80 //設置這個ref的數據對象是被當前的property對象所引用 81 ref.setSource(extractSource(ele)); 82 return ref; 83 } 84 //如果屬性是value,創建一個value的數據對象TypedStringValue,這個對象 85 //封裝了value信息 86 else if (hasValueAttribute) { 87 //一個持有String類型值的對象 88 TypedStringValue valueHolder = new TypedStringValue(ele.getAttribute(VALUE_ATTRIBUTE)); 89 //設置這個value數據對象是被當前的property對象所引用 90 valueHolder.setSource(extractSource(ele)); 91 return valueHolder; 92 } 93 //如果當前<property>元素還有子元素 94 else if (subElement != null) { 95 //解析<property>的子元素 96 return parsePropertySubElement(subElement, bd); 97 } 98 else { 99 //propery屬性中既不是ref,也不是value屬性,解析出錯返回null error(elementName + " must specify a ref or value", ele); 100 return null; 101 } }
通過對上述源碼的分析,我們可以了解在Spring配置文件中,<Bean>元素中<property>元素的相關配置是如何處理的:
a. ref被封裝為指向依賴對象一個引用。
b.value配置都會封裝成一個字符串類型的對象。
c.ref和value都通過“解析的數據類型屬性值.setSource(extractSource(ele));”方法將屬性值/引用與所引用的屬性關聯起來。
在方法的最後對於<property>元素的子元素通過parsePropertySubElement 方法解析,我們繼續分析該方法的源碼,了解其解析過程。
14、解析<property>元素的子元素:
在BeanDefinitionParserDelegate類中的parsePropertySubElement方法對<property>中的子元素解析,源碼如下:
1 //解析<property>元素中ref,value或者集合等子元素 2 public Object parsePropertySubElement(Element ele, BeanDefinition bd, String defaultValueType) { 3 //如果<property>沒有使用Spring默認的命名空間,則使用用戶自定義的規則解析//內嵌元素 4 if (!isDefaultNamespace(ele)) { 5 return parseNestedCustomElement(ele, bd); 6 } 7 //如果子元素是bean,則使用解析<Bean>元素的方法解析 8 else if (nodeNameEquals(ele, BEAN_ELEMENT)) { 9 BeanDefinitionHolder nestedBd = parseBeanDefinitionElement(ele, bd); 10 if (nestedBd != null) { 11 nestedBd = decorateBeanDefinitionIfRequired(ele, nestedBd, bd); 12 } 13 return nestedBd; 14 } 15 //如果子元素是ref,ref中只能有以下3個屬性:bean、local、parent 16 else if (nodeNameEquals(ele, REF_ELEMENT)) { 17 //獲取<property>元素中的bean屬性值,引用其他解析的Bean的名稱 18 //可以不再同一個Spring配置文件中,具體請參考Spring對ref的配置規則 19 String refName = ele.getAttribute(BEAN_REF_ATTRIBUTE); 20 boolean toParent = false; 21 if (!StringUtils.hasLength(refName)) { 22 //獲取<property>元素中的local屬性值,引用同一個Xml文件中配置 23 //的Bean的id,local和ref不同,local只能引用同一個配置文件中的Bean 24 refName = ele.getAttribute(LOCAL_REF_ATTRIBUTE); 25 if (!StringUtils.hasLength(refName)) { 26 //獲取<property>元素中parent屬性值,引用父級容器中的Bean 27 refName = ele.getAttribute(PARENT_REF_ATTRIBUTE); 28 toParent = true; 29 if (!StringUtils.hasLength(refName)) { 30 error("'bean', 'local' or 'parent' is required for <ref> element", ele); 31 return null; 32 } 33 } 34 } 35 //沒有配置ref的目標屬性值 36 if (!StringUtils.hasText(refName)) { 37 error("<ref> element contains empty target attribute", ele); 38 return null; 39 } 40 //創建ref類型數據,指向被引用的對象 41 RuntimeBeanReference ref = new RuntimeBeanReference(refName, toParent); 42 //設置引用類型值是被當前子元素所引用 43 ref.setSource(extractSource(ele)); 44 return ref; 45 } 46 //如果子元素是<idref>,使用解析ref元素的方法解析 47 else if (nodeNameEquals(ele, IDREF_ELEMENT)) { 48 return parseIdRefElement(ele); 49 } 50 //如果子元素是<value>,使用解析value元素的方法解析 51 else if (nodeNameEquals(ele, VALUE_ELEMENT)) { 52 return parseValueElement(ele, defaultValueType); 53 } 54 //如果子元素是null,為<property>設置一個封裝null值的字符串數據 55 else if (nodeNameEquals(ele, NULL_ELEMENT)) { 56 TypedStringValue nullHolder = new TypedStringValue(null); 57 nullHolder.setSource(extractSource(ele)); 58 return nullHolder; 59 } 60 //如果子元素是<array>,使用解析array集合子元素的方法解析 61 else if (nodeNameEquals(ele, ARRAY_ELEMENT)) { 62 return parseArrayElement(ele, bd); 63 } 64 //如果子元素是<list>,使用解析list集合子元素的方法解析 65 else if (nodeNameEquals(ele, LIST_ELEMENT)) { 66 return parseListElement(ele, bd); 67 } 68 //如果子元素是<set>,使用解析set集合子元素的方法解析 69 else if (nodeNameEquals(ele, SET_ELEMENT)) { 70 return parseSetElement(ele, bd); 71 } 72 //如果子元素是<map>,使用解析map集合子元素的方法解析 73 else if (nodeNameEquals(ele, MAP_ELEMENT)) { 74 return parseMapElement(ele, bd); 75 } 76 //如果子元素是<props>,使用解析props集合子元素的方法解析 77 else if (nodeNameEquals(ele, PROPS_ELEMENT)) { 78 return parsePropsElement(ele); 79 } 80 //既不是ref,又不是value,也不是集合,則子元素配置錯誤,返回null 81 else { 82 error("Unknown property sub-element: [" + ele.getNodeName() + "]", ele); 83 return null; 84 } }
通過上述源碼分析,我們明白了在Spring配置文件中,對<property>元素中配置的Array、List、Set、Map、Prop等各種集合子元素的都通過上述方法解析,生成對應的數據對象,比如ManagedList、ManagedArray、ManagedSet等,這些Managed類是Spring對象BeanDefiniton的數據封裝,對集合數據類型的具體解析有各自的解析方法實現,解析方法的命名非常規范,一目了然,我們對<list>集合元素的解析方法進行源碼分析,了解其實現過程。
15、解析<list>子元素:
在BeanDefinitionParserDelegate類中的parseListElement方法就是具體實現解析<property>元素中的<list>集合子元素,源碼如下:
1 //解析<list>集合子元素 2 public List parseListElement(Element collectionEle, BeanDefinition bd) { 3 //獲取<list>元素中的value-type屬性,即獲取集合元素的數據類型 4 String defaultElementType = collectionEle.getAttribute(VALUE_TYPE_ATTRIBUTE); 5 //獲取<list>集合元素中的所有子節點 6 NodeList nl = collectionEle.getChildNodes(); 7 //Spring中將List封裝為ManagedList 8 ManagedList<Object> target = new ManagedList<Object>(nl.getLength()); 9 target.setSource(extractSource(collectionEle)); 10 //設置集合目標數據類型 11 target.setElementTypeName(defaultElementType); 12 target.setMergeEnabled(parseMergeAttribute(collectionEle)); 13 //具體的<list>元素解析 14 parseCollectionElements(nl, target, bd, defaultElementType); 15 return target; 16 } 17 //具體解析<list>集合元素,<array>、<list>和<set>都使用該方法解析 18 protected void parseCollectionElements( 19 NodeList elementNodes, Collection<Object> target, BeanDefinition bd, String defaultElementType) { 20 //遍歷集合所有節點 21 for (int i = 0; i < elementNodes.getLength(); i++) { 22 Node node = elementNodes.item(i); 23 //節點不是description節�� 24 if (node instanceof Element && !nodeNameEquals(node, DESCRIPTION_ELEMENT)) { 25 //將解析的元素加入集合中,遞歸調用下一個子元素 26 target.add(parsePropertySubElement((Element) node, bd, defaultElementType)); 27 } 28 } }
經過對Spring Bean定義資源文件轉換的Document對象中的元素層層解析,Spring IoC現在已經將XML形式定義的Bean定義資源文件轉換為Spring IoC所識別的數據結構——BeanDefinition,它是Bean定義資源文件中配置的POJO對象在Spring IoC容器中的映射,我們可以通過AbstractBeanDefinition為入口,榮IoC容器進行索引、查詢和操作。
通過Spring IoC容器對Bean定義資源的解析後,IoC容器大致完成了管理Bean對象的准備工作,即初始化過程,但是最為重要的依賴注入還沒有發生,現在在IoC容器中BeanDefinition存儲的只是一些靜態信息,接下來需要向容器注冊Bean定義信息才能全部完成IoC容器的初始化過程
16、解析過後的BeanDefinition在IoC容器中的注冊:
讓我們繼續跟蹤程序的執行順序,接下來會到我們第3步中分析DefaultBeanDefinitionDocumentReader對Bean定義轉換的Document對象解析的流程中,在其parseDefaultElement方法中完成對Document對象的解析後得到封裝BeanDefinition的BeanDefinitionHold對象,然後調用BeanDefinitionReaderUtils的registerBeanDefinition方法向IoC容器注冊解析的Bean,BeanDefinitionReaderUtils的注冊的源碼如下:
//將解析的BeanDefinitionHold注冊到容器中 public static void registerBeanDefinition(BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry) throws BeanDefinitionStoreException { //獲取解析的BeanDefinition的名稱 String beanName = definitionHolder.getBeanName(); //向IoC容器注冊BeanDefinition registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition()); //如果解析的BeanDefinition有別名,向容器為其注冊別名 String[] aliases = definitionHolder.getAliases(); if (aliases != null) { for (String aliase : aliases) { registry.registerAlias(beanName, aliase); } } }
當調用BeanDefinitionReaderUtils向IoC容器注冊解析的BeanDefinition時,真正完成注冊功能的是DefaultListableBeanFactory。
17、DefaultListableBeanFactory向IoC容器注冊解析後的BeanDefinition:
DefaultListableBeanFactory中使用一個HashMap的集合對象存放IoC容器中注冊解析的BeanDefinition,向IoC容器注冊的主要源碼如下:
1 //存儲注冊的俄BeanDefinition 2 private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<String, BeanDefinition>(); 3 //向IoC容器注冊解析的BeanDefiniton 4 public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition) 5 throws BeanDefinitionStoreException { 6 Assert.hasText(beanName, "Bean name must not be empty"); 7 Assert.notNull(beanDefinition, "BeanDefinition must not be null"); 8 //校驗解析的BeanDefiniton 9 if (beanDefinition instanceof AbstractBeanDefinition) { 10 try { 11 ((AbstractBeanDefinition) beanDefinition).validate(); 12 } 13 catch (BeanDefinitionValidationException ex) { 14 throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName, 15 "Validation of bean definition failed", ex); 16 } 17 } 18 //注冊的過程中需要線程同步,以保證數據的一致性 19 synchronized (this.beanDefinitionMap) { 20 Object oldBeanDefinition = this.beanDefinitionMap.get(beanName); 21 //檢查是否有同名的BeanDefinition已經在IoC容器中注冊,如果已經注冊, 22 //並且不允許覆蓋已注冊的Bean,則拋出注冊失敗異常 23 if (oldBeanDefinition != null) { 24 if (!this.allowBeanDefinitionOverriding) { 25 throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName, 26 "Cannot register bean definition [" + beanDefinition + "] for bean '" + beanName + 27 "': There is already [" + oldBeanDefinition + "] bound."); 28 } 29 else {//如果允許覆蓋,則同名的Bean,後注冊的覆蓋先注冊的 30 if (this.logger.isInfoEnabled()) { 31 this.logger.info("Overriding bean definition for bean '" + beanName + 32 "': replacing [" + oldBeanDefinition + "] with [" + beanDefinition + "]"); 33 } 34 } 35 } 36 //IoC容器中沒有已經注冊同名的Bean,按正常注冊流程注冊 37 else { 38 this.beanDefinitionNames.add(beanName); 39 this.frozenBeanDefinitionNames = null; 40 } 41 this.beanDefinitionMap.put(beanName, beanDefinition); 42 //重置所有已經注冊過的BeanDefinition的緩存 43 resetBeanDefinition(beanName); 44 } }
至此,Bean定義資源文件中配置的Bean被解析過後,已經注冊到IoC容器中,被容器管理起來,真正完成了IoC容器初始化所做的全部工作。現 在IoC容器中已經建立了整個Bean的配置信息,這些BeanDefinition信息已經可以使用,並且可以被檢索,IoC容器的作用就是對這些注冊的Bean定義信息進行處理和維護。這些的注冊的Bean定義信息是IoC容器控制反轉的基礎,正是有了這些注冊的數據,容器才可以進行依賴注入。
總結:
現在通過上面的代碼,總結一下IOC容器初始化的基本步驟:
u 初始化的入口在容器實現中的 refresh()調用來完成
u 對 bean 定義載入 IOC 容器使用的方法是 loadBeanDefinition,其中的大致過程如下:通過 ResourceLoader 來完成資源文件位置的定位,DefaultResourceLoader 是默認的實現,同時上下文本身就給出了 ResourceLoader 的實現,可以從類路徑,文件系統, URL 等方式來定為資源位置。如果是 XmlBeanFactory作為 IOC 容器,那麼需要為它指定 bean 定義的資源,也就是說 bean 定義文件時通過抽象成 Resource 來被 IOC 容器處理的,容器通過 BeanDefinitionReader來完成定義信息的解析和 Bean 信息的注冊,往往使用的是XmlBeanDefinitionReader 來解析 bean 的 xml 定義文件 - 實際的處理過程是委托給 BeanDefinitionParserDelegate 來完成的,從而得到 bean 的定義信息,這些信息在 Spring 中使用 BeanDefinition 對象來表示 - 這個名字可以讓我們想到loadBeanDefinition,RegisterBeanDefinition 這些相關��方法 - 他們都是為處理 BeanDefinitin 服務的, 容器解析得到 BeanDefinitionIoC 以後,需要把它在 IOC 容器中注冊,這由 IOC 實現 BeanDefinitionRegistry 接口來實現。注冊過程就是在 IOC 容器內部維護的一個HashMap 來保存得到的 BeanDefinition 的過程。這個 HashMap 是 IoC 容器持有 bean 信息的場所,以後對 bean 的操作都是圍繞這個HashMap 來實現的.
u 然後我們就可以通過 BeanFactory 和 ApplicationContext 來享受到 Spring IOC 的服務了,在使用 IOC 容器的時候,我們注意到除了少量粘合代碼,絕大多數以正確 IoC 風格編寫的應用程序代碼完全不用關心如何到達工廠,因為容器將把這些對象與容器管理的其他對象鉤在一起。基本的策略是把工廠放到已知的地方,最好是放在對預期使用的上下文有意義的地方,以及代碼將實際需要訪問工廠的地方。 Spring 本身提供了對聲明式載入 web 應用程序用法的應用程序上下文,並將其存儲在ServletContext 中的框架實現。具體可以參見以後的文章
在使用 Spring IOC 容器的時候我們還需要區別兩個概念:
Beanfactory 和 Factory bean,其中 BeanFactory 指的是 IOC 容器的編程抽象,比如 ApplicationContext, XmlBeanFactory 等,這些都是 IOC 容器的具體表現,需要使用什麼樣的容器由客戶決定,但 Spring 為我們提供了豐富的選擇。 FactoryBean 只是一個可以在 IOC而容器中被管理的一個 bean,是對各種處理過程和資源使用的抽象,Factory bean 在需要時產生另一個對象,而不返回 FactoryBean本身,我們可以把它看成是一個抽象工廠,對它的調用返回的是工廠生產的產品。所有的 Factory bean 都實現特殊的org.springframework.beans.factory.FactoryBean 接口,當使用容器中 factory bean 的時候,該容器不會返回 factory bean 本身,而是返回其生成的對象。Spring 包括了大部分的通用資源和服務訪問抽象的 Factory bean 的實現,其中包括:對 JNDI 查詢的處理,對代理對象的處理,對事務性代理的處理,對 RMI 代理的處理等,這些我們都可以看成是具體的工廠,看成是SPRING 為我們建立好的工廠。也就是說 Spring 通過使用抽象工廠模式為我們准備了一系列工廠來生產一些特定的對象,免除我們手工重復的工作,我們要使用時只需要在 IOC 容器裡配置好就能很方便的使用了
1、依賴注入發生的時間
當Spring IoC容器完成了Bean定義資源的定位、載入和解析注冊以後,IoC容器中已經管理類Bean定義的相關數據,但是此時IoC容器還沒有對所管理的Bean進行依賴注入,依賴注入在以下兩種情況發生:
(1).用戶第一次通過getBean方法向IoC容索要Bean時,IoC容器觸發依賴注入。
(2).當用戶在Bean定義資源中為<Bean>元素配置了lazy-init屬性,即讓容器在解析注冊Bean定義時進行預實例化,觸發依賴注入。
BeanFactory接口定義了Spring IoC容器的基本功能規范,是Spring IoC容器所應遵守的最底層和最基本的編程規范。BeanFactory接口中定義了幾個getBean方法,就是用戶向IoC容器索取管理的Bean的方法,我們通過分析其子類的具體實現,理解Spring IoC容器在用戶索取Bean時如何完成依賴注入。
在BeanFactory中我們看到getBean(String…)函數,它的具體實現在AbstractBeanFactory中
2、AbstractBeanFactory通過getBean向IoC容器獲取被管理的Bean:
AbstractBeanFactory的getBean相關方法的源碼如下:
1 //獲取IoC容器中指定名稱的Bean 2 public Object getBean(String name) throws BeansException { 3 //doGetBean才是真正向IoC容器獲取被管理Bean的過程 4 return doGetBean(name, null, null, false); 5 } 6 //獲取IoC容器中指定名稱和類型的Bean 7 public <T> T getBean(String name, Class<T> requiredType) throws BeansException { 8 //doGetBean才是真正向IoC容器獲取被管理Bean的過程 9 return doGetBean(name, requiredType, null, false); 10 } 11 //獲取IoC容器中指定名稱和參數的Bean 12 public Object getBean(String name, Object... args) throws BeansException { 13 //doGetBean才是真正向IoC容器獲取被管理Bean的過程 14 return doGetBean(name, null, args, false); 15 } 16 //獲取IoC容器中指定名稱、類型和參數的Bean 17 public <T> T getBean(String name, Class<T> requiredType, Object... args) throws BeansException { 18 //doGetBean才是真正向IoC容器獲取被管理Bean的過程 19 return doGetBean(name, requiredType, args, false); 20 } 21 //真正實現向IoC容器獲取Bean的功能,也是觸發依賴注入功能的地方 22 @SuppressWarnings("unchecked") 23 protected <T> T doGetBean( 24 final String name, final Class<T> requiredType, final Object[] args, boolean typeCheckOnly) 25 throws BeansException { 26 //根據指定的名稱獲取被管理Bean的名稱,剝離指定名稱中對容器的相關依賴 27 //如果指定的是別名,將別名轉換為規范的Bean名稱 28 final String beanName = transformedBeanName(name); 29 Object bean; 30 //先從緩存中取是否已經有被創建過的單態類型的Bean,對於單態模式的Bean整 31 //個IoC容器中只創建一次,不需要重復創建 32 Object sharedInstance = getSingleton(beanName); 33 //IoC容器創建單態模式Bean實例對象 34 if (sharedInstance != null && args == null) { 35 if (logger.isDebugEnabled()) { 36 //如果指定名稱的Bean在容器中已有單態模式的Bean被創建,直接返回 37 //已經創建的Bean 38 if (isSingletonCurrentlyInCreation(beanName)) { 39 logger.debug("Returning eagerly cached instance of singleton bean '" + beanName + 40 "' that is not fully initialized yet - a consequence of a circular reference"); 41 } 42 else { 43 logger.debug("Returning cached instance of singleton bean '" + beanName + "'"); 44 } 45 } 46 //獲取給定Bean的實例對象,主要是完成FactoryBean的相關處理 47 //注意:BeanFactory是管理容器中Bean的工廠,而FactoryBean是 48 //創建創建對象的工廠Bean,兩者之間有區別 49 bean = getObjectForBeanInstance(sharedInstance, name, beanName, null); 50 } 51 else {//緩存沒有正在創建的單態模式Bean 52 //緩存中已經有已經創建的原型模式Bean,但是由於循環引用的問題導致實 53 //例化對象失敗 54 if (isPrototypeCurrentlyInCreation(beanName)) { 55 throw new BeanCurrentlyInCreationException(beanName); 56 } 57 //對IoC容器中是否存在指定名稱的BeanDefinition進行檢查,首先檢查是否 58 //能在當前的BeanFactory中獲取的所需要的Bean,如果不能則委托當��容器 59 //的父級容器去查找,如果還是找不到則沿著容器的繼承體系向父級容器查找 60 BeanFactory parentBeanFactory = getParentBeanFactory(); 61 //當前容器的父級容器存在,且當前容器中不存在指定名稱的Bean 62 if (parentBeanFactory != null && !containsBeanDefinition(beanName)) { 63 //解析指定Bean名稱的原始名稱 64 String nameToLookup = originalBeanName(name); 65 if (args != null) { 66 //委派父級容器根據指定名稱和顯式的參數查找 67 return (T) parentBeanFactory.getBean(nameToLookup, args); 68 } 69 else { 70 //委派父級容器根據指定名稱和類型查找 71 return parentBeanFactory.getBean(nameToLookup, requiredType); 72 } 73 } 74 //創建的Bean是否需要進行類型驗證,一般不需要 75 if (!typeCheckOnly) { 76 //向容器標記指定的Bean已經被創建 77 markBeanAsCreated(beanName); 78 } 79 //根據指定Bean名稱獲取其父級的Bean定義,主要解決Bean繼承時子類 80 //合並父類公共屬性問題 81 final RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName); 82 checkMergedBeanDefinition(mbd, beanName, args); 83 //獲取當前Bean所有依賴Bean的名稱 84 String[] dependsOn = mbd.getDependsOn(); 85 //如果當前Bean有依賴Bean 86 if (dependsOn != null) { 87 for (String dependsOnBean : dependsOn) { 88 //遞歸調用getBean方法,獲取當前Bean的依賴Bean 89 getBean(dependsOnBean); 90 //把被依賴Bean注冊給當前依賴的Bean 91 registerDependentBean(dependsOnBean, beanName); 92 } 93 } 94 //創建單態模式Bean的實例對象 95 if (mbd.isSingleton()) { 96 //這裡使用了一個匿名內部類,創建Bean實例對象,並且注冊給所依賴的對象 97 sharedInstance = getSingleton(beanName, new ObjectFactory() { 98 public Object getObject() throws BeansException { 99 try { 100 //創建一個指定Bean實例對象,如果有父級繼承,則合並子//類和父類的定義 101 return createBean(beanName, mbd, args); 102 } 103 catch (BeansException ex) { 104 //顯式地從容器單態模式Bean緩存中清除實例對象 105 destroySingleton(beanName); 106 throw ex; 107 } 108 } 109 }); 110 //獲取給定Bean的實例對象 111 bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd); 112 } 113 //IoC容器創建原型模式Bean實例對象 114 else if (mbd.isPrototype()) { 115 //原型模式(Prototype)是每次都會創建一個新的對象 116 Object prototypeInstance = null; 117 try { 118 //回調beforePrototypeCreation方法,默認的功能是注冊當前創//建的原型對象 119 beforePrototypeCreation(beanName); 120 //創建指定Bean對象實例 121 prototypeInstance = createBean(beanName, mbd, args); 122 } 123 finally { 124 //回調afterPrototypeCreation方法,默認的功能告訴IoC容器指//定Bean的原型對象不再創建了 125 afterPrototypeCreation(beanName); 126 } 127 //獲取給定Bean的實例對象 128 bean = getObjectForBeanInstance(prototypeInstance, name, beanName, mbd); 129 } 130 //要創建的Bean既不是單態模式,也不是原型模式,則根據Bean定義資源中 131 //配置的生命周期范圍,選擇實例化Bean的合適方法,這種在Web應用程序中 132 //比較常用,如:request、session、application等生命周期 133 else { 134 String scopeName = mbd.getScope(); 135 final Scope scope = this.scopes.get(scopeName); 136 //Bean定義資源中沒有配置生命周期范圍,則Bean定義不合法 137 if (scope == null) { 138 throw new IllegalStateException("No Scope registered for scope '" + scopeName + "'"); 139 } 140 try { 141 //這裡又使用了一個匿名內部類,獲取一個指定生命周期范圍的實例 142 Object scopedInstance = scope.get(beanName, new ObjectFactory() { 143 public Object getObject() throws BeansException { 144 beforePrototypeCreation(beanName); 145 try { 146 return createBean(beanName, mbd, args); 147 } 148 finally { 149 afterPrototypeCreation(beanName); 150 } 151 } 152 }); 153 //獲取給定Bean的實例對象 154 bean = getObjectForBeanInstance(scopedInstance, name, beanName, mbd); 155 } 156 catch (IllegalStateException ex) { 157 throw new BeanCreationException(beanName, 158 "Scope '" + scopeName + "' is not active for the current thread; " + 159 "consider defining a scoped proxy for this bean if you intend to refer to it from a singleton", 160 ex); 161 } 162 } 163 } 164 //對創建的Bean實例對象進行類型檢查 165 if (requiredType != null && bean != null && !requiredType.isAssignableFrom(bean.getClass())) { 166 throw new BeanNotOfRequiredTypeException(name, requiredType, bean.getClass()); 167 } 168 return (T) bean; 169 }
通過上面對向IoC容器獲取Bean方法的分析,我們可以看到在Spring中,如果Bean定義的單態模式(Singleton),則容器在創建之前先從緩存中查找,以確保整個容器中只存在一個實例對象。如果Bean定義的是原型模式(Prototype),則容器每次都會創建一個新的實例對象。除此之外,Bean定義還可以擴展為指定其生命周期范圍。
上面的源碼只是定義了根據Bean定義的模式,采取的不同創建Bean實例對象的策略,具體的Bean實例對象的創建過程由實現了ObejctFactory接口的匿名內部類的createBean方法完成,ObejctFactory使用委派模式,具體的Bean實例創建過程交由其實現類AbstractAutowireCapableBeanFactory完成,我們繼續分析AbstractAutowireCapableBeanFactory的createBean方法的源碼,理解其創建Bean實例的具體實現過程。
3、AbstractAutowireCapableBeanFactory創建Bean實例對象:
AbstractAutowireCapableBeanFactory類實現了ObejctFactory接口,創建容器指定的Bean實例對象,同時還對創建的Bean實例對象進行初始化處理。其創建Bean實例對象的方法源碼如下:
1 //創建Bean實例對象 2 protected Object createBean(final String beanName, final RootBeanDefinition mbd, final Object[] args) 3 throws BeanCreationException { 4 if (logger.isDebugEnabled()) { 5 logger.debug("Creating instance of bean '" + beanName + "'"); 6 } 7 //判斷需要創建的Bean是否可以實例化,即是否可以通過當前的類加載器加載 8 resolveBeanClass(mbd, beanName); 9 //校驗和准備Bean中的方法覆蓋 10 try { 11 mbd.prepareMethodOverrides(); 12 } 13 catch (BeanDefinitionValidationException ex) { 14 throw new BeanDefinitionStoreException(mbd.getResourceDescription(), 15 beanName, "Validation of method overrides failed", ex); 16 } 17 try { 18 //如果Bean配置了初始化前和初始化後的處理器,則試圖返回一個需要創建//Bean的代理對象 19 Object bean = resolveBeforeInstantiation(beanName, mbd); 20 if (bean != null) { 21 return bean; 22 } 23 } 24 catch (Throwable ex) { 25 throw new BeanCreationException(mbd.getResourceDescription(), beanName, 26 "BeanPostProcessor before instantiation of bean failed", ex); 27 } 28 //創建Bean的入口 29 Object beanInstance = doCreateBean(beanName, mbd, args); 30 if (logger.isDebugEnabled()) { 31 logger.debug("Finished creating instance of bean '" + beanName + "'"); 32 } 33 return beanInstance; 34 } 35 //真正創建Bean的方法 36 protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final Object[] args) { 37 //封裝被創建的Bean對象 38 BeanWrapper instanceWrapper = null; 39 if (mbd.isSingleton()){//單態模式的Bean,先從容器中緩存中獲取同名Bean 40 instanceWrapper = this.factoryBeanInstanceCache.remove(beanName); 41 } 42 if (instanceWrapper == null) { 43 //創建實例對象 44 instanceWrapper = createBeanInstance(beanName, mbd, args); 45 } 46 final Object bean = (instanceWrapper != null ? instanceWrapper.getWrappedInstance() : null); 47 //獲取實例化對象的類型 48 Class beanType = (instanceWrapper != null ? instanceWrapper.getWrappedClass() : null); 49 //調用PostProcessor後置處理器 50 synchronized (mbd.postProcessingLock) { 51 if (!mbd.postProcessed) { 52 applyMergedBeanDefinitionPostProcessors(mbd, beanType, beanName); 53 mbd.postProcessed = true; 54 } 55 } 56 // Eagerly cache singletons to be able to resolve circular references 57 //向容器中緩存單態模式的Bean對象,以防循環引用 58 boolean earlySingletonExposure = (mbd.isSingleton() && this.allowCircularReferences && 59 isSingletonCurrentlyInCreation(beanName)); 60 if (earlySingletonExposure) { 61 if (logger.isDebugEnabled()) { 62 logger.debug("Eagerly caching bean '" + beanName + 63 "' to allow for resolving potential circular references"); 64 } 65 //這裡是一個匿名內部類,為了防止循環引用,盡早持有對象的引用 66 addSingletonFactory(beanName, new ObjectFactory() { 67 public Object getObject() throws BeansException { 68 return getEarlyBeanReference(beanName, mbd, bean); 69 } 70 }); 71 } 72 //Bean對象的初始化,依賴注入在此觸發 73 //這個exposedObject在初始化完成之後返回作為依賴注入完成後的Bean 74 Object exposedObject = bean; 75 try { 76 //將Bean實例對象封裝,並且Bean定義中配置的屬性值賦值給實例對象 77 populateBean(beanName, mbd, instanceWrapper); 78 if (exposedObject != null) { 79 //初始化Bean對象 80 exposedObject = initializeBean(beanName, exposedObject, mbd); 81 } 82 } 83 catch (Throwable ex) { 84 if (ex instanceof BeanCreationException && beanName.equals(((BeanCreationException) ex).getBeanName())) { 85 throw (BeanCreationException) ex; 86 } 87 else { 88 throw new BeanCreationException(mbd.getResourceDescription(), beanName, "Initialization of bean failed", ex); 89 } 90 } 91 if (earlySingletonExposure) { 92 //獲取指定名稱的已注冊的單態模式Bean對象 93 Object earlySingletonReference = getSingleton(beanName, false); 94 if (earlySingletonReference != null) { 95 //根據名稱獲取的以注冊的Bean和正在實例化的Bean是同一個 96 if (exposedObject == bean) { 97 //當前實例化的Bean初始化完成 98 exposedObject = earlySingletonReference; 99 } 100 //當前Bean依賴其他Bean,並且當發生循環引用時不允許新創建實例對象 101 else if (!this.allowRawInjectionDespiteWrapping && hasDependentBean(beanName)) { 102 String[] dependentBeans = getDependentBeans(beanName); 103 Set<String> actualDependentBeans = new LinkedHashSet<String>(dependentBeans.length); 104 //獲取當前Bean所依賴的其他Bean 105 for (String dependentBean : dependentBeans) { 106 //對依賴Bean進行類型檢查 107 if (!removeSingletonIfCreatedForTypeCheckOnly(dependentBean)) { 108 actualDependentBeans.add(dependentBean); 109 } 110 } 111 if (!actualDependentBeans.isEmpty()) { 112 throw new BeanCurrentlyInCreationException(beanName, 113 "Bean with name '" + beanName + "' has been injected into other beans [" + 114 StringUtils.collectionToCommaDelimitedString(actualDependentBeans) + 115 "] in its raw version as part of a circular reference, but has eventually been " + 116 "wrapped. This means that said other beans do not use the final version of the " + 117 "bean. This is often the result of over-eager type matching - consider using " + 118 "'getBeanNamesOfType' with the 'allowEagerInit' flag turned off, for example."); 119 } 120 } 121 } 122 } 123 //注冊完成依賴注入的Bean 124 try { 125 registerDisposableBeanIfNecessary(beanName, bean, mbd); 126 } 127 catch (BeanDefinitionValidationException ex) { 128 throw new BeanCreationException(mbd.getResourceDescription(), beanName, "Invalid destruction signature", ex); 129 } 130 return exposedObject; }
通過對方法源碼的分析,我們看到具體的依賴注入實現在以下兩個方法中:
(1).createBeanInstance:生成Bean所包含的java對象實例。
(2).populateBean :對Bean屬性的依賴注入進行處理。
下面繼續分析這兩個方法的代碼實現。
4、createBeanInstance方法創建Bean的java實例對象:
在createBeanInstance方法中,根據指定的初始化策略,使用靜態工廠、工廠方法或者容器的自動裝配特性生成java實例對象,創建對象的源碼如下:
1 //創建Bean的實例對象 2 protected BeanWrapper createBeanInstance(String beanName, RootBeanDefinition mbd, Object[] args) { 3 //檢查確認Bean是可實例化的 4 Class beanClass = resolveBeanClass(mbd, beanName); 5 //使用工廠方法對Bean進行實例化 6 if (beanClass != null && !Modifier.isPublic(beanClass.getModifiers()) && !mbd.isNonPublicAccessAllowed()) { 7 throw new BeanCreationException(mbd.getResourceDescription(), beanName, 8 "Bean class isn't public, and non-public access not allowed: " + beanClass.getName()); 9 } 10 if (mbd.getFactoryMethodName() != null) { 11 //調用工廠方法實例化 12 return instantiateUsingFactoryMethod(beanName, mbd, args); 13 } 14 //使用容器的自動裝配方法進行實例化 15 boolean resolved = false; 16 boolean autowireNecessary = false; 17 if (args == null) { 18 synchronized (mbd.constructorArgumentLock) { 19 if (mbd.resolvedConstructorOrFactoryMethod != null) { 20 resolved = true; 21 autowireNecessary = mbd.constructorArgumentsResolved; 22 } 23 } 24 } 25 if (resolved) { 26 if (autowireNecessary) { 27 //配置了自動裝配屬性,使用容器的自動裝配實例化 28 //容器的自動裝配是根據參數類型匹配Bean的構造方法 29 return autowireConstructor(beanName, mbd, null, null); 30 } 31 else { 32 //使用默認的無參構造方法實例化 33 return instantiateBean(beanName, mbd); 34 } 35 } 36 //使用Bean的構造方法進行實例化 37 Constructor[] ctors = determineConstructorsFromBeanPostProcessors(beanClass, beanName); 38 if (ctors != null || 39 mbd.getResolvedAutowireMode() == RootBeanDefinition.AUTOWIRE_CONSTRUCTOR || 40 mbd.hasConstructorArgumentValues() || !ObjectUtils.isEmpty(args)) { 41 //使用容器的自動裝配特性,調用匹配的構造方法實例化 42 return autowireConstructor(beanName, mbd, ctors, args); 43 } 44 //使用默認的無參構造方法實例化 45 return instantiateBean(beanName, mbd); 46 } 47 //使用默認的無參構造方法實例化Bean對象 48 protected BeanWrapper instantiateBean(final String beanName, final RootBeanDefinition mbd) { 49 try { 50 Object beanInstance; 51 final BeanFactory parent = this; 52 //獲取系統的安全管理接口,JDK標准的安全管理API 53 if (System.getSecurityManager() != null) { 54 //這裡是一個匿名內置類,根據實例化策略創建實例對象 55 beanInstance = AccessController.doPrivileged(new PrivilegedAction<Object>() { 56 public Object run() { 57 return getInstantiationStrategy().instantiate(mbd, beanName, parent); 58 } 59 }, getAccessControlContext()); 60 } 61 else { 62 //將實例化的對象封裝起來 63 beanInstance = getInstantiationStrategy().instantiate(mbd, beanName, parent); 64 } 65 BeanWrapper bw = new BeanWrapperImpl(beanInstance); 66 initBeanWrapper(bw); 67 return bw; 68 } 69 catch (Throwable ex) { 70 throw new BeanCreationException(mbd.getResourceDescription(), beanName, "Instantiation of bean failed", ex); 71 } 72 }
經過對上面的代碼分析,我們可以看出,對使用工廠方法和自動裝配特性的Bean的實例化相當比較清楚,調用相應的工廠方法或者參數匹配的構造方法即可完成實例化對象的工作,但是對於我們最常使用的默認無參構造方法就需要使用相應的初始化策略(JDK的反射機制或者CGLIB)來進行初始化了,在方法getInstantiationStrategy().instantiate中就具體實現類使用初始策略實例化對象。
5、SimpleInstantiationStrategy類使用默認的無參構造方法創建Bean實例化對象:
在使用默認的無參構造方法創建Bean的實例化對象時,方法getInstantiationStrategy().instantiate調用了SimpleInstantiationStrategy類中的實例化Bean的方法,其源碼如下:
1 //使用初始化策略實例化Bean對象 2 public Object instantiate(RootBeanDefinition beanDefinition, String beanName, BeanFactory owner) { 3 //如果Bean定義中沒有方法覆蓋,則就不需要CGLIB父類類的方法 4 if (beanDefinition.getMethodOverrides().isEmpty()) { 5 Constructor<?> constructorToUse; 6 synchronized (beanDefinition.constructorArgumentLock) { 7 //獲取對象的構造方法或工廠方法 8 constructorToUse = (Constructor<?>) beanDefinition.resolvedConstructorOrFactoryMethod; 9 //如果沒有構造方法且沒有工廠方法 10 if (constructorToUse == null) { 11 //使用JDK的反射機制,判斷要實例化的Bean是否是接口 12 final Class clazz = beanDefinition.getBeanClass(); 13 if (clazz.isInterface()) { 14 throw new BeanInstantiationException(clazz, "Specified class is an interface"); 15 } 16 try { 17 if (System.getSecurityManager() != null) { 18 //這裡是一個匿名內置類,使用反射機制獲取Bean的構造方法 19 constructorToUse = AccessController.doPrivileged(new PrivilegedExceptionAction<Constructor>() { 20 public Constructor run() throws Exception { 21 return clazz.getDeclaredConstructor((Class[]) null); 22 } 23 }); 24 } 25 else { 26 constructorToUse = clazz.getDeclaredConstructor((Class[]) null); 27 } 28 beanDefinition.resolvedConstructorOrFactoryMethod = constructorToUse; 29 } 30 catch (Exception ex) { 31 throw new BeanInstantiationException(clazz, "No default constructor found", ex); 32 } 33 } 34 } 35 //使用BeanUtils實例化,通過反射機制調用”構造方法.newInstance(arg)”來進行實例化 36 return BeanUtils.instantiateClass(constructorToUse); 37 } 38 else { 39 //使用CGLIB來實例化對象 40 return instantiateWithMethodInjection(beanDefinition, beanName, owner); 41 } }
通過上面的代碼分析,我們看到了如果Bean有方法被覆蓋了,則使用JDK的反射機制進行實例化,否則,使用CGLIB進行實例化。
instantiateWithMethodInjection方法調用SimpleInstantiationStrategy的子類CglibSubclassingInstantiationStrategy使用CGLIB來進行初始化,其源碼如下:
1 //使用CGLIB進行Bean對象實例化 2 public Object instantiate(Constructor ctor, Object[] args) { 3 //CGLIB中的類 4 Enhancer enhancer = new Enhancer(); 5 //將Bean本身作為其基類 6 enhancer.setSuperclass(this.beanDefinition.getBeanClass()); 7 enhancer.setCallbackFilter(new CallbackFilterImpl()); 8 enhancer.setCallbacks(new Callback[] { 9 NoOp.INSTANCE, 10 new LookupOverrideMethodInterceptor(), 11 new ReplaceOverrideMethodInterceptor() 12 }); 13 //使用CGLIB的create方法生成實例對象 14 return (ctor == null) ? 15 enhancer.create() : 16 enhancer.create(ctor.getParameterTypes(), args); 17 }
CGLIB是一個常用的字節碼生成器的類庫,它提供了一系列API實現java字節碼的生成和轉換功能。我們在學習JDK的動態代理時都知道,JDK的動態代理只能針對接口,如果一個類沒有實現任何接口,要對其進行動態代理只能使用CGLIB。
6、populateBean方法對Bean屬性的依賴注入:
在第3步的分析中我們已經了解到Bean的依賴注入分為以下兩個過程:
(1).createBeanInstance:生成Bean所包含的java對象實例。
(2).populateBean :對Bean屬性的依賴注入進行處理。
第4、5步中我們已經分析了容器初始化生成Bean所包含的Java實例對象的過程,現在我們繼續分析生成對象後,Spring IoC容器是如何將Bean的屬性依賴關系注入Bean實例對象中並設置好的,屬性依賴注入的代碼如下:
1 //將Bean屬性設置到生成的實例對象上 2 protected void populateBean(String beanName, AbstractBeanDefinition mbd, BeanWrapper bw) { 3 //獲取容器在解析Bean定義資源時為BeanDefiniton中設置的屬性值 4 PropertyValues pvs = mbd.getPropertyValues(); 5 //實例對象為null 6 if (bw == null) { 7 //屬性值不為空 8 if (!pvs.isEmpty()) { 9 throw new BeanCreationException( 10 mbd.getResourceDescription(), beanName, "Cannot apply property values to null instance"); 11 } 12 else { 13 //實例對象為null,屬性值也為空,不需要設置屬性值,直接返回 14 return; 15 } 16 } 17 //在設置屬性之前調用Bean的PostProcessor後置處理器 18 boolean continueWithPropertyPopulation = true; 19 if (!mbd.isSynthetic() && hasInstantiationAwareBeanPostProcessors()) { 20 for (BeanPostProcessor bp : getBeanPostProcessors()) { 21 if (bp instanceof InstantiationAwareBeanPostProcessor) { 22 InstantiationAwareBeanPostProcessor ibp = (InstantiationAwareBeanPostProcessor) bp; 23 if (!ibp.postProcessAfterInstantiation(bw.getWrappedInstance(), beanName)) { 24 continueWithPropertyPopulation = false; 25 break; 26 } 27 } 28 } 29 } 30 if (!continueWithPropertyPopulation) { 31 return; 32 } 33 //依賴注入開始,首先處理autowire自動裝配的注入 34 if (mbd.getResolvedAutowireMode() == RootBeanDefinition.AUTOWIRE_BY_NAME || 35 mbd.getResolvedAutowireMode() == RootBeanDefinition.AUTOWIRE_BY_TYPE) { 36 MutablePropertyValues newPvs = new MutablePropertyValues(pvs); 37 //對autowire自動裝配的處理,根據Bean名稱自動裝配注入 38 if (mbd.getResolvedAutowireMode() == RootBeanDefinition.AUTOWIRE_BY_NAME) { 39 autowireByName(beanName, mbd, bw, newPvs); 40 } 41 //根據Bean類型自動裝配注入 42 if (mbd.getResolvedAutowireMode() == RootBeanDefinition.AUTOWIRE_BY_TYPE) { 43 autowireByType(beanName, mbd, bw, newPvs); 44 } 45 pvs = newPvs; 46 } 47 //檢查容器是否持有用於處理單態模式Bean關閉時的後置處理器 48 boolean hasInstAwareBpps = hasInstantiationAwareBeanPostProcessors(); 49 //Bean實例對象沒有依賴,即沒有繼承基類 50 boolean needsDepCheck = (mbd.getDependencyCheck() != RootBeanDefinition.DEPENDENCY_CHECK_NONE); 51 if (hasInstAwareBpps || needsDepCheck) { 52 //從實例對象中提取屬性描述符 53 PropertyDescriptor[] filteredPds = filterPropertyDescriptorsForDependencyCheck(bw); 54 if (hasInstAwareBpps) { 55 for (BeanPostProcessor bp : getBeanPostProcessors()) { 56 if (bp instanceof InstantiationAwareBeanPostProcessor) { 57 InstantiationAwareBeanPostProcessor ibp = (InstantiationAwareBeanPostProcessor) bp; 58 //使用BeanPostProcessor處理器處理屬性值 59 pvs = ibp.postProcessPropertyValues(pvs, filteredPds, bw.getWrappedInstance(), beanName); 60 if (pvs == null) { 61 return; 62 } 63 } 64 } 65 } 66 if (needsDepCheck) { 67 //為要設置的屬性進行依賴檢查 68 checkDependencies(beanName, mbd, filteredPds, pvs); 69 } 70 } 71 //對屬性進行注入 72 applyPropertyValues(beanName, mbd, bw, pvs); 73 } 74 //解析並注入依賴屬性的過程 75 protected void applyPropertyValues(String beanName, BeanDefinition mbd, BeanWrapper bw, PropertyValues pvs) { 76 if (pvs == null || pvs.isEmpty()) { 77 return; 78 } 79 //封裝屬性值 80 MutablePropertyValues mpvs = null; 81 List<PropertyValue> original; 82 if (System.getSecurityManager()!= null) { 83 if (bw instanceof BeanWrapperImpl) { 84 //設置安全上下文,JDK安全機制 85 ((BeanWrapperImpl) bw).setSecurityContext(getAccessControlContext()); 86 } 87 } 88 if (pvs instanceof MutablePropertyValues) { 89 mpvs = (MutablePropertyValues) pvs; 90 //屬性值已經轉換 91 if (mpvs.isConverted()) { 92 try { 93 //為實例化對象設置屬性值 94 bw.setPropertyValues(mpvs); 95 return; 96 } 97 catch (BeansException ex) { 98 throw new BeanCreationException( 99 mbd.getResourceDescription(), beanName, "Error setting property values", ex); 100 } 101 } 102 //獲取屬性值對象的原始類型值 103 original = mpvs.getPropertyValueList(); 104 } 105 else { 106 original = Arrays.asList(pvs.getPropertyValues()); 107 } 108 //獲取用戶自定義的類型轉換 109 TypeConverter converter = getCustomTypeConverter(); 110 if (converter == null) { 111 converter = bw; 112 } 113 //創建一個Bean定義屬性值解析器,將Bean定義中的屬性值解析為Bean實例對象 114 //的實際值 115 BeanDefinitionValueResolver valueResolver = new BeanDefinitionValueResolver(this, beanName, mbd, converter); 116 //為屬性的解析值創建一個拷貝,將拷貝的數據注入到實例對象中 117 List<PropertyValue> deepCopy = new ArrayList<PropertyValue>(original.size()); 118 boolean resolveNecessary = false; 119 for (PropertyValue pv : original) { 120 //屬性值不需要轉換 121 if (pv.isConverted()) { 122 deepCopy.add(pv); 123 } 124 //屬性值需要轉換 125 else { 126 String propertyName = pv.getName(); 127 //原始的屬性值,即轉換之前的屬性值 128 Object originalValue = pv.getValue(); 129 //轉換屬性值,例如將引用轉換為IoC容器中實例化對象引用 130 Object resolvedValue = valueResolver.resolveValueIfNecessary(pv, originalValue); 131 //轉換之後的屬性值 132 Object convertedValue = resolvedValue; 133 //屬性值是否可以轉換 134 boolean convertible = bw.isWritableProperty(propertyName) && 135 !PropertyAccessorUtils.isNestedOrIndexedProperty(propertyName); 136 if (convertible) { 137 //使用用戶自定義的類型轉換器轉換屬性值 138 convertedValue = convertForProperty(resolvedValue, propertyName, bw, converter); 139 } 140 //存儲轉換後的屬性值,避免每次屬性注入時的轉換工作 141 if (resolvedValue == originalValue) { 142 if (convertible) { 143 //設置屬性轉換之後的值 144 pv.setConvertedValue(convertedValue); 145 } 146 deepCopy.add(pv); 147 } 148 //屬性是可轉換的,且屬性原始值是字符串類型,且屬性的原始類型值不是 149 //動態生成的字符串,且屬性的原始值不是集合或者數組類型 150 else if (convertible && originalValue instanceof TypedStringValue && 151 !((TypedStringValue) originalValue).isDynamic() && 152 !(convertedValue instanceof Collection || ObjectUtils.isArray(convertedValue))) { 153 pv.setConvertedValue(convertedValue); 154 deepCopy.add(pv); 155 } 156 else { 157 resolveNecessary = true; 158 //重新封裝屬性的值 159 deepCopy.add(new PropertyValue(pv, convertedValue)); 160 } 161 } 162 } 163 if (mpvs != null && !resolveNecessary) { 164 //標記屬性值已經轉換過 165 mpvs.setConverted(); 166 } 167 //進行屬性依賴注入 168 try { 169 bw.setPropertyValues(new MutablePropertyValues(deepCopy)); 170 } 171 catch (BeansException ex) { 172 throw new BeanCreationException( 173 mbd.getResourceDescription(), beanName, "Error setting property values", ex); 174 } }
分析上述代碼,我們可以看出,對屬性的注入過程分以下兩種情況:
(1).屬性值類型不需要轉換時,不需要解析屬性值,直接准備進行依賴注入。
(2).屬性值需要進行類型轉換時,如對其他對象的引用等,首先需要解析屬性值,然後對解析後的屬性值進行依賴注入。
對屬性值的解析是在BeanDefinitionValueResolver類中的resolveValueIfNecessary方法中進行的,對屬性值的依賴注入是通過bw.setPropertyValues方法實現的,在分析屬性值的依賴注入之前,我們先分析一下對屬性值的解析過程。
7、BeanDefinitionValueResolver解析屬性值:
當容器在對屬性進行依賴注入時,如果發現屬性值需要進行類型轉換,如屬性值是容器中另一個Bean實例對象的引用,則容器首先需要根據屬性值解析出所引用的對象,然後才能將該引用對象注入到目標實例對象的屬性上去,對屬性進行解析的由resolveValueIfNecessary方法實現,其源碼如下:
1 //解析屬性值,對注入類型進行轉換 2 public Object resolveValueIfNecessary(Object argName, Object value) { 3 //對引用類型的屬性進行解析 4 if (value instanceof RuntimeBeanReference) { 5 RuntimeBeanReference ref = (RuntimeBeanReference) value; 6 //調用引用類型屬性的解析方法 7 return resolveReference(argName, ref); 8 } 9 //對屬性值是引用容器中另一個Bean名稱的解析 10 else if (value instanceof RuntimeBeanNameReference) { 11 String refName = ((RuntimeBeanNameReference) value).getBeanName(); 12 refName = String.valueOf(evaluate(refName)); 13 //從容器中獲取指定名稱的Bean 14 if (!this.beanFactory.containsBean(refName)) { 15 throw new BeanDefinitionStoreException( 16 "Invalid bean name '" + refName + "' in bean reference for " + argName); 17 } 18 return refName; 19 } 20 //對Bean類型屬性的解析,主要是Bean中的內部類 21 else if (value instanceof BeanDefinitionHolder) { 22 BeanDefinitionHolder bdHolder = (BeanDefinitionHolder) value; 23 return resolveInnerBean(argName, bdHolder.getBeanName(), bdHolder.getBeanDefinition()); 24 } 25 else if (value instanceof BeanDefinition) { 26 BeanDefinition bd = (BeanDefinition) value; 27 return resolveInnerBean(argName, "(inner bean)", bd); 28 } 29 //對集合數組類型的屬性解析 30 else if (value instanceof ManagedArray) { 31 ManagedArray array = (ManagedArray) value; 32 //獲取數組的類型 33 Class elementType = array.resolvedElementType; 34 if (elementType == null) { 35 //獲取數組元素的類型 36 String elementTypeName = array.getElementTypeName(); 37 if (StringUtils.hasText(elementTypeName)) { 38 try { 39 //使用反射機制創建指定類型的對象 40 elementType = ClassUtils.forName(elementTypeName, this.beanFactory.getBeanClassLoader()); 41 array.resolvedElementType = elementType; 42 } 43 catch (Throwable ex) { 44 throw new BeanCreationException( 45 this.beanDefinition.getResourceDescription(), this.beanName, 46 "Error resolving array type for " + argName, ex); 47 } 48 } 49 //沒有獲取到數組的類型,也沒有獲取到數組元素的類型,則直接設置數 50 //組的類型為Object 51 else { 52 elementType = Object.class; 53 } 54 } 55 //創建指定類型的數組 56 return resolveManagedArray(argName, (List<?>) value, elementType); 57 } 58 //解析list類型的屬性值 59 else if (value instanceof ManagedList) { 60 return resolveManagedList(argName, (List<?>) value); 61 } 62 //解析set類型的屬性值 63 else if (value instanceof ManagedSet) { 64 return resolveManagedSet(argName, (Set<?>) value); 65 } 66 //解析map類型的屬性值 67 else if (value instanceof ManagedMap) { 68 return resolveManagedMap(argName, (Map<?, ?>) value); 69 } 70 //解析props類型的屬性值,props其實就是key和value均為字符串的map 71 else if (value instanceof ManagedProperties) { 72 Properties original = (Properties) value; 73 //創建一個拷貝,用於作為解析後的返回值 74 Properties copy = new Properties(); 75 for (Map.Entry propEntry : original.entrySet()) { 76 Object propKey = propEntry.getKey(); 77 Object propValue = propEntry.getValue(); 78 if (propKey instanceof TypedStringValue) { 79 propKey = evaluate((TypedStringValue) propKey); 80 } 81 if (propValue instanceof TypedStringValue) { 82 propValue = evaluate((TypedStringValue) propValue); 83 } 84 copy.put(propKey, propValue); 85 } 86 return copy; 87 } 88 //解析字符串類型的屬性值 89 else if (value instanceof TypedStringValue) { 90 TypedStringValue typedStringValue = (TypedStringValue) value; 91 Object valueObject = evaluate(typedStringValue); 92 try { 93 //獲取屬性的目標類型 94 Class<?> resolvedTargetType = resolveTargetType(typedStringValue); 95 if (resolvedTargetType != null) { 96 //對目標類型的屬性進行解析,遞歸調用 97 return this.typeConverter.convertIfNecessary(valueObject, resolvedTargetType); 98 } 99 //沒有獲取到屬性的目標對象,則按Object類型返回 100 else { 101 return valueObject; 102 } 103 } 104 catch (Throwable ex) { 105 throw new BeanCreationException( 106 this.beanDefinition.getResourceDescription(), this.beanName, 107 "Error converting typed String value for " + argName, ex); 108 } 109 } 110 else { 111 return evaluate(value); 112 } 113 } 114 //解析引用類型的屬性值 115 private Object resolveReference(Object argName, RuntimeBeanReference ref) { 116 try { 117 //獲取引用的Bean名稱 118 String refName = ref.getBeanName(); 119 refName = String.valueOf(evaluate(refName)); 120 //如果引用的對象在父類容器中,則從父類容器中獲取指定的引用對象 121 if (ref.isToParent()) { 122 if (this.beanFactory.getParentBeanFactory() == null) { 123 throw new BeanCreationException( 124 this.beanDefinition.getResourceDescription(), this.beanName, 125 "Can't resolve reference to bean '" + refName + 126 "' in parent factory: no parent factory available"); 127 } 128 return this.beanFactory.getParentBeanFactory().getBean(refName); 129 } 130 //從當前的容器中獲取指定的引用Bean對象,如果指定的Bean沒有被實例化 131 //則會遞歸觸發引用Bean的初始化和依賴注入 132 else { 133 Object bean = this.beanFactory.getBean(refName); 134 //將當前實例化對象的依賴引用對象 135 this.beanFactory.registerDependentBean(refName, this.beanName); 136 return bean; 137 } 138 } 139 catch (BeansException ex) { 140 throw new BeanCreationException( 141 this.beanDefinition.getResourceDescription(), this.beanName, 142 "Cannot resolve reference to bean '" + ref.getBeanName() + "' while setting " + argName, ex); 143 } 144 } 145 //解析array類型的屬性 146 private Object resolveManagedArray(Object argName, List<?> ml, Class elementType) { 147 //創建一個指定類型的數組,用於存放和返回解析後的數組 148 Object resolved = Array.newInstance(elementType, ml.size()); 149 for (int i = 0; i < ml.size(); i++) { 150 //遞歸解析array的每一個元素,並將解析後的值設置到resolved數組中,索引為i 151 Array.set(resolved, i, 152 resolveValueIfNecessary(new KeyedArgName(argName, i), ml.get(i))); 153 } 154 return resolved; 155 } 156 //解析list類型的屬性 157 private List resolveManagedList(Object argName, List<?> ml) { 158 List<Object> resolved = new ArrayList<Object>(ml.size()); 159 for (int i = 0; i < ml.size(); i++) { 160 //遞歸解析list的每一個元素 161 resolved.add( 162 resolveValueIfNecessary(new KeyedArgName(argName, i), ml.get(i))); 163 } 164 return resolved; 165 } 166 //解析set類型的屬性 167 private Set resolveManagedSet(Object argName, Set<?> ms) { 168 Set<Object> resolved = new LinkedHashSet<Object>(ms.size()); 169 int i = 0; 170 //遞歸解析set的每一個元素 171 for (Object m : ms) { 172 resolved.add(resolveValueIfNecessary(new KeyedArgName(argName, i), m)); 173 i++; 174 } 175 return resolved; 176 } 177 //解析map類型的屬性 178 private Map resolveManagedMap(Object argName, Map<?, ?> mm) { 179 Map<Object, Object> resolved = new LinkedHashMap<Object, Object>(mm.size()); 180 //遞歸解析map中每一個元素的key和value 181 for (Map.Entry entry : mm.entrySet()) { 182 Object resolvedKey = resolveValueIfNecessary(argName, entry.getKey()); 183 Object resolvedValue = resolveValueIfNecessary( 184 new KeyedArgName(argName, entry.getKey()), entry.getValue()); 185 resolved.put(resolvedKey, resolvedValue); 186 } 187 return resolved; 188 }
通過上面的代碼分析,我們明白了Spring是如何將引用類型,內部類以及集合類型等屬性進行解析的,屬性值解析完成後就可以進行依賴注入了,依賴注入的過程就是Bean對象實例設置到它所依賴的Bean對象屬性上去,在第7步中我們已經說過,依賴注入是通過bw.setPropertyValues方法實現的,該方法也使用了委托模式,在BeanWrapper接口中至少定義了方法聲明,依賴注入的具體實現交由其實現類BeanWrapperImpl來完成,下面我們就分析依BeanWrapperImpl中賴注入相關的源碼。
8、BeanWrapperImpl對Bean屬性的依賴注入:
BeanWrapperImpl類主要是對容器中完成初始化的Bean實例對象進行屬性的依賴注入,即把Bean對象設置到它所依賴的另一個Bean的屬性中去,依賴注入的相關源碼如下:
1 //實現屬性依賴注入功能 2 private void setPropertyValue(PropertyTokenHolder tokens, PropertyValue pv) throws BeansException { 3 //PropertyTokenHolder主要保存屬性的名稱、路徑,以及集合的size等信息 4 String propertyName = tokens.canonicalName; 5 String actualName = tokens.actualName; 6 //keys是用來保存集合類型屬性的size 7 if (tokens.keys != null) { 8 //將屬性信息拷貝 9 PropertyTokenHolder getterTokens = new PropertyTokenHolder(); 10 getterTokens.canonicalName = tokens.canonicalName; 11 getterTokens.actualName = tokens.actualName; 12 getterTokens.keys = new String[tokens.keys.length - 1]; 13 System.arraycopy(tokens.keys, 0, getterTokens.keys, 0, tokens.keys.length - 1); 14 Object propValue; 15 try { 16 //獲取屬性值,該方法內部使用JDK的內省( Introspector)機制,調用屬性//的getter(readerMethod)方法,獲取屬性的值 17 propValue = getPropertyValue(getterTokens); 18 } 19 catch (NotReadablePropertyException ex) { 20 throw new NotWritablePropertyException(getRootClass(), this.nestedPath + propertyName, 21 "Cannot access indexed value in property referenced " + 22 "in indexed property path '" + propertyName + "'", ex); 23 } 24 //獲取集合類型屬性的長度 25 String key = tokens.keys[tokens.keys.length - 1]; 26 if (propValue == null) { 27 throw new NullValueInNestedPathException(getRootClass(), this.nestedPath + propertyName, 28 "Cannot access indexed value in property referenced " + 29 "in indexed property path '" + propertyName + "': returned null"); 30 } 31 //注入array類型的屬性值 32 else if (propValue.getClass().isArray()) { 33 //獲取屬性的描述符 34 PropertyDescriptor pd = getCachedIntrospectionResults().getPropertyDescriptor(actualName); 35 //獲取數組的類型 36 Class requiredType = propValue.getClass().getComponentType(); 37 //獲取數組的長度 38 int arrayIndex = Integer.parseInt(key); 39 Object oldValue = null; 40 try { 41 //獲取數組以前初始化的值 42 if (isExtractOldValueForEditor()) { 43 oldValue = Array.get(propValue, arrayIndex); 44 } 45 //將屬性的值賦值給數組中的元素 46 Object convertedValue = convertIfNecessary(propertyName, oldValue, pv.getValue(), requiredType, 47 new PropertyTypeDescriptor(pd, new MethodParameter(pd.getReadMethod(), -1), requiredType)); 48 Array.set(propValue, arrayIndex, convertedValue); 49 } 50 catch (IndexOutOfBoundsException ex) { 51 throw new InvalidPropertyException(getRootClass(), this.nestedPath + propertyName, 52 "Invalid array index in property path '" + propertyName + "'", ex); 53 } 54 } 55 //注入list類型的屬性值 56 else if (propValue instanceof List) { 57 PropertyDescriptor pd = getCachedIntrospectionResults().getPropertyDescriptor(actualName); 58 //獲取list集合的類型 59 Class requiredType = GenericCollectionTypeResolver.getCollectionReturnType( 60 pd.getReadMethod(), tokens.keys.length); 61 List list = (List) propValue; 62 //獲取list集合的size 63 int index = Integer.parseInt(key); 64 Object oldValue = null; 65 if (isExtractOldValueForEditor() && index < list.size()) { 66 oldValue = list.get(index); 67 } 68 //獲取list解析後的屬性值 69 Object convertedValue = convertIfNecessary(propertyName, oldValue, pv.getValue(), requiredType, 70 new PropertyTypeDescriptor(pd, new MethodParameter(pd.getReadMethod(), -1), requiredType)); 71 if (index < list.size()) { 72 //為list屬性賦值 73 list.set(index, convertedValue); 74 } 75 //如果list的長度大於屬性值的長度,則多余的元素賦值為null 76 else if (index >= list.size()) { 77 for (int i = list.size(); i < index; i++) { 78 try { 79 list.add(null); 80 } 81 catch (NullPointerException ex) { 82 throw new InvalidPropertyException(getRootClass(), this.nestedPath + propertyName, 83 "Cannot set element with index " + index + " in List of size " + 84 list.size() + ", accessed using property path '" + propertyName + 85 "': List does not support filling up gaps with null elements"); 86 } 87 } 88 list.add(convertedValue); 89 } 90 } 91 //注入map類型的屬性值 92 else if (propValue instanceof Map) { 93 PropertyDescriptor pd = getCachedIntrospectionResults().getPropertyDescriptor(actualName); 94 //獲取map集合key的類型 95 Class mapKeyType = GenericCollectionTypeResolver.getMapKeyReturnType( 96 pd.getReadMethod(), tokens.keys.length); 97 //獲取map集合value的類型 98 Class mapValueType = GenericCollectionTypeResolver.getMapValueReturnType( 99 pd.getReadMethod(), tokens.keys.length); 100 Map map = (Map) propValue; 101 //解析map類型屬性key值 102 Object convertedMapKey = convertIfNecessary(null, null, key, mapKeyType, 103 new PropertyTypeDescriptor(pd, new MethodParameter(pd.getReadMethod(), -1), mapKeyType)); 104 Object oldValue = null; 105 if (isExtractOldValueForEditor()) { 106 oldValue = map.get(convertedMapKey); 107 } 108 //解析map類型屬性value值 109 Object convertedMapValue = convertIfNecessary( 110 propertyName, oldValue, pv.getValue(), mapValueType, 111 new TypeDescriptor(new MethodParameter(pd.getReadMethod(), -1, tokens.keys.length + 1))); 112 //將解析後的key和value值賦值給map集合屬性 113 map.put(convertedMapKey, convertedMapValue); 114 } 115 else { 116 throw new InvalidPropertyException(getRootClass(), this.nestedPath + propertyName, 117 "Property referenced in indexed property path '" + propertyName + 118 "' is neither an array nor a List nor a Map; returned value was [" + pv.getValue() + "]"); 119 } 120 } 121 //對非集合類型的屬性注入 122 else { 123 PropertyDescriptor pd = pv.resolvedDescriptor; 124 if (pd == null || !pd.getWriteMethod().getDeclaringClass().isInstance(this.object)) { 125 pd = getCachedIntrospectionResults().getPropertyDescriptor(actualName); 126 //無法獲取到屬性名或者屬性沒有提供setter(寫方法)方法 127 if (pd == null || pd.getWriteMethod() == null) { 128 //如果屬性值是可選的,即不是必須的,則忽略該屬性值 129 if (pv.isOptional()) { 130 logger.debug("Ignoring optional value for property '" + actualName + 131 "' - property not found on bean class [" + getRootClass().getName() + "]"); 132 return; 133 } 134 //如果屬性值是必須的,則拋出無法給屬性賦值,因為每天提供setter方法異常 135 else { 136 PropertyMatches matches = PropertyMatches.forProperty(propertyName, getRootClass()); 137 throw new NotWritablePropertyException( 138 getRootClass(), this.nestedPath + propertyName, 139 matches.buildErrorMessage(), matches.getPossibleMatches()); 140 } 141 } 142 pv.getOriginalPropertyValue().resolvedDescriptor = pd; 143 } 144 Object oldValue = null; 145 try { 146 Object originalValue = pv.getValue(); 147 Object valueToApply = originalValue; 148 if (!Boolean.FALSE.equals(pv.conversionNecessary)) { 149 if (pv.isConverted()) { 150 valueToApply = pv.getConvertedValue(); 151 } 152 else { 153 if (isExtractOldValueForEditor() && pd.getReadMethod() != null) { 154 //獲取屬性的getter方法(讀方法),JDK內省機制 155 final Method readMethod = pd.getReadMethod(); 156 //如果屬性的getter方法不是public訪問控制權限的,即訪問控制權限比較嚴格, 157 //則使用JDK的反射機制強行訪問非public的方法(暴力讀取屬性值) 158 if (!Modifier.isPublic(readMethod.getDeclaringClass().getModifiers()) && 159 !readMethod.isAccessible()) { 160 if (System.getSecurityManager()!= null) { 161 //匿名內部類,根據權限修改屬性的讀取控制限制 162 AccessController.doPrivileged(new PrivilegedAction<Object>() { 163 public Object run() { 164 readMethod.setAccessible(true); 165 return null; 166 } 167 }); 168 } 169 else { 170 readMethod.setAccessible(true); 171 } 172 } 173 try { 174 //屬性沒有提供getter方法時,調用潛在的讀取屬性值//的方法,獲取屬性值 175 if (System.getSecurityManager() != null) { 176 oldValue = AccessController.doPrivileged(new PrivilegedExceptionAction<Object>() { 177 public Object run() throws Exception { 178 return readMethod.invoke(object); 179 } 180 }, acc); 181 } 182 else { 183 oldValue = readMethod.invoke(object); 184 } 185 } 186 catch (Exception ex) { 187 if (ex instanceof PrivilegedActionException) { 188 ex = ((PrivilegedActionException) ex).getException(); 189 } 190 if (logger.isDebugEnabled()) { 191 logger.debug("Could not read previous value of property '" + 192 this.nestedPath + propertyName + "'", ex); 193 } 194 } 195 } 196 //設置屬性的注入值 197 valueToApply = convertForProperty(propertyName, oldValue, originalValue, pd); 198 } 199 pv.getOriginalPropertyValue().conversionNecessary = (valueToApply != originalValue); 200 } 201 //根據JDK的內省機制,獲取屬性的setter(寫方法)方法 202 final Method writeMethod = (pd instanceof GenericTypeAwarePropertyDescriptor ? 203 ((GenericTypeAwarePropertyDescriptor) pd).getWriteMethodForActualAccess() : 204 pd.getWriteMethod()); 205 //如果屬性的setter方法是非public,即訪問控制權限比較嚴格,則使用JDK的反射機制, 206 //強行設置setter方法可訪問(暴力為屬性賦值) 207 if (!Modifier.isPublic(writeMethod.getDeclaringClass().getModifiers()) && !writeMethod.isAccessible()) { 208 //如果使用了JDK的安全機制,則需要權限驗證 209 if (System.getSecurityManager()!= null) { 210 AccessController.doPrivileged(new PrivilegedAction<Object>() { 211 public Object run() { 212 writeMethod.setAccessible(true); 213 return null; 214 } 215 }); 216 } 217 else { 218 writeMethod.setAccessible(true); 219 } 220 } 221 final Object value = valueToApply; 222 if (System.getSecurityManager() != null) { 223 try { 224 //將屬性值設置到屬性上去 225 AccessController.doPrivileged(new PrivilegedExceptionAction<Object>() { 226 public Object run() throws Exception { 227 writeMethod.invoke(object, value); 228 return null; 229 } 230 }, acc); 231 } 232 catch (PrivilegedActionException ex) { 233 throw ex.getException(); 234 } 235 } 236 else { 237 writeMethod.invoke(this.object, value); 238 } 239 } 240 catch (TypeMismatchException ex) { 241 throw ex; 242 } 243 catch (InvocationTargetException ex) { 244 PropertyChangeEvent propertyChangeEvent = 245 new PropertyChangeEvent(this.rootObject, this.nestedPath + propertyName, oldValue, pv.getValue()); 246 if (ex.getTargetException() instanceof ClassCastException) { 247 throw new TypeMismatchException(propertyChangeEvent, pd.getPropertyType(), ex.getTargetException()); 248 } 249 else { 250 throw new MethodInvocationException(propertyChangeEvent, ex.getTargetException()); 251 } 252 } 253 catch (Exception ex) { 254 PropertyChangeEvent pce = 255 new PropertyChangeEvent(this.rootObject, this.nestedPath + propertyName, oldValue, pv.getValue()); 256 throw new MethodInvocationException(pce, ex); 257 } 258 } }
通過對上面注入依賴代碼的分析,我們已經明白了Spring IoC容器是如何將屬性的值注入到Bean實例對象中去的:
(1).對於集合類型的屬性,將其屬性值解析為目標類型的集合後直接賦值給屬性。
(2).對於非集合類型的屬性,大量使用了JDK的反射和內省機制,通過屬性的getter方法(reader method)獲取指定屬性注入以前的值,同時調用屬性的setter方法(writer method)為屬性設置注入後的值。看到這裡相信很多人都明白了Spring的setter注入原理。
至此Spring IoC容器對Bean定義資源文件的定位,載入、解析和依賴注入已經全部分析完畢,現在Spring IoC容器中管理了一系列靠依賴關系聯系起來的Bean,程序不需要應用自己手動創建所需的對象,Spring IoC容器會在我們使用的時候自動為我們創建,並且為我們注入好相關的依賴,這就是Spring核心功能的控制反轉和依賴注入的相關功能。
1、介紹
通過前面4篇文章對Spring IoC容器的源碼分析,我們已經基本上了解了Spring IoC容器對Bean定義資源的定位、讀入和解析過程,同時也清楚了當用戶通過getBean方法向IoC容器獲取被管理的Bean時,IoC容器對Bean進行的初始化和依賴注入過程,這些是Spring IoC容器的基本功能特性。Spring IoC容器還有一些高級特性,如使用lazy-init屬性對Bean預初始化、FactoryBean產生或者修飾Bean對象的生成、IoC容器初始化Bean過程中使用BeanPostProcessor後置處理器對Bean聲明周期事件管理和IoC容器的autowiring自動裝配功能等。
2、Spring IoC容器的lazy-init屬性實現預實例化:
通過前面我們對IoC容器的實現和工作原理分析,我們知道IoC容器的初始化過程就是對Bean定義資源的定位、載入和注冊,此時容器對Bean的依賴注入並沒有發生,依賴注入主要是在應用程序第一次向容器索取Bean時,通過getBean方法的調用完成。
當Bean定義資源的<Bean>元素中配置了lazy-init屬性時,容器將會在初始化的時候對所配置的Bean進行預實例化,Bean的依賴注入在容器初始化的時候就已經完成。這樣,當應用程序第一次向容器索取被管理的Bean時,就不用再初始化和對Bean進行依賴注入了,直接從容器中獲取已經完成依賴注入的現成Bean,可以提高應用第一次向容器獲取Bean的性能。
下面我們通過代碼分析容器預實例化的實現過程:
(1).refresh()
先從IoC容器的初始會過程開始,通過前面文章分析,我們知道IoC容器讀入已經定位的Bean定義資源是從refresh方法開始的,我們首先從AbstractApplicationContext類的refresh方法入手分析,源碼如下:
1 //容器初始化的過程,讀入Bean定義資源,並解析注冊 2 public void refresh() throws BeansException, IllegalStateException { 3 synchronized (this.startupShutdownMonitor) { 4 //調用容器准備刷新的方法,獲取容器的當時時間,同時給容器設置同步標識 5 prepareRefresh(); 6 //告訴子類啟動refreshBeanFactory()方法,Bean定義資源文件的載入從 7 //子類的refreshBeanFactory()方法啟動 8 ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory(); 9 //為BeanFactory配置容器特性,例如類加載器、事件處理器等 10 prepareBeanFactory(beanFactory); 11 try { 12 //為容器的某些子類指定特殊的BeanPost事件處理器 13 postProcessBeanFactory(beanFactory); 14 //調用所有注冊的BeanFactoryPostProcessor的Bean 15 invokeBeanFactoryPostProcessors(beanFactory); 16 //為BeanFactory注冊BeanPost事件處理器. 17 //BeanPostProcessor是Bean後置處理器,用於監聽容器觸發的事件 18 registerBeanPostProcessors(beanFactory); 19 //初始化信息源,和國際化相關. 20 initMessageSource(); 21 //初始化容器事件傳播器. 22 initApplicationEventMulticaster(); 23 //調用子類的某些特殊Bean初始化方法 24 onRefresh(); 25 //為事件傳播器注冊事件監聽器. 26 registerListeners(); 27 //這裡是對容器lazy-init屬性進行處理的入口方法 28 finishBeanFactoryInitialization(beanFactory); 29 //初始化容器的生命周期事件處理器,並發布容器的生命周期事件 30 finishRefresh(); 31 } 32 catch (BeansException ex) { 33 //銷毀以創建的單態Bean 34 destroyBeans(); 35 //取消refresh操作,重置容器的同步標識. 36 cancelRefresh(ex); 37 throw ex; 38 } 39 } }
在refresh方法中ConfigurableListableBeanFactorybeanFactory = obtainFreshBeanFactory();啟動了Bean定義資源的載入、注冊過程,而finishBeanFactoryInitialization方法是對注冊後的Bean定義中的預實例化(lazy-init=false,Spring默認就是預實例化,即為true)的Bean進行處理的地方。
(2).finishBeanFactoryInitialization處理預實例化Bean:
當Bean定義資源被載入IoC容器之後,容器將Bean定義資源解析為容器內部的數據結構BeanDefinition注冊到容器中,AbstractApplicationContext類中的finishBeanFactoryInitialization方法對配置了預實例化屬性的Bean進行預初始化過程,源碼如下:
1 //對配置了lazy-init屬性的Bean進行預實例化處理 2 protected void finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory) { 3 //這是Spring3以後新加的代碼,為容器指定一個轉換服務(ConversionService) 4 //在對某些Bean屬性進行轉換時使用 5 if (beanFactory.containsBean(CONVERSION_SERVICE_BEAN_NAME) && 6 beanFactory.isTypeMatch(CONVERSION_SERVICE_BEAN_NAME, ConversionService.class)) { 7 beanFactory.setConversionService( 8 beanFactory.getBean(CONVERSION_SERVICE_BEAN_NAME, ConversionService.class)); 9 } 10 //為了類型匹配,停止使用臨時的類加載器 11 beanFactory.setTempClassLoader(null); 12 //緩存容器中所有注冊的BeanDefinition元數據,以防被修改 13 beanFactory.freezeConfiguration(); 14 //對配置了lazy-init屬性的單態模式Bean進行預實例化處理 15 beanFactory.preInstantiateSingletons(); }
ConfigurableListableBeanFactory是一個接口,其preInstantiateSingletons方法由其子類DefaultListableBeanFactory提供。
(3)、DefaultListableBeanFactory對配置lazy-init屬性單態Bean的預實例化:
1//對配置lazy-init屬性單態Bean的預實例化 2public void preInstantiateSingletons() throws BeansException { 3 if (this.logger.isInfoEnabled()) { 4 this.logger.info("Pre-instantiating singletons in " + this); 5 } 6 //在對配置lazy-init屬性單態Bean的預實例化過程中,必須多線程同步,以確保數據一致性 7 synchronized (this.beanDefinitionMap) { 8 for (String beanName : this.beanDefinitionNames) { 9 //獲取指定名稱的Bean定義 10 RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName); 11 //Bean不是抽象的,是單態模式的,且lazy-init屬性配置為false 12 if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) { 13 //如果指定名稱的bean是創建容器的Bean 14 if (isFactoryBean(beanName)) { 15 //FACTORY_BEAN_PREFIX=”&”,當Bean名稱前面加”&”符號 16 //時,獲取的是產生容器對象本身,而不是容器產生的Bean. 17 //調用getBean方法,觸發容器對Bean實例化和依賴注入過程 18 final FactoryBean factory = (FactoryBean) getBean(FACTORY_BEAN_PREFIX + beanName); 19 //標識是否需要預實例化 20 boolean isEagerInit; 21 if (System.getSecurityManager() != null && factory instanceof SmartFactoryBean) { 22 //一個匿名內部類 23 isEagerInit = AccessController.doPrivileged(new PrivilegedAction<Boolean>() { 24 public Boolean run() { 25 return ((SmartFactoryBean) factory).isEagerInit(); 26 } 27 }, getAccessControlContext()); 28 } 29 else { 30 isEagerInit = factory instanceof SmartFactoryBean && ((SmartFactoryBean) factory).isEagerInit(); 31 } 32 if (isEagerInit) { 33 //調用getBean方法,觸發容器對Bean實例化和依賴注入過程 34 getBean(beanName); 35 } 36 } 37 else { 38 //調用getBean方法,觸發容器對Bean實例化和依賴注入過程 39 getBean(beanName); 40 } 41 } 42 } 43 } }
通過對lazy-init處理源碼的分析,我們可以看出,如果設置了lazy-init屬性,則容器在完成Bean定義的注冊之後,會通過getBean方法,觸發對指定Bean的初始化和依賴注入過程,這樣當應用第一次向容器索取所需的Bean時,容器不再需要對Bean進行初始化和依賴注入,直接從已經完成實例化和依賴注入的Bean中取一個線程的Bean,這樣就提高了第一次獲取Bean的性能。
3、FactoryBean的實現:
在Spring中,有兩個很容易混淆的類:BeanFactory和FactoryBean。
BeanFactory:Bean工廠,是一個工廠(Factory),我們Spring IoC容器的最頂層接口就是這個BeanFactory,它的作用是管理Bean,即實例化、定位、配置應用程序中的對象及建立這些對象間的依賴。
FactoryBean:工廠Bean,是一個Bean,作用是產生其他bean實例。通常情況下,這種bean沒有什麼特別的要求,僅需要提供一個工廠方法,該方法用來返回其他bean實例。通常情況下,bean無須自己實現工廠模式,Spring容器擔任工廠角色;但少數情況下,容器中的bean本身就是工廠,其作用是產生其它bean實例。
當用戶使用容器本身時,可以使用轉義字符”&”來得到FactoryBean本身,以區別通過FactoryBean產生的實例對象和FactoryBean對象本身。在BeanFactory中通過如下代碼定義了該轉義字符:
StringFACTORY_BEAN_PREFIX = "&";
如果myJndiObject是一個FactoryBean,則使用&myJndiObject得到的是myJndiObject對象,而不是myJndiObject產生出來的對象。
(1).FactoryBean的源碼如下:
//工廠Bean,用於產生其他對象 public interface FactoryBean<T> { //獲取容器管理的對象實例 T getObject() throws Exception; //獲取Bean工廠創建的對象的類型 Class<?> getObjectType(); //Bean工廠創建的對象是否是單態模式,如果是單態模式,則整個容器中只有一個實例 //對象,每次請求都返回同一個實例對象 boolean isSingleton(); }
(2). AbstractBeanFactory的getBean方法調用FactoryBean:
在前面我們分析Spring Ioc容器實例化Bean並進行依賴注入過程的源碼時,提到在getBean方法觸發容器實例化Bean的時候會調用AbstractBeanFactory的doGetBean方法來進行實例化的過程,源碼如下:
1 //真正實現向IoC容器獲取Bean的功能,也是觸發依賴注入功能的地方 2 @SuppressWarnings("unchecked") 3 protected <T> T doGetBean( 4 final String name, final Class<T> requiredType, final Object[] args, boolean typeCheckOnly) 5 throws BeansException { 6 //根據指定的名稱獲取被管理Bean的名稱,剝離指定名稱中對容器的相關依賴 7 //如果指定的是別名,將別名轉換為規范的Bean名稱 8 final String beanName = transformedBeanName(name); 9 Object bean; 10 //先從緩存中取是否已經有被創建過的單態類型的Bean,對於單態模式的Bean整 11 //個IoC容器中只創建一次,不需要重復創建 12 Object sharedInstance = getSingleton(beanName); 13 //IoC容器創建單態模式Bean實例對象 14 if (sharedInstance != null && args == null) { 15 if (logger.isDebugEnabled()) { 16 //如果指定名稱的Bean在容器中已有單態模式的Bean被創建,直接返回 17 //已經創建的Bean 18 if (isSingletonCurrentlyInCreation(beanName)) { 19 logger.debug("Returning eagerly cached instance of singleton bean '" + beanName + 20 "' that is not fully initialized yet - a consequence of a circular reference"); 21 } 22 else { 23 logger.debug("Returning cached instance of singleton bean '" + beanName + "'"); 24 } 25 } 26 //獲取給定Bean的實例對象,主要是完成FactoryBean的相關處理 27 bean = getObjectForBeanInstance(sharedInstance, name, beanName, null); 28 } 29 …… 30 } 31 //獲取給定Bean的實例對象,主要是完成FactoryBean的相關處理 32 protected Object getObjectForBeanInstance( 33 Object beanInstance, String name, String beanName, RootBeanDefinition mbd) { 34 //容器已經得到了Bean實例對象,這個實例對象可能是一個普通的Bean,也可能是 35 //一個工廠Bean,如果是一個工廠Bean,則使用它創建一個Bean實例對象,如果 36 //調用本身就想獲得一個容器的引用,則指定返回這個工廠Bean實例對象 37 //如果指定的名稱是容器的解引用(dereference,即是對象本身而非內存地址), 38 //且Bean實例也不是創建Bean實例對象的工廠Bean 39 if (BeanFactoryUtils.isFactoryDereference(name) && !(beanInstance instanceof FactoryBean)) { 40 throw new BeanIsNotAFactoryException(transformedBeanName(name), beanInstance.getClass()); 41 } 42 //如果Bean實例不是工廠Bean,或者指定名稱是容器的解引用,調用者向獲取對 43 //容器的引用,則直接返回當前的Bean實例 44 if (!(beanInstance instanceof FactoryBean) || BeanFactoryUtils.isFactoryDereference(name)) { 45 return beanInstance; 46 } 47 //處理指定名稱不是容器的解引用,或者根據名稱獲取的Bean實例對象是一個工廠Bean 48 //使用工廠Bean創建一個Bean的實例對象 49 Object object = null; 50 if (mbd == null) { 51 //從Bean工廠緩存中獲取給定名稱的Bean實例對象 52 object = getCachedObjectForFactoryBean(beanName); 53 } 54 //讓Bean工廠生產給定名稱的Bean對象實例 55 if (object == null) { 56 FactoryBean factory = (FactoryBean) beanInstance; 57 //如果從Bean工廠生產的Bean是單態模式的,則緩存 58 if (mbd == null && containsBeanDefinition(beanName)) { 59 //從容器中獲取指定名稱的Bean定義,如果繼承基類,則合並基類相關屬性 60 mbd = getMergedLocalBeanDefinition(beanName); 61 } 62 //如果從容器得到Bean定義信息,並且Bean定義信息不是虛構的,則讓工廠 63 //Bean生產Bean實例對象 64 boolean synthetic = (mbd != null && mbd.isSynthetic()); 65 //調用FactoryBeanRegistrySupport類的getObjectFromFactoryBean 66 //方法,實現工廠Bean生產Bean對象實例的過程 67 object = getObjectFromFactoryBean(factory, beanName, !synthetic); 68 } 69 return object; }
在上面獲取給定Bean的實例對象的getObjectForBeanInstance方法中,會調用FactoryBeanRegistrySupport類的getObjectFromFactoryBean方法,該方法實現了Bean工廠生產Bean實例對象。
Dereference(解引用):一個在C/C++中應用比較多的術語,在C++中,”*”是解引用符號,而”&”是引用符號,解引用是指變量指向的是所引用對象的本身數據,而不是引用對象的內存地址。
(3)、AbstractBeanFactory生產Bean實例對象:
AbstractBeanFactory類中生產Bean實例對象的主要源碼如下:
71 //Bean工廠生產Bean實例對象 72 protected Object getObjectFromFactoryBean(FactoryBean factory, String beanName, boolean shouldPostProcess) { 73 //Bean工廠是單態模式,並且Bean工廠緩存中存在指定名稱的Bean實例對象 74 if (factory.isSingleton() && containsSingleton(beanName)) { 75 //多線程同步,以防止數據不一致 76 synchronized (getSingletonMutex()) { 77 //直接從Bean工廠緩存中獲取指定名稱的Bean實例對象 78 Object object = this.factoryBeanObjectCache.get(beanName); 79 //Bean工廠緩存中沒有指定名稱的實例對象,則生產該實例對象 80 if (object == null) { 81 //調用Bean工廠的getObject方法生產指定Bean的實例對象 82 object = doGetObjectFromFactoryBean(factory, beanName, shouldPostProcess); 83 //將生產的實例對象添加到Bean工廠緩存中 84 this.factoryBeanObjectCache.put(beanName, (object != null ? object : NULL_OBJECT)); 85 } 86 return (object != NULL_OBJECT ? object : null); 87 } 88 } 89 //調用Bean工廠的getObject方法生產指定Bean的實例對象 90 else { 91 return doGetObjectFromFactoryBean(factory, beanName, shouldPostProcess); 92 } 93 } 94 //調用Bean工廠的getObject方法生產指定Bean的實例對象 95 private Object doGetObjectFromFactoryBean( 96 final FactoryBean factory, final String beanName, final boolean shouldPostProcess) 97 throws BeanCreationException { 98 Object object; 99 try { 100 if (System.getSecurityManager() != null) { 101 AccessControlContext acc = getAccessControlContext(); 102 try { 103 //實現PrivilegedExceptionAction接口的匿名內置類 104 //根據JVM檢查權限,然後決定BeanFactory創建實例對象 105 object = AccessController.doPrivileged(new PrivilegedExceptionAction<Object>() { 106 public Object run() throws Exception { 107 //調用BeanFactory接口實現類的創建對象方法 108 return factory.getObject(); 109 } 110 }, acc); 111 } 112 catch (PrivilegedActionException pae) { 113 throw pae.getException(); 114 } 115 } 116 else { 117 //調用BeanFactory接口實現類的創建對象方法 118 object = factory.getObject(); 119 } 120 } 121 catch (FactoryBeanNotInitializedException ex) { 122 throw new BeanCurrentlyInCreationException(beanName, ex.toString()); 123 } 124 catch (Throwable ex) { 125 throw new BeanCreationException(beanName, "FactoryBean threw exception on object creation", ex); 126 } 127 //創建出來的實例對象為null,或者因為單態對象正在創建而返回null 128 if (object == null && isSingletonCurrentlyInCreation(beanName)) { 129 throw new BeanCurrentlyInCreationException( 130 beanName, "FactoryBean which is currently in creation returned null from getObject"); 131 } 132 //為創建出來的Bean實例對象添加BeanPostProcessor後置處理器 133 if (object != null && shouldPostProcess) { 134 try { 135 object = postProcessObjectFromFactoryBean(object, beanName); 136 } 137 catch (Throwable ex) { 138 throw new BeanCreationException(beanName, "Post-processing of the FactoryBean's object failed", ex); 139 } 140 } 141 return object; }
從上面的源碼分析中,我們可以看出,BeanFactory接口調用其實現類的getObject方法來實現創建Bean實例對象的功能。
(4).工廠Bean的實現類getObject方法創建Bean實例對象:
FactoryBean的實現類有非常多,比如:Proxy、RMI、JNDI、ServletContextFactoryBean等等,FactoryBean接口為Spring容器提供了一個很好的封裝機制,具體的getObject有不同的實現類根據不同的實現策略來具體提供,我們分析一個最簡單的AnnotationTestFactoryBean的實現源碼:
143 public class AnnotationTestBeanFactory implements FactoryBean<IJmxTestBean> { 144 private final FactoryCreatedAnnotationTestBean instance = new FactoryCreatedAnnotationTestBean(); 145 public AnnotationTestBeanFactory() { 146 this.instance.setName("FACTORY"); 147 } 148 //AnnotationTestBeanFactory產生Bean實例對象的實現 149 public IJmxTestBean getObject() throws Exception { 150 return this.instance; 151 } 152 public Class<? extends IJmxTestBean> getObjectType() { 153 return FactoryCreatedAnnotationTestBean.class; 154 } 155 public boolean isSingleton() { 156 return true; 157 } }
其他的Proxy,RMI,JNDI等等,都是根據相應的策略提供getObject的實現。這裡不做一一分析,這已經不是Spring的核心功能,有需要的時候再去深入研究。
4.BeanPostProcessor後置處理器的實現:
BeanPostProcessor後置處理器是Spring IoC容器經常使用到的一個特性,這個Bean後置處理器是一個監聽器,可以監聽容器觸發的Bean聲明周期事件。後置處理器向容器注冊以後,容器中管理的Bean就具備了接收IoC容器事件回調的能力。
BeanPostProcessor的使用非常簡單,只需要提供一個實現接口BeanPostProcessor的實現類,然後在Bean的配置文件中設置即可。
(1).BeanPostProcessor的源碼如下:
1 package org.springframework.beans.factory.config; 2 import org.springframework.beans.BeansException; 3 public interface BeanPostProcessor { 4 //為在Bean的初始化前提供回調入口 5 Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException; 6 //為在Bean的初始化之後提供回調入口 7 Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException; }
這兩個回調的入口都是和容器管理的Bean的生命周期事件緊密相關,可以為用戶提供在Spring IoC容器初始化Bean過程中自定義的處理操作。
(2).AbstractAutowireCapableBeanFactory類對容器生成的Bean添加後置處理器:
BeanPostProcessor後置處理器的調用發生在Spring IoC容器完成對Bean實例對象的創建和屬性的依賴注入完成之後,在對Spring依賴注入的源碼分析過程中我們知道,當應用程序第一次調用getBean方法(lazy-init預實例化除外)向Spring IoC容器索取指定Bean時觸發Spring IoC容器創建Bean實例對象並進行依賴注入的過程,其中真正實現創建Bean對象並進行依賴注入的方法是AbstractAutowireCapableBeanFactory類的doCreateBean方法,主要源碼如下:
1 //真正創建Bean的方法 2 protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final Object[] args) { 3 //創建Bean實例對象 4 …… 5 try { 6 //對Bean屬性進行依賴注入 7 populateBean(beanName, mbd, instanceWrapper); 8 if (exposedObject != null) { 9 //在對Bean實例對象生成和依賴注入完成以後,開始對Bean實例對象 10 //進行初始化 ,為Bean實例對象應用BeanPostProcessor後置處理器 11 exposedObject = initializeBean(beanName, exposedObject, mbd); 12 } 13 } 14 catch (Throwable ex) { 15 if (ex instanceof BeanCreationException && beanName.equals(((BeanCreationException) ex).getBeanName())) { 16 throw (BeanCreationException) ex; 17 } 18 …… 19 //為應用返回所需要的實例對象 20 return exposedObject; }
從上面的代碼中我們知道,為Bean實例對象添加BeanPostProcessor後置處理器的入口的是initializeBean方法。
(3).initializeBean方法為容器產生的Bean實例對象添加BeanPostProcessor後置處理器:
同樣在AbstractAutowireCapableBeanFactory類中,initializeBean方法實現為容器創建的Bean實例對象添加BeanPostProcessor後置處理器,源碼如下:
1 //初始容器創建的Bean實例對象,為其添加BeanPostProcessor後置處理器 2 protected Object initializeBean(final String beanName, final Object bean, RootBeanDefinition mbd) { 3 //JDK的安全機制驗證權限 4 if (System.getSecurityManager() != null) { 5 //實現PrivilegedAction接口的匿名內部類 6 AccessController.doPrivileged(new PrivilegedAction<Object>() { 7 public Object run() { 8 invokeAwareMethods(beanName, bean); 9 return null; 10 } 11 }, getAccessControlContext()); 12 } 13 else { 14 //為Bean實例對象包裝相關屬性,如名稱,類加載器,所屬容器等信息 15 invokeAwareMethods(beanName, bean); 16 } 17 Object wrappedBean = bean; 18 //對BeanPostProcessor後置處理器的postProcessBeforeInitialization 19 //回調方法的調用,為Bean實例初始化前做一些處理 20 if (mbd == null || !mbd.isSynthetic()) { 21 wrappedBean = applyBeanPostProcessorsBeforeInitialization(wrappedBean, beanName); 22 } 23 //調用Bean實例對象初始化的方法,這個初始化方法是在Spring Bean定義配置 24 //文件中通過init-method屬性指定的 25 try { 26 invokeInitMethods(beanName, wrappedBean, mbd); 27 } 28 catch (Throwable ex) { 29 throw new BeanCreationException( 30 (mbd != null ? mbd.getResourceDescription() : null), 31 beanName, "Invocation of init method failed", ex); 32 } 33 //對BeanPostProcessor後置處理器的postProcessAfterInitialization 34 //回調方法的調用,為Bean實例初始化之後做一些處理 35 if (mbd == null || !mbd.isSynthetic()) { 36 wrappedBean = applyBeanPostProcessorsAfterInitialization(wrappedBean, beanName); 37 } 38 return wrappedBean; 39 } 40 //調用BeanPostProcessor後置處理器實例對象初始化之前的處理方法 41 public Object applyBeanPostProcessorsBeforeInitialization(Object existingBean, String beanName) 42 throws BeansException { 43 Object result = existingBean; 44 //遍歷容器為所創建的Bean添加的所有BeanPostProcessor後置處理器 45 for (BeanPostProcessor beanProcessor : getBeanPostProcessors()) { 46 //調用Bean實例所有的後置處理中的初始化前處理方法,為Bean實例對象在 47 //初始化之前做一些自定義的處理操作 48 result = beanProcessor.postProcessBeforeInitialization(result, beanName); 49 if (result == null) { 50 return result; 51 } 52 } 53 return result; 54 } 55 //調用BeanPostProcessor後置處理器實例對象初始化之後的處理方法 56 public Object applyBeanPostProcessorsAfterInitialization(Object existingBean, String beanName) 57 throws BeansException { 58 Object result = existingBean; 59 //遍歷容器為所創建的Bean添加的所有BeanPostProcessor後置處理器 60 for (BeanPostProcessor beanProcessor : getBeanPostProcessors()) { 61 //調用Bean實例所有的後置處理中的初始化後處理方法,為Bean實例對象在 62 //初始化之後做一些自定義的處理操作 63 result = beanProcessor.postProcessAfterInitialization(result, beanName); 64 if (result == null) { 65 return result; 66 } 67 } 68 return result; }
BeanPostProcessor是一個接口,其初始化前的操作方法和初始化後的操作方法均委托其實現子類來實現,在Spring中,BeanPostProcessor的實現子類非常的多,分別完成不同的操作,如:AOP面向切面編程的注冊通知適配器、Bean對象的數據校驗、Bean繼承屬性/方法的合並等等,我們以最簡單的AOP切面織入來簡單了解其主要的功能。
(4).AdvisorAdapterRegistrationManager在Bean對象初始化後注冊通知適配器:
AdvisorAdapterRegistrationManager是BeanPostProcessor的一個實現類,其主要的作用為容器中管理的Bean注冊一個面向切面編程的通知適配器,以便在Spring容器為所管理的Bean進行面向切面編程時提供方便,其源碼如下:
1 //為容器中管理的Bean注冊一個面向切面編程的通知適配器 2 public class AdvisorAdapterRegistrationManager implements BeanPostProcessor { 3 //容器中負責管理切面通知適配器注冊的對象 4 private AdvisorAdapterRegistry advisorAdapterRegistry = GlobalAdvisorAdapterRegistry.getInstance(); 5 public void setAdvisorAdapterRegistry(AdvisorAdapterRegistry advisorAdapterRegistry) { 6 this.advisorAdapterRegistry = advisorAdapterRegistry; 7 } 8 //BeanPostProcessor在Bean對象初始化前的操作 9 public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { 10 //沒有做任何操作,直接返回容器創建的Bean對象 11 return bean; 12 } 13 //BeanPostProcessor在Bean對象初始化後的操作 14 public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { 15 if (bean instanceof AdvisorAdapter){ 16 //如果容器創建的Bean實例對象是一個切面通知適配器,則向容器的注冊 this.advisorAdapterRegistry.registerAdvisorAdapter((AdvisorAdapter) bean); 17 } 18 return bean; 19 } }
其他的BeanPostProcessor接口實現類的也類似,都是對Bean對象使用到的一些特性進行處理,或者向IoC容器中注冊,為創建的Bean實例對象做一些自定義的功能增加,這些操作是容器初始化Bean時自動觸發的,不需要認為的干預。
5.Spring IoC容器autowiring實現原理:
Spring IoC容器提供了兩種管理Bean依賴關系的方式:
a. 顯式管理:通過BeanDefinition的屬性值和構造方法實現Bean依賴關系管理。
b. autowiring:Spring IoC容器的依賴自動裝配功能,不需要對Bean屬性的依賴關系做顯式的聲明,只需要在配置好autowiring屬性,IoC容器會自動使用反射查找屬性的類型和名稱,然後基於屬性的類型或者名稱來自動匹配容器中管理的Bean,從而自動地完成依賴注入。
通過對autowiring自動裝配特性的理解,我們知道容器對Bean的自動裝配發生在容器對Bean依賴注入的過程中。在前面對Spring IoC容器的依賴注入過程源碼分析中,我們已經知道了容器對Bean實例對象的屬性注入的處理發生在AbstractAutoWireCapableBeanFactory類中的populateBean方法中,我們通過程序流程分析autowiring的實現原理:
(1). AbstractAutoWireCapableBeanFactory對Bean實例進行屬性依賴注入:
應用第一次通過getBean方法(配置了lazy-init預實例化屬性的除外)向IoC容器索取Bean時,容器創建Bean實例對象,並且對Bean實例對象進行屬性依賴注入,AbstractAutoWireCapableBeanFactory的populateBean方法就是實現Bean屬性依賴注入的功能,其主要源碼如下:
1 protected void populateBean(String beanName, AbstractBeanDefinition mbd, BeanWrapper bw) { 2 //獲取Bean定義的屬性值,並對屬性值進行處理 3 PropertyValues pvs = mbd.getPropertyValues(); 4 …… 5 //對依賴注入處理,首先處理autowiring自動裝配的依賴注入 6 if (mbd.getResolvedAutowireMode() == RootBeanDefinition.AUTOWIRE_BY_NAME || 7 mbd.getResolvedAutowireMode() == RootBeanDefinition.AUTOWIRE_BY_TYPE) { 8 MutablePropertyValues newPvs = new MutablePropertyValues(pvs); 9 //根據Bean名稱進行autowiring自動裝配處理 10 if (mbd.getResolvedAutowireMode() == RootBeanDefinition.AUTOWIRE_BY_NAME) { 11 autowireByName(beanName, mbd, bw, newPvs); 12 } 13 //根據Bean類型進行autowiring自動裝配處理 14 if (mbd.getResolvedAutowireMode() == RootBeanDefinition.AUTOWIRE_BY_TYPE) { 15 autowireByType(beanName, mbd, bw, newPvs); 16 } 17 } 18 //對非autowiring的屬性進行依賴注入處理 19 …… }
(2).Spring IoC容器根據Bean名稱或者類型進行autowiring自動依賴注入:
1 //根據名稱對屬性進行自動依賴注入 2 protected void autowireByName( 3 String beanName, AbstractBeanDefinition mbd, BeanWrapper bw, MutablePropertyValues pvs) { 4 //對Bean對象中非簡單屬性(不是簡單繼承的對象,如8中原始類型,字符串,URL等//都是簡單屬性)進行處理 5 String[] propertyNames = unsatisfiedNonSimpleProperties(mbd, bw); 6 for (String propertyName : propertyNames) { 7 //如果Spring IoC容器中包含指定名稱的Bean 8 if (containsBean(propertyName)) { 9 //調用getBean方法向IoC容器索取指定名稱的Bean實例,迭代觸發屬性的//初始化和依賴注入 10 Object bean = getBean(propertyName); 11 //為指定名稱的屬性賦予屬性值 12 pvs.add(propertyName, bean); 13 //指定名稱屬性注冊依賴Bean名稱,進行屬性依賴注入 14 registerDependentBean(propertyName, beanName); 15 if (logger.isDebugEnabled()) { 16 logger.debug("Added autowiring by name from bean name '" + beanName + 17 "' via property '" + propertyName + "' to bean named '" + propertyName + "'"); 18 } 19 } 20 else { 21 if (logger.isTraceEnabled()) { 22 logger.trace("Not autowiring property '" + propertyName + "' of bean '" + beanName + 23 "' by name: no matching bean found"); 24 } 25 } 26 } 27 } 28 //根據類型對屬性進行自動依賴注入 29 protected void autowireByType( 30 String beanName, AbstractBeanDefinition mbd, BeanWrapper bw, MutablePropertyValues pvs) { 31 //獲取用戶定義的類型轉換器 32 TypeConverter converter = getCustomTypeConverter(); 33 if (converter == null) { 34 converter = bw; 35 } 36 //存放解析的要注入的屬性 37 Set<String> autowiredBeanNames = new LinkedHashSet<String>(4); 38 //對Bean對象中非簡單屬性(不是簡單繼承的對象,如8中原始類型,字符 39 //URL等都是簡單屬性)進行處理 40 String[] propertyNames = unsatisfiedNonSimpleProperties(mbd, bw); 41 for (String propertyName : propertyNames) { 42 try { 43 //獲取指定屬性名稱的屬性描述器 44 PropertyDescriptor pd = bw.getPropertyDescriptor(propertyName); 45 //不對Object類型的屬性進行autowiring自動依賴注入 46 if (!Object.class.equals(pd.getPropertyType())) { 47 //獲取屬性的setter方法 48 MethodParameter methodParam = BeanUtils.getWriteMethodParameter(pd); 49 //檢查指定類型是否可以被轉換為目標對象的類型 50 boolean eager = !PriorityOrdered.class.isAssignableFrom(bw.getWrappedClass()); 51 //創建一個要被注入的依賴描述 52 DependencyDescriptor desc = new AutowireByTypeDependencyDescriptor(methodParam, eager); 53 //根據容器的Bean定義解析依賴關系,返回所有要被注入的Bean對象 54 Object autowiredArgument = resolveDependency(desc, beanName, autowiredBeanNames, converter); 55 if (autowiredArgument != null) { 56 //為屬性賦值所引用的對象 57 pvs.add(propertyName, autowiredArgument); 58 } 59 for (String autowiredBeanName : autowiredBeanNames) { 60 //指定名稱屬性注冊依賴Bean名稱,進行屬性依賴注入 61 registerDependentBean(autowiredBeanName, beanName); 62 if (logger.isDebugEnabled()) { 63 logger.debug("Autowiring by type from bean name '" + beanName + "' via property '" + 64 propertyName + "' to bean named '" + autowiredBeanName + "'"); 65 } 66 } 67 //釋放已自動注入的屬性 68 autowiredBeanNames.clear(); 69 } 70 } 71 catch (BeansException ex) { 72 throw new UnsatisfiedDependencyException(mbd.getResourceDescription(), beanName, propertyName, ex); 73 } 74 } }
通過上面的源碼分析,我們可以看出來通過屬性名進行自動依賴注入的相對比通過屬性類型進行自動依賴注入要稍微簡單一些,但是真正實現屬性注入的是DefaultSingletonBeanRegistry類的registerDependentBean方法。
(3).DefaultSingletonBeanRegistry的registerDependentBean方法對屬性注入:
1 //為指定的Bean注入依賴的Bean 2 public void registerDependentBean(String beanName, String dependentBeanName) { 3 //處理Bean名稱,將別名轉換為規范的Bean名稱 4 String canonicalName = canonicalName(beanName); 5 //多線程同步,保證容器內數據的一致性 6 //先從容器中:bean名稱-->全部依賴Bean名稱集合找查找給定名稱Bean的依賴Bean 7 synchronized (this.dependentBeanMap) { 8 //獲取給定名稱Bean的所有依賴Bean名稱 9 Set<String> dependentBeans = this.dependentBeanMap.get(canonicalName); 10 if (dependentBeans == null) { 11 //為Bean設置依賴Bean信息 12 dependentBeans = new LinkedHashSet<String>(8); 13 this.dependentBeanMap.put(canonicalName, dependentBeans); 14 } 15 //向容器中:bean名稱-->全部依賴Bean名稱集合添加Bean的依賴信息 16 //即,將Bean所依賴的Bean添加到容器的集合中 17 dependentBeans.add(dependentBeanName); 18 } 19 //從容器中:bean名稱-->指定名稱Bean的依賴Bean集合找查找給定名稱 20 //Bean的依賴Bean 21 synchronized (this.dependenciesForBeanMap) { 22 Set<String> dependenciesForBean = this.dependenciesForBeanMap.get(dependentBeanName); 23 if (dependenciesForBean == null) { 24 dependenciesForBean = new LinkedHashSet<String>(8); 25 this.dependenciesForBeanMap.put(dependentBeanName, dependenciesForBean); 26 } 27 //向容器中:bean名稱-->指定Bean的依賴Bean名稱集合添加Bean的依賴信息 28 //即,將Bean所依賴的Bean添加到容器的集合中 29 dependenciesForBean.add(canonicalName); 30 } }
通過對autowiring的源碼分析,我們可以看出,autowiring的實現過程:
a. 對Bean的屬性��代調用getBean方法,完成依賴Bean的初始化和依賴注入。
b. 將依賴Bean的屬性引用設置到被依賴的Bean屬性上。
c. 將依賴Bean的名稱和被依賴Bean的名稱存儲在IoC容器的集合中。
Spring IoC容器的autowiring屬性自動依賴注入是一個很方便的特性,可以簡化開發時的配置,但是凡是都有兩面性,自動屬性依賴注入也有不足,首先,Bean的依賴關系在配置文件中無法很清楚地看出來,對於維護造成一定困難。其次,由於自動依賴注入是Spring容器自動執行的,容器是不會智能判斷的,如果配置不當,將會帶來無法預料的後果,所以自動依賴注入特性在使用時還是綜合考慮。
參考:
Spring技術內幕:深入解析Spring架構與設計原理(第2版)高清掃描版 PDF下載見 http://www.linuxidc.com/Linux/2016-11/137393.htm
談談對Spring IOC的理解 http://www.linuxidc.com/Linux/2015-01/112409.htm
Spring IOC代碼閱讀 http://www.linuxidc.com/Linux/2016-11/137391.htm