Spring:源码解读Spring IOC原理

Posted 归零,路上

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Spring:源码解读Spring IOC原理相关的知识,希望对你有一定的参考价值。

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/DI?

    IoC 容器:最主要是完成了完成对象的创建和依赖的管理注入等等。

先从我们自己设计这样一个视角来考虑:

所谓控制反转,就是把原先我们代码里面需要实现的对象创建、依赖的代码,反转给容器来帮忙实现。那么必然的我们需要创建一个容器,同时需要一种描述来让容器知道需要创建的对象与对象的关系。这个描述最具体表现就是我们可配置的文件。

对象和对象关系怎么表示?

可以用 xml , properties 文件等语义化配置文件表示。

描述对象关系的文件存放在哪里?

可能是 classpath , filesystem ,或者是 URL 网络资源, servletContext 等。

回到正题,有了配置文件,还需要对配置文件解析。

不同的配置文件对对象的描述不一样,如标准的,自定义声明式的,如何统一? 在内部需要有一个统一的关于对象的定义,所有外部的描述都必须转化成统一的描述定义。

如何对不同的配置文件进行解析?需要对不同的配置文件语法,采用不同的解析器

 

二、 Spring IOC体系结构?

(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容器的初始化?

       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() +

以上是关于Spring:源码解读Spring IOC原理的主要内容,如果未能解决你的问题,请参考以下文章

Spring:源码解读Spring IOC原理

Spring-IOC源码解读3-依赖注入

spring源码分析spring ioc容器之前生今世--DefaultListableBeanFactory源码解读

免费深入浅出解读 Spring 源码:IOC/AOP 篇 | Chat · 预告

Spring-IOC源码解读2.1-BeanDefinition的Resource定位

Spring-IOC源码解读2.3-BeanDefinition的注册