首页 / 操作系统 / Linux / 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容器接口BeanFactory1 public interface BeanFactory {23//对FactoryBean的转义定义,因为如果使用bean的名字检索FactoryBean得到的对象是工厂生成的对象,4//如果需要得到工厂本身,需要转义 5String FACTORY_BEAN_PREFIX = "&"; 6 7//根据bean的名字,获取在IOC容器中得到bean实例8Object getBean(String name) throws BeansException;910 //根据bean的名字和Class类型来得到bean实例,增加了类型安全验证机制。11Object getBean(String name, Class requiredType) throws BeansException;12 13 //提供对bean的检索,看看是否在IOC容器有这个名字的bean14boolean 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的别名,如果根据别名检索,那么其原名也会被检索出来23String[] 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 DefaultResourceLoaderimplements 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定义的载入过程: 1public void refresh() throws BeansException, IllegalStateException {2synchronized (this.startupShutdownMonitor) {3//调用容器准备刷新的方法,获取容器的当时时间,同时给容器设置同步标识4prepareRefresh();5//告诉子类启动refreshBeanFactory()方法,Bean定义资源文件的载入从6 //子类的refreshBeanFactory()方法启动7ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();8//为BeanFactory配置容器特性,例如类加载器、事件处理器等9prepareBeanFactory(beanFactory);10try {11//为容器的某些子类指定特殊的BeanPost事件处理器12postProcessBeanFactory(beanFactory);13//调用所有注册的BeanFactoryPostProcessor的Bean14invokeBeanFactoryPostProcessors(beanFactory);15//为BeanFactory注册BeanPost事件处理器.16//BeanPostProcessor是Bean后置处理器,用于监听容器触发的事件17registerBeanPostProcessors(beanFactory);18//初始化信息源,和国际化相关.19initMessageSource();20//初始化容器事件传播器.21initApplicationEventMulticaster();22//调用子类的某些特殊Bean初始化方法23onRefresh();24//为事件传播器注册事件监听器.25registerListeners();26//初始化所有剩余的单态Bean.27finishBeanFactoryInitialization(beanFactory);28//初始化容器的生命周期事件处理器,并发布容器的生命周期事件29finishRefresh();30}31catch (BeansException ex) {32//销毁以创建的单态Bean33destroyBeans();34//取消refresh操作,重置容器的同步标识.35cancelRefresh(ex);36throw 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()方法,方法的源码如下:1protected final void refreshBeanFactory() throws BeansException {2if (hasBeanFactory()) {//如果已经有容器,销毁容器中的bean,关闭容器3destroyBeans();4closeBeanFactory();5}6try {7 //创建IoC容器8 DefaultListableBeanFactory beanFactory = createBeanFactory();9 beanFactory.setSerializationId(getId());10//对IoC容器进行定制化,如设置启动参数,开启注解的自动装配等11customizeBeanFactory(beanFactory);12//调用载入Bean定义的方法,主要这里又使用了一个委派模式,在当前类中只定义了抽象的loadBeanDefinitions方法,具体的实现调用子类容器13loadBeanDefinitions(beanFactory);14synchronized (this.beanFactoryMonitor) {15this.beanFactory = beanFactory;16}17}18catch (IOException ex) {19throw 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中。1public abstract class AbstractXmlApplicationContext extends AbstractRefreshableConfigApplicationContext {2 ……3 //实现父类抽象的载入Bean定义方法4 @Override5 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,因此,容器本身也是一个资源加载器10beanDefinitionReader.setResourceLoader(this);11//为Bean读取器设置SAX xml解析器12beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));13//当Bean读取器读取Bean定义的Xml资源文件时,启用Xml的校验机制14initBeanDefinitionReader(beanDefinitionReader);15//Bean读取器真正实现加载的方法16loadBeanDefinitions(beanDefinitionReader);17}18//Xml Bean读取器加载Bean定义资源19protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException, IOException {20//获取Bean定义资源的定位21Resource[] configResources = getConfigResources();22if (configResources != null) {23//Xml Bean读取器调用其父类AbstractBeanDefinitionReader读取定位24//的Bean定义资源25reader.loadBeanDefinitions(configResources);26}27//如果子类中获取的Bean定义资源定位为空,则获取FileSystemXmlApplicationContext构造方法中setConfigLocations方法设置的资源28String[] configLocations = getConfigLocations();29if (configLocations != null) {30//Xml Bean读取器调用其父类AbstractBeanDefinitionReader读取定位31//的Bean定义资源32reader.loadBeanDefinitions(configLocations);33}34}35//这里又使用了一个委托模式,调用子类的获取Bean定义资源定位的方法36//该方法在ClassPathXmlApplicationContext中进行实现,对于我们37//举例分析源码的FileSystemXmlApplicationContext没有使用该方法38protected Resource[] getConfigResources() {39return 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>);方法2public int loadBeanDefinitions(String location) throws BeanDefinitionStoreException {3return loadBeanDefinitions(location, null);4}5public int loadBeanDefinitions(String location, Set<Resource> actualResources) throws BeanDefinitionStoreException {6//获取在IoC容器初始化过程中设置的资源加载器7ResourceLoader resourceLoader = getResourceLoader();8if (resourceLoader == null) {9throw new BeanDefinitionStoreException(10"Cannot import bean definitions from location [" + location + "]: no ResourceLoader available");11}12if (resourceLoader instanceof ResourcePatternResolver) {13try {14//将指定位置的Bean定义资源文件解析为Spring IoC容器封装的资源15//加载多个指定位置的Bean定义资源文件16Resource[] resources = ((ResourcePatternResolver) resourceLoader).getResources(location);17//委派调用其子类XmlBeanDefinitionReader的方法,实现加载功能18int loadCount = loadBeanDefinitions(resources);19if (actualResources != null) {20for (Resource resource : resources) {21actualResources.add(resource);22}23}24if (logger.isDebugEnabled()) {25logger.debug("Loaded " + loadCount + " bean definitions from location pattern [" + location + "]");26}27return loadCount;28}29catch (IOException ex) {30throw new BeanDefinitionStoreException(31"Could not resolve bean definition resource pattern [" + location + "]", ex);32}33}34else {35//将指定位置的Bean定义资源文件解析为Spring IoC容器封装的资源36//加载单个指定位置的Bean定义资源文件37Resource resource = resourceLoader.getResource(location);38//委派调用其子类XmlBeanDefinitionReader的方法,实现加载功能39int loadCount = loadBeanDefinitions(resource);40if (actualResources != null) {41actualResources.add(resource);42}43if (logger.isDebugEnabled()) {44logger.debug("Loaded " + loadCount + " bean definitions from location [" + location + "]");45}46return loadCount;47}48}49//重载方法,调用loadBeanDefinitions(String);50public int loadBeanDefinitions(String... locations) throws BeanDefinitionStoreException {51Assert.notNull(locations, "Location array must not be null");52int counter = 0;53for (String location : locations) {54counter += loadBeanDefinitions(location);55}56return 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的具体实现方法2public Resource getResource(String location) {3Assert.notNull(location, "Location must not be null");4//如果是类路径的方式,那需要使用ClassPathResource 来得到bean 文件的资源对象5if (location.startsWith(CLASSPATH_URL_PREFIX)) {6return 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}13catch (MalformedURLException ex) { 14} 15//如果既不是classpath标识,又不是URL标识的Resource定位,则调用16//容器本身的getResourceByPath方法获取Resource17return getResourceByPath(location);1819}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加载资源的入口方法2public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {3//将读入的XML资源进行特殊编码处理4return loadBeanDefinitions(new EncodedResource(resource));5}//这里是载入XML形式Bean定义资源文件方法6public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {7.......8try {9 //将资源文件转为InputStream的IO流 10InputStream inputStream = encodedResource.getResource().getInputStream();11try {12 //从InputStream中得到XML的解析源13InputSource inputSource = new InputSource(inputStream);14if (encodedResource.getEncoding() != null) {15inputSource.setEncoding(encodedResource.getEncoding());16}17//这里是具体的读取过程18return doLoadBeanDefinitions(inputSource, encodedResource.getResource());19}20finally {21//关闭从Resource中得到的IO流22inputStream.close();23}24}25 .........26}27//从特定XML文件中实际载入Bean定义资源的方法 28protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)29throws BeanDefinitionStoreException {30try {31int validationMode = getValidationModeForResource(resource);32//将XML文件转换为DOM对象,解析过程由documentLoader实现33Document doc = this.documentLoader.loadDocument(34inputSource, this.entityResolver, this.errorHandler, validationMode, this.namespaceAware);35//这里是启动对Bean定义解析的详细过程,该解析过程会用到Spring的Bean配置规则36return registerBeanDefinitions(doc, resource);37}38....... } 通过源码分析,载入Bean定义资源文件的最后一步是将Bean定义资源转换为Document对象,该过程由documentLoader实现 9、DocumentLoader将Bean定义资源转换为Document对象: DocumentLoader将Bean定义资源转换成Document对象的源码如下:1//使用标准的JAXP将载入的Bean定义资源转换成document对象2public Document loadDocument(InputSource inputSource, EntityResolver entityResolver,3ErrorHandler errorHandler, int validationMode, boolean namespaceAware) throws Exception {4//创建文件解析器工厂5DocumentBuilderFactory factory = createDocumentBuilderFactory(validationMode, namespaceAware);6if (logger.isDebugEnabled()) {7logger.debug("Using JAXP provider [" + factory.getClass().getName() + "]");8}9//创建文档解析器10DocumentBuilder builder = createDocumentBuilder(factory, entityResolver, errorHandler);11//解析Spring的Bean定义资源12return builder.parse(inputSource);13}14protected DocumentBuilderFactory createDocumentBuilderFactory(int validationMode, boolean namespaceAware)15throws ParserConfigurationException {16//创建文档解析工厂17DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();18factory.setNamespaceAware(namespaceAware);19//设置解析XML的校验20if (validationMode != XmlValidationModeDetector.VALIDATION_NONE) {21factory.setValidating(true);22if (validationMode == XmlValidationModeDetector.VALIDATION_XSD) {23factory.setNamespaceAware(true);24try {25factory.setAttribute(SCHEMA_LANGUAGE_ATTRIBUTE, XSD_SCHEMA_LANGUAGE);26}27catch (IllegalArgumentException ex) {28ParserConfigurationException 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.");32pcex.initCause(ex);33throw pcex;34}35}36}37return 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定义资源解析并转换为容器内部数据结构2public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {3//得到BeanDefinitionDocumentReader来对xml格式的BeanDefinition解析4BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();5//获得容器中注册的Bean数量6int countBefore = getRegistry().getBeanDefinitionCount();7//解析过程入口,这里使用了委派模式,BeanDefinitionDocumentReader只是个接口,//具体的解析实现过程有实现类DefaultBeanDefinitionDocumentReader完成8documentReader.registerBeanDefinitions(doc, createReaderContext(resource));9//统计解析的Bean数量10return getRegistry().getBeanDefinitionCount() - countBefore;11}12//创建BeanDefinitionDocumentReader对象,解析Document对象13protected BeanDefinitionDocumentReader createBeanDefinitionDocumentReader() {14return 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文件的各种元素10BeanDefinitionParserDelegate delegate = createHelper(readerContext, root);11//在解析Bean定义之前,进行自定义的解析,增强解析过程的可扩展性12preProcessXml(root);13//从Document的根元素开始进行Bean定义的Document对象14parseBeanDefinitions(root, delegate);15//在解析Bean定义之后,进行自定义的解析,增加解析过程的可扩展性16postProcessXml(root);17}18//创建BeanDefinitionParserDelegate,用于完成真正的解析过程19protected BeanDefinitionParserDelegate createHelper(XmlReaderContext readerContext, Element root) {20BeanDefinitionParserDelegate delegate = new BeanDefinitionParserDelegate(readerContext);21//BeanDefinitionParserDelegate初始化Document根元素22delegate.initDefaults(root);23return delegate;24}25//使用Spring的Bean规则从Document的根元素开始进行Bean定义的Document对象26protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {27//Bean定义的Document对象使用了Spring默认的XML命名空间28if (delegate.isDefaultNamespace(root)) {29//获取Bean定义的Document对象根元素的所有子节点30NodeList nl = root.getChildNodes();31for (int i = 0; i < nl.getLength(); i++) {32Node node = nl.item(i);33//获得Document节点是XML元素节点34if (node instanceof Element) {35Element ele = (Element) node;36//Bean定义的Document的元素节点使用的是Spring默认的XML命名空间37if (delegate.isDefaultNamespace(ele)) {38//使用Spring的Bean规则解析元素节点39parseDefaultElement(ele, delegate);40}41else {42//没有使用Spring默认的XML命名空间,则使用用户自定义的解//析规则解析元素节点43delegate.parseCustomElement(ele);44}45}46}47}48else {49//Document的根节点没有使用Spring默认的命名空间,则使用用户自定义的50//解析规则解析Document根节点51delegate.parseCustomElement(root);52}53}54//使用Spring的Bean规则解析Document元素节点55private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {56//如果元素节点是<Import>导入元素,进行导入解析57if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {58importBeanDefinitionResource(ele);59}60//如果元素节点是<Alias>别名元素,进行别名解析61else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {62processAliasRegistration(ele);63}64//元素节点既不是导入元素,也不是别名元素,即普通的<Bean>元素,65//按照Spring的Bean规则解析元素66else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {67processBeanDefinition(ele, delegate);68}69}70//解析<Import>导入元素,从给定的导入路径加载Bean定义资源到Spring IoC容器中71protected void importBeanDefinitionResource(Element ele) {72//获取给定的导入元素的location属性73String location = ele.getAttribute(RESOURCE_ATTRIBUTE);74//如果导入元素的location属性值为空,则没有导入任何资源,直接返回75if (!StringUtils.hasText(location)) {76getReaderContext().error("Resource location must not be empty", ele);77return;78}79//使用系统变量值解析location属性值80location = SystemPropertyUtils.resolvePlaceholders(location);81Set<Resource> actualResources = new LinkedHashSet<Resource>(4);82//标识给定的导入元素的location是否是绝对路径83boolean absoluteLocation = false;84try {85absoluteLocation = ResourcePatternUtils.isUrl(location) || ResourceUtils.toURI(location).isAbsolute();86}87catch (URISyntaxException ex) {88//给定的导入元素的location不是绝对路径89}90//给定的导入元素的location是绝对路径91if (absoluteLocation) {92try {93//使用资源读入器加载给定路径的Bean定义资源94int importCount = getReaderContext().getReader().loadBeanDefinitions(location, actualResources);95if (logger.isDebugEnabled()) {96logger.debug("Imported " + importCount + " bean definitions from URL location [" + location + "]");97}98}99catch (BeanDefinitionStoreException ex) {100getReaderContext().error(101"Failed to import bean definitions from URL location [" + location + "]", ele, ex);102}103}104else {105//给定的导入元素的location是相对路径106try {107int importCount;108//将给定导入元素的location封装为相对路径资源109Resource relativeResource = getReaderContext().getResource().createRelative(location);110//封装的相对路径资源存在111if (relativeResource.exists()) {112//使用资源读入器加载Bean定义资源113importCount = getReaderContext().getReader().loadBeanDefinitions(relativeResource);114actualResources.add(relativeResource);115}116//封装的相对路径资源不存在117else {118//获取Spring IoC容器资源读入器的基本路径119String baseLocation = getReaderContext().getResource().getURL().toString();120//根据Spring IoC容器资源读入器的基本路径加载给定导入121//路径的资源122importCount = getReaderContext().getReader().loadBeanDefinitions(123StringUtils.applyRelativePath(baseLocation, location), actualResources);124}125if (logger.isDebugEnabled()) {126logger.debug("Imported " + importCount + " bean definitions from relative location [" + location + "]");127}128}129catch (IOException ex) {130getReaderContext().error("Failed to resolve current resource location", ele, ex);131}132catch (BeanDefinitionStoreException ex) {133getReaderContext().error("Failed to import bean definitions from relative location [" + location + "]",134ele, ex);135}136}137Resource[] actResArray = actualResources.toArray(new Resource[actualResources.size()]);138//在解析完<Import>元素之后,发送容器导入其他资源处理完成事件139getReaderContext().fireImportProcessed(location, actResArray, extractSource(ele));140}141//解析<Alias>别名元素,为Bean向Spring IoC容器注册别名142protected void processAliasRegistration(Element ele) {143//获取<Alias>别名元素中name的属性值144String name = ele.getAttribute(NAME_ATTRIBUTE);145//获取<Alias>别名元素中alias的属性值146String alias = ele.getAttribute(ALIAS_ATTRIBUTE);147boolean valid = true;148//<alias>别名元素的name属性值为空149if (!StringUtils.hasText(name)) {150getReaderContext().error("Name must not be empty", ele);151valid = false;152}153//<alias>别名元素的alias属性值为空154if (!StringUtils.hasText(alias)) {155getReaderContext().error("Alias must not be empty", ele);156valid = false;157}158if (valid) {159try {160//向容器的资源读入器注册别名161getReaderContext().getRegistry().registerAlias(name, alias);162}163catch (Exception ex) {164getReaderContext().error("Failed to register alias "" + alias +165"" for bean with name "" + name + """, ele, ex);166}167//在解析完<Alias>元素之后,发送容器别名处理完成事件168getReaderContext().fireAliasRegistered(name, alias, extractSource(ele));169}170}171//解析Bean定义资源Document对象的普通元素172protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {173// BeanDefinitionHolder是对BeanDefinition的封装,即Bean定义的封装类174//对Document对象中<Bean>元素的解析由BeanDefinitionParserDelegate实现BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);175if (bdHolder != null) {176bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);177try {178 //向Spring IoC容器注册解析得到的Bean定义,这是Bean定义向IoC容器注册的入口
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());179}180catch (BeanDefinitionStoreException ex) {181getReaderContext().error("Failed to register bean definition with name "" +182bdHolder.getBeanName() + """, ele, ex);183}184//在完成向Spring IoC容器注册解析得到的Bean定义之后,发送注册事件185getReaderContext().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>元素的入口2public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {3return parseBeanDefinitionElement(ele, null);4}5//解析Bean定义资源文件中的<Bean>元素,这个方法中主要处理<Bean>元素的id,name6//和别名属性7public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) {8//获取<Bean>元素中的id属性值9String id = ele.getAttribute(ID_ATTRIBUTE);10//获取<Bean>元素中的name属性值11String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);12////获取<Bean>元素中的alias属性值13List<String> aliases = new ArrayList<String>();14//将<Bean>元素中的所有name属性值存放到别名中15if (StringUtils.hasLength(nameAttr)) {16String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, BEAN_NAME_DELIMITERS);17aliases.addAll(Arrays.asList(nameArr));18}19String beanName = id;20//如果<Bean>元素中没有配置id属性时,将别名中的第一个值赋值给beanName21if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {22beanName = aliases.remove(0);23if (logger.isDebugEnabled()) {24logger.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>元素30if (containingBean == null) {31//检查<Bean>元素所配置的id、name或者别名是否重复32checkNameUniqueness(beanName, aliases, ele);33}34//详细对<Bean>元素中配置的Bean定义进行解析的地方35AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);36if (beanDefinition != null) {37if (!StringUtils.hasText(beanName)) {38try {39if (containingBean != null) {40//如果<Bean>元素中没有配置id、别名或者name,且没有包含子//<Bean>元素,为解析的Bean生成一个唯一beanName并注册41beanName = BeanDefinitionReaderUtils.generateBeanName(42beanDefinition, this.readerContext.getRegistry(), true);43}44else {45//如果<Bean>元素中没有配置id、别名或者name,且包含了子//<Bean>元素,为解析的Bean使用别名向IoC容器注册46beanName = this.readerContext.generateBeanName(beanDefinition);47//为解析的Bean使用别名注册时,为了向后兼容//Spring1.2/2.0,给别名添加类名后缀48String beanClassName = beanDefinition.getBeanClassName();49if (beanClassName != null &&50beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&51!this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {52aliases.add(beanClassName);53}54}55if (logger.isDebugEnabled()) {56logger.debug("Neither XML "id" nor "name" specified - " +57"using generated bean name [" + beanName + "]");58}59}60catch (Exception ex) {61error(ex.getMessage(), ele);62return null;63}64}65String[] aliasesArray = StringUtils.toStringArray(aliases);66return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);67}68//当解析出错时,返回null69return null;70}71//详细对<Bean>元素中配置的Bean定义其他属性进行解析,由于上面的方法中已经对//Bean的id、name和别名等属性进行了处理,该方法中主要处理除这三个以外的其他属性数据72public AbstractBeanDefinition parseBeanDefinitionElement(73Element ele, String beanName, BeanDefinition containingBean) {74//记录解析的<Bean>75this.parseState.push(new BeanEntry(beanName));76//这里只读取<Bean>元素中配置的class名字,然后载入到BeanDefinition中去77//只是记录配置的class名字,不做实例化,对象的实例化在依赖注入时完成78String className = null;79if (ele.hasAttribute(CLASS_ATTRIBUTE)) {80className = ele.getAttribute(CLASS_ATTRIBUTE).trim();81}82try {83String parent = null;84//如果<Bean>元素中配置了parent属性,则获取parent属性的值85if (ele.hasAttribute(PARENT_ATTRIBUTE)) {86parent = ele.getAttribute(PARENT_ATTRIBUTE);87}88//根据<Bean>元素配置的class名称和parent属性值创建BeanDefinition89//为载入Bean定义信息做准备90AbstractBeanDefinition bd = createBeanDefinition(className, parent);91//对当前的<Bean>元素中配置的一些属性进行解析和设置,如配置的单态(singleton)属性等92parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);93//为<Bean>元素解析的Bean设置description信息 bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));94//对<Bean>元素的meta(元信息)属性解析95parseMetaElements(ele, bd);96//对<Bean>元素的lookup-method属性解析97parseLookupOverrideSubElements(ele, bd.getMethodOverrides());98//对<Bean>元素的replaced-method属性解析99parseReplacedMethodSubElements(ele, bd.getMethodOverrides());100//解析<Bean>元素的构造方法设置101parseConstructorArgElements(ele, bd);102//解析<Bean>元素的<property>设置103parsePropertyElements(ele, bd);104//解析<Bean>元素的qualifier属性105parseQualifierElements(ele, bd);106//为当前解析的Bean设置所需的资源和依赖对象107bd.setResource(this.readerContext.getResource());108bd.setSource(extractSource(ele));109return bd;110}111catch (ClassNotFoundException ex) {112error("Bean class [" + className + "] not found", ele, ex);113}114catch (NoClassDefFoundError err) {115error("Class that bean class [" + className + "] depends on not found", ele, err);116}117catch (Throwable ex) {118error("Unexpected failure during bean definition parsing", ele, ex);119}120finally {121this.parseState.pop();122}123//解析<Bean>元素出错时,返回null124return 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>子元素2public void parsePropertyElements(Element beanEle, BeanDefinition bd) {3//获取<Bean>元素中所有的子元素4NodeList nl = beanEle.getChildNodes();5for (int i = 0; i < nl.getLength(); i++) {6Node node = nl.item(i);7//如果子元素是<property>子元素,则调用解析<property>子元素方法解析8if (isCandidateElement(node) && nodeNameEquals(node, PROPERTY_ELEMENT)) {9parsePropertyElement((Element) node, bd);10}11}12}13//解析<property>元素14public void parsePropertyElement(Element ele, BeanDefinition bd) {15//获取<property>元素的名字 16String propertyName = ele.getAttribute(NAME_ATTRIBUTE);17if (!StringUtils.hasLength(propertyName)) {18error("Tag "property" must have a "name" attribute", ele);19return;20}21this.parseState.push(new PropertyEntry(propertyName));22try {23//如果一个Bean中已经有同名的property存在,则不进行解析,直接返回。24//即如果在同一个Bean中配置同名的property,则只有第一个起作用25if (bd.getPropertyValues().contains(propertyName)) {26error("Multiple "property" definitions for property "" + propertyName + """, ele);27return;28}29//解析获取property的值30Object val = parsePropertyValue(ele, bd, propertyName);31//根据property的名字和值创建property实例32PropertyValue pv = new PropertyValue(propertyName, val);33//解析<property>元素中的属性34parseMetaElements(ele, pv);35pv.setSource(extractSource(ele));36bd.getPropertyValues().addPropertyValue(pv);37}38finally {39this.parseState.pop();40}41}42//解析获取property值43public Object parsePropertyValue(Element ele, BeanDefinition bd, String propertyName) {44String elementName = (propertyName != null) ?45"<property> element for property "" + propertyName + """ :46"<constructor-arg> element";47//获取<property>的所有子元素,只能是其中一种类型:ref,value,list等48NodeList nl = ele.getChildNodes();49Element subElement = null;50for (int i = 0; i < nl.getLength(); i++) {51Node node = nl.item(i);52//子元素不是description和meta属性53if (node instanceof Element && !nodeNameEquals(node, DESCRIPTION_ELEMENT) &&54!nodeNameEquals(node, META_ELEMENT)) {55if (subElement != null) {56error(elementName + " must not contain more than one sub-element", ele);57}58else {//当前<property>元素包含有子元素59subElement = (Element) node;60}61}62}63//判断property的属性值是ref还是value,不允许既是ref又是value64boolean hasRefAttribute = ele.hasAttribute(REF_ATTRIBUTE);65boolean hasValueAttribute = ele.hasAttribute(VALUE_ATTRIBUTE);66if ((hasRefAttribute && hasValueAttribute) ||67((hasRefAttribute || hasValueAttribute) && subElement != null)) {68error(elementName +69" is only allowed to contain either "ref" attribute OR "value" attribute OR sub-element", ele);70}71//如果属性是ref,创建一个ref的数据对象RuntimeBeanReference,这个对象72//封装了ref信息73if (hasRefAttribute) {74String refName = ele.getAttribute(REF_ATTRIBUTE);75if (!StringUtils.hasText(refName)) {76error(elementName + " contains empty "ref" attribute", ele);77}78//一个指向运行时所依赖对象的引用79RuntimeBeanReference ref = new RuntimeBeanReference(refName);80//设置这个ref的数据对象是被当前的property对象所引用81ref.setSource(extractSource(ele));82return ref;83}84 //如果属性是value,创建一个value的数据对象TypedStringValue,这个对象85//封装了value信息86else if (hasValueAttribute) {87//一个持有String类型值的对象88TypedStringValue valueHolder = new TypedStringValue(ele.getAttribute(VALUE_ATTRIBUTE));89//设置这个value数据对象是被当前的property对象所引用90valueHolder.setSource(extractSource(ele));91return valueHolder;92}93//如果当前<property>元素还有子元素94else if (subElement != null) {95//解析<property>的子元素96return parsePropertySubElement(subElement, bd);97}98else {99//propery属性中既不是ref,也不是value属性,解析出错返回nullerror(elementName + " must specify a ref or value", ele);100return 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或者集合等子元素2public Object parsePropertySubElement(Element ele, BeanDefinition bd, String defaultValueType) {3//如果<property>没有使用Spring默认的命名空间,则使用用户自定义的规则解析//内嵌元素4if (!isDefaultNamespace(ele)) {5return parseNestedCustomElement(ele, bd);6}7//如果子元素是bean,则使用解析<Bean>元素的方法解析8else if (nodeNameEquals(ele, BEAN_ELEMENT)) {9BeanDefinitionHolder nestedBd = parseBeanDefinitionElement(ele, bd);10if (nestedBd != null) {11nestedBd = decorateBeanDefinitionIfRequired(ele, nestedBd, bd);12}13return nestedBd;14}15//如果子元素是ref,ref中只能有以下3个属性:bean、local、parent16else if (nodeNameEquals(ele, REF_ELEMENT)) {17//获取<property>元素中的bean属性值,引用其他解析的Bean的名称18//可以不再同一个Spring配置文件中,具体请参考Spring对ref的配置规则19String refName = ele.getAttribute(BEAN_REF_ATTRIBUTE);20boolean toParent = false;21if (!StringUtils.hasLength(refName)) {22 //获取<property>元素中的local属性值,引用同一个Xml文件中配置23 //的Bean的id,local和ref不同,local只能引用同一个配置文件中的Bean24refName = ele.getAttribute(LOCAL_REF_ATTRIBUTE);25if (!StringUtils.hasLength(refName)) {26//获取<property>元素中parent属性值,引用父级容器中的Bean27refName = ele.getAttribute(PARENT_REF_ATTRIBUTE);28toParent = true;29if (!StringUtils.hasLength(refName)) {30error(""bean", "local" or "parent" is required for <ref> element", ele);31return null;32}33}34}35//没有配置ref的目标属性值36if (!StringUtils.hasText(refName)) {37error("<ref> element contains empty target attribute", ele);38return null;39}40//创建ref类型数据,指向被引用的对象41RuntimeBeanReference ref = new RuntimeBeanReference(refName, toParent);42//设置引用类型值是被当前子元素所引用43ref.setSource(extractSource(ele));44return ref;45}46//如果子元素是<idref>,使用解析ref元素的方法解析47else if (nodeNameEquals(ele, IDREF_ELEMENT)) {48return parseIdRefElement(ele);49}50//如果子元素是<value>,使用解析value元素的方法解析51else if (nodeNameEquals(ele, VALUE_ELEMENT)) {52return parseValueElement(ele, defaultValueType);53}54//如果子元素是null,为<property>设置一个封装null值的字符串数据55else if (nodeNameEquals(ele, NULL_ELEMENT)) {56TypedStringValue nullHolder = new TypedStringValue(null);57nullHolder.setSource(extractSource(ele));58return nullHolder;59}60//如果子元素是<array>,使用解析array集合子元素的方法解析61else if (nodeNameEquals(ele, ARRAY_ELEMENT)) {62return parseArrayElement(ele, bd);63}64//如果子元素是<list>,使用解析list集合子元素的方法解析65else if (nodeNameEquals(ele, LIST_ELEMENT)) {66return parseListElement(ele, bd);67}68//如果子元素是<set>,使用解析set集合子元素的方法解析69else if (nodeNameEquals(ele, SET_ELEMENT)) {70return parseSetElement(ele, bd);71}72//如果子元素是<map>,使用解析map集合子元素的方法解析73else if (nodeNameEquals(ele, MAP_ELEMENT)) {74return parseMapElement(ele, bd);75}76//如果子元素是<props>,使用解析props集合子元素的方法解析77else if (nodeNameEquals(ele, PROPS_ELEMENT)) {78return parsePropsElement(ele);79}80//既不是ref,又不是value,也不是集合,则子元素配置错误,返回null81else {82error("Unknown property sub-element: [" + ele.getNodeName() + "]", ele);83return null;84}}通过上述源码分析,我们明白了在Spring配置文件中,对<property>元素中配置的Array、List、Set、Map、Prop等各种集合子元素的都通过上述方法解析,生成对应的数据对象,比如ManagedList、ManagedArray、ManagedSet等,这些Managed类是Spring对象BeanDefiniton的数据封装,对集合数据类型的具体解析有各自的解析方法实现,解析方法的命名非常规范,一目了然,我们对<list>集合元素的解析方法进行源码分析,了解其实现过程。 15、解析<list>子元素: 在BeanDefinitionParserDelegate类中的parseListElement方法就是具体实现解析<property>元素中的<list>集合子元素,源码如下:1//解析<list>集合子元素2public List parseListElement(Element collectionEle, BeanDefinition bd) {3//获取<list>元素中的value-type属性,即获取集合元素的数据类型4String defaultElementType = collectionEle.getAttribute(VALUE_TYPE_ATTRIBUTE);5//获取<list>集合元素中的所有子节点6NodeList nl = collectionEle.getChildNodes();7//Spring中将List封装为ManagedList8ManagedList<Object> target = new ManagedList<Object>(nl.getLength());9target.setSource(extractSource(collectionEle));10//设置集合目标数据类型11target.setElementTypeName(defaultElementType);12target.setMergeEnabled(parseMergeAttribute(collectionEle));13//具体的<list>元素解析14parseCollectionElements(nl, target, bd, defaultElementType);15return target;16} 17//具体解析<list>集合元素,<array>、<list>和<set>都使用该方法解析18protected void parseCollectionElements(19NodeList elementNodes, Collection<Object> target, BeanDefinition bd, String defaultElementType) {20//遍历集合所有节点21for (int i = 0; i < elementNodes.getLength(); i++) {22Node node = elementNodes.item(i);23//节点不是description节??24if (node instanceof Element && !nodeNameEquals(node, DESCRIPTION_ELEMENT)) {25//将解析的元素加入集合中,递归调用下一个子元素26target.add(parsePropertySubElement((Element) node, bd, defaultElementType));27}28}} 经过对Spring Bean定义资源文件转换的Document对象中的元素层层解析,Spring IoC现在已经将XML形式定义的Bean定义资源文件转换为Spring IoC所识别的数据结构——BeanD