Spring IOC源码详解之容器初始化

来源：互联网发布：java的scanner怎么用编辑：程序博客网时间：2024/04/27 22:17

Spring IOC源码详解之容器初始化参考：http://www.2cto.com/kf/201507/424243.html

自己总结：第一：初始化的入口在容器实现中的 refresh()调用来完成
第二：通过XmlBeanDefinitionReader中的loadBeanDefinitions方法完成资源的定义
第三：通过DefaultResourceLoader的getResource方法获取要加载的资源
第四：DocumentLoader将Bean定义资源转换成Document对象
第五：通过XmlBeanDefinitionReader中registerBeanDefinitions 解析 Document对象
第六：通过DefaultListableBeanFactory中使用一个HashMap的集合对象存放IoC容器中注册解析的 BeanDefinition

上篇介绍了Spring IOC的大致体系类图，先来看一段简短的代码，使用IOC比较典型的代码

<codeclass="java">ClassPathResource res = newClassPathResource(beans.xml);  DefaultListableBeanFactory factory = newDefaultListableBeanFactory();  XmlBeanDefinitionReader reader = newXmlBeanDefinitionReader(factory);  reader.loadBeanDefinitions(res); </code>

上面使用创建IOC经历了四个过程

创建IOC配置文件的抽象资源
创建一个BeanFactory
把读取配置信息的BeanDefinitionReader,这里是XmlBeanDefinitionReader配置给BeanFactory

从定义好的资源位置读入配置信息，具体的解析过程由XmlBeanDefinitionReader来完成，这样完成整个载入bean定义的过程。

从上面可以看出，整个IOC初始化，大致分为资源定位、资源装载、资源解析、Bean生成，Bean注册这几个过程

首先看资源的定位，一个常见的ApplicationContext

<codeclass="java"> ApplicationContext =newFileSystemXmlApplicationContext(xmlPath); </code>

追踪FileSystemXmlApplicationContext，里面有一些构造函数，都指向下面这个

<codeclass="java"> publicFileSystemXmlApplicationContext(String[] configLocations, booleanrefresh, ApplicationContext parent)            throwsBeansException {         super(parent);//有前面类图 可 以知道，最终 父类 为AbstractApplicationContext        setConfigLocations(configLocations);         if(refresh) {            refresh();        }    } </code>

<codeclass="java">//追踪super，最终定位到 AbstractApplicationContext中 publicAbstractApplicationContext() {        this.resourcePatternResolver = getResourcePatternResolver();    }      protectedResourcePatternResolver getResourcePatternResolver() {        returnnew PathMatchingResourcePatternResolver(this);    }</code>

继续往下，追踪setConfigLocations方法

<codeclass="java">   publicvoid setConfigLocations(String... locations) {        if(locations != null) {            Assert.noNullElements(locations, Config locations must not be null);            this.configLocations = newString[locations.length]; // 该方法调用 SystemPropertyUtils.resolvePlaceholders(path) ；对 path 中的占位 符进行 //  替换， eg ： path 路径中含有 ${user.dir} ，则将替换为： System.getProperty(user.dir);            for(inti = 0; i < locations.length; i++) {                this.configLocations[i] = resolvePath(locations[i]).trim();            }        }        else{            this.configLocations = null;        }    }  </code>

<code>     代码中 configLocations 为 AbstractRefreshableConfigApplicationContext 类中 string[] 类型的字段。至此应用程序传入路径保存在 AbstractRefreshableConfigApplicationContext 中 。</code>

回到FileSystemXmlApplicationContext中继续往下，即最关键的Refash方法，refresh()-方法定义在类： AbstractApplicationContext ，由类图可知： FileSystemXmlApplicationContext 间接继承至： AbstractApplicationContext refresh() 方法如下：

<codeclass="java">publicvoid refresh() throwsBeansException, IllegalStateException {         synchronized(this.startupShutdownMonitor) {             //调用容器准备刷新的方法，获取 容器的当时时间，同时给容器设置同步标识             prepareRefresh();            //告诉子类启动refreshBeanFactory()方法，Bean定义资源文件的载入从           //子类的refreshBeanFactory()方法启动            ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();             //为BeanFactory配置容器特性，例如类加载器、事件处理器等            prepareBeanFactory(beanFactory);            try{                 //为容器的某些子类指定特殊的BeanPost事件处理器                postProcessBeanFactory(beanFactory);                //调用所有注册的BeanFactoryPostProcessor的Bean                invokeBeanFactoryPostProcessors(beanFactory);                //为BeanFactory注册BeanPost事件处理器.                //BeanPostProcessor是Bean后置处理器，用于监听容器触发的事件                registerBeanPostProcessors(beanFactory);                //初始化信息源，和国际化相关.                initMessageSource();                //初始化容器事件传播器.                initApplicationEventMulticaster();                //调用子类的某些特殊Bean初始化方法                onRefresh();                //为事件传播器注册事件监听器.                registerListeners();                //初始化所有剩余的单态Bean.                finishBeanFactoryInitialization(beanFactory);                //初始化容器的生命周期事件处理器，并发布容器的生命周期事件                finishRefresh();            }            catch(BeansException ex) {                 //销毁以创建的单态Bean                destroyBeans();                //取消refresh操作，重置容器的同步标识.                cancelRefresh(ex);                throwex;             }        }    } </code>

obtainFreshBeanFactory() ：让子类刷新内部 bean 工厂。
进入obtainFreshBeanFatory（），关闭前面所有 bean 工厂，为新的上下文环境初始化一个新的 bean 工厂。这里需要子类来协助完成资源位置定义 ,bean 载入和向 IOC 容器注册的过程

<codeclass="java">protectedConfigurableListableBeanFactory obtainFreshBeanFactory() {        refreshBeanFactory();        ConfigurableListableBeanFactory beanFactory = getBeanFactory();        if(logger.isDebugEnabled()) {            logger.debug(Bean factory for + getDisplayName() + :  + beanFactory);        }        returnbeanFactory;    } </code>

上面代码可以看到refreshBeanFactory，AbstractApplicationContext子类中的方法 AbstractApplicationContext类中只抽象定义了refreshBeanFactory()方法，容器真正调用的是其子类AbstractRefreshableApplicationContext实现的 refreshBeanFactory()方法，方法的源码如下

<codeclass="java">protectedfinal void refreshBeanFactory() throwsBeansException {         if(hasBeanFactory()) {//如果已经有容器，销 毁 容器中的bean，关闭容器             destroyBeans();            closeBeanFactory();        }        try{              //创建IoC容器             DefaultListableBeanFactory beanFactory = createBeanFactory();              beanFactory.setSerializationId(getId());            //对IoC容器进行定制化，如设置启动参数，开启注解的自动装配等            customizeBeanFactory(beanFactory);            //调用载入Bean定义的方法，主要这里使用了一个委派模式，在当前类中只定义了抽象的loadBeanDefinitions方法，具体的实现调用子类容器            loadBeanDefinitions(beanFactory);            synchronized(this.beanFactoryMonitor) {                 this.beanFactory = beanFactory;             }        }        catch(IOException ex) {             thrownew ApplicationContextException(I/O error parsing bean definition source for + getDisplayName(), ex);         }    }</code>

<code>    在这个方法中，先判断BeanFactory是否存在，如果存在则先销毁beans并关闭beanFactory，接着创建DefaultListableBeanFactory，并调用loadBeanDefinitions(beanFactory)装载bean</code>

在这个方法中，先判断BeanFactory是否存在，如果存在则先销毁beans并关闭beanFactory，接着创建DefaultListableBeanFactory，并调用loadBeanDefinitions(beanFactory)装载bean定义。看上面的loadBeanDefinitions，在AbstractRefreshableApplicationContext子类。

?
1
2
<code>同样，AbstractRefreshableApplicationContext中只定义了抽象的loadBeanDefinitions方法，容器真正调用的是其子类AbstractXmlApplicationContext对该方法的实现，AbstractXmlApplicationContext的主要源码如下：
</code>

<codeclass="java">   protectedvoid loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throwsIOException {        // 这里使用XMLBeanDefinitionReader来载入bean定义信息的XML文件        XmlBeanDefinitionReader beanDefinitionReader = newXmlBeanDefinitionReader(beanFactory);         //这里配置reader的环境，其中ResourceLoader是我们用来定位bean定义信息资源位置的        ///因为上下文本身实现了ResourceLoader接口，所以可以直接把上下文作为ResourceLoader传递给XmlBeanDefinitionReader        beanDefinitionReader.setResourceLoader(this);        beanDefinitionReader.setEntityResolver(newResourceEntityResolver(this));         initBeanDefinitionReader(beanDefinitionReader);        //这里转到定义好的XmlBeanDefinitionReader中对载入bean信息进行处理         loadBeanDefinitions(beanDefinitionReader);    } </code>

继续，看到了最下面的loadBeanDefinitions(beanDefinitionReader);转到XmlBeanDefinitionReader中的loadBeanDefinitions。

<codeclass="java">protectedvoid loadBeanDefinitions(XmlBeanDefinitionReader reader) throwsBeansException, IOException {        Resource[] configResources = getConfigResources();        if(configResources != null) {        //调用XmlBeanDefinitionReader来载入bean定义信息。            reader.loadBeanDefinitions(configResources);        }        String[] configLocations = getConfigLocations();        if(configLocations != null) {            reader.loadBeanDefinitions(configLocations);        }    } </code>

?
1
2
<code>    Xml Bean读取器(XmlBeanDefinitionReader)调用其父类AbstractBeanDefinitionReader的 reader.loadBeanDefinitions方法读取Bean定义资源。
</code>

由于我们使用FileSystemXmlApplicationContext作为例子分析，因此getConfigResources的返回值为null，因此程序执行reader.loadBeanDefinitions(configLocations)分支。

<codeclass="java">   publicint loadBeanDefinitions(String location) throwsBeanDefinitionStoreException {      //这里得到当前定义的ResourceLoader,默认的 我 们 使用DefaultResourceLoader     ResourceLoader resourceLoader = getResourceLoader();     .........//如果没有找到我们需要的ResourceLoader，直接抛出异常        if(resourceLoader instanceofResourcePatternResolver) {            // 这里处理我们在定义位置时使用的各种pattern,需要ResourcePatternResolver来完成            try{                Resource[] resources = ((ResourcePatternResolver) resourceLoader).getResources(location);                intloadCount = loadBeanDefinitions(resources);                returnloadCount;            }          ........        }        else{            // 这里通过ResourceLoader来完成位置定位            Resource resource = resourceLoader.getResource(location);            // 这里已经把一个位置定义转化为Resource接口，可以供XmlBeanDefinitionReader来使用了            intloadCount = loadBeanDefinitions(resource);            returnloadCount;        }    } </code>

<codeclass="java">重载方法 publicint loadBeanDefinitions(String... locations) throwsBeanDefinitionStoreException {        Assert.notNull(locations, Location array must not be null);        intcounter = 0;        for(String location : locations) {            counter += loadBeanDefinitions(location);        }        returncounter;    }</code>

loadBeanDefinitions(Resource...resources)方法和上面分析的3个方法类似，同样也是调用XmlBeanDefinitionReader的loadBeanDefinitions方法。

从对AbstractBeanDefinitionReader的loadBeanDefinitions方法源码分析可以看出该方法做了以下两件事：

首先，调用资源加载器的获取资源方法resourceLoader.getResource(location)，获取到要加载的资源。

其次，真正执行加载功能是其子类XmlBeanDefinitionReader的loadBeanDefinitions方法。

由上类图可以知道此时调用的是DefaultResourceLoader中的getSource()方法定位Resource，因为FileSystemXmlApplicationContext本身就是DefaultResourceLoader的实现类。

2、资源加载

XmlBeanDefinitionReader通过调用其父类DefaultResourceLoader的getResource方法获取要加载的资源，这样，就可以从文件系统路径上对IOC配置文件进行加载 - 当然可以按照这个逻辑从任何地方加载，在Spring中看到它提供的各种资源抽象，比如ClassPathResource, URLResource,FileSystemResource等来供我们使用。

<codeclass="java">//获取Resource的具 体实现方法     publicResource getResource(String location) {         Assert.notNull(location, Location must not be null);        //如果是类路径的方式，那需要使用ClassPathResource 来得到bean 文件的资源对象         if(location.startsWith(CLASSPATH_URL_PREFIX)) {             returnnew ClassPathResource(location.substring(CLASSPATH_URL_PREFIX.length()), getClassLoader());        }         try{               // 如果是URL 方式，使用UrlResource 作为bean 文件的资源对象              URL url = newURL(location);              returnnew UrlResource(url);             }            catch(MalformedURLException ex) {            }           //如果既不是classpath标识，又不是URL标识的Resource定位，则调用            //容器本身的getResourceByPath方法获取Resource            returngetResourceByPath(location);      }</code>

FileSystemXmlApplicationContext容器提供了getResourceByPath方法的实现，就是为了处理既不是classpath标识，又不是URL标识的Resource定位这种情况

?
1
2
3
4
5
6
7
8
9
<codeclass="java">@Override
    protectedResource getResourceByPath(String path) {
        if(path != null&& path.startsWith(/)) {
            path = path.substring(1);
        }
        returnnewFileSystemResource(path);
    }
 
</code>

所以此时又回到了FileSystemXmlApplicationContext中来,提供了FileSystemResource来完成从文件系统得到配置文件的资源定义。

Bean资源加载

继续XmlBeanDefinitionReader的loadBeanDefinitions(Resource …)

<codeclass="java">//XmlBeanDefinitionReader加载资源 的入口方法     publicint loadBeanDefinitions(Resource resource) throwsBeanDefinitionStoreException {         //将读入的XML资源进行特殊编码处理        returnloadBeanDefinitions(newEncodedResource(resource));     }     //这里是载入XML形式Bean定义资源文件方法   publicint loadBeanDefinitions(EncodedResource encodedResource) throwsBeanDefinitionStoreException {       .......      try{            //将资源文件转为InputStream的IO流       InputStream inputStream = encodedResource.getResource().getInputStream();           try{              //从InputStream中得到XML的解析源              InputSource inputSource = newInputSource(inputStream);               if(encodedResource.getEncoding() != null) {                   inputSource.setEncoding(encodedResource.getEncoding());              }              //这里是具体的读取过程              returndoLoadBeanDefinitions(inputSource, encodedResource.getResource());           }          finally{               //关闭从Resource中得到的IO流              inputStream.close();          }      }         .........   26}      //从特定XML文件中实际载入Bean定义资源的方法   protectedint doLoadBeanDefinitions(InputSource inputSource, Resource resource)           throwsBeanDefinitionStoreException {       try{           intvalidationMode = getValidationModeForResource(resource);           //将XML文件转换为DOM对象，解析过程由documentLoader实现          Document doc = this.documentLoader.loadDocument(                  inputSource,this.entityResolver,this.errorHandler, validationMode, this.namespaceAware);          //这里是启动对Bean定义解析的详细过程，该解析过程会用到Spring的Bean配置规则       returnregisterBeanDefinitions(doc, resource);         }        .......        }</code>

源码的最后，将XML文件转为DOM对象，即将Bean对象转成DOm资源。这是如何完成的呢？

3、资源解析

2中Bean定义的Resource得到了，最后还讲到ocumentLoader将Bean定义资源转换为Document对象：DocumentLoader将Bean定义资源转换成Document对象的源码如下：

?
1
2
3
4
<codeclass="java">下面这句是XmlBeanDefinitionReader中关于DocumentLoader，用了DefaultDocumentLoader
 
privateDocumentLoader documentLoader = newDefaultDocumentLoader();
</code>

上面的DefaultDocumentLoader肯定不陌生吧，在Spring AOP中多次出现了，找到DefaultDocumentLoader中的loadDocument()方法

<codeclass="java">//使用标准的JAXP 将 载入的B ean 定义 资源 转换成document对象     publicDocument loadDocument(InputSource inputSource, EntityResolver entityResolver,             ErrorHandler errorHandler, intvalidationMode, booleannamespaceAware) throwsException {         //创建文件解析器工厂        DocumentBuilderFactory factory = createDocumentBuilderFactory(validationMode, namespaceAware);         if(logger.isDebugEnabled()) {             logger.debug(Using JAXP provider [ + factory.getClass().getName() + ]);         }        //创建文档解析器        DocumentBuilder builder = createDocumentBuilder(factory, entityResolver, errorHandler);         //解析Spring的Bean定义资源        returnbuilder.parse(inputSource);     }  </code>

继续找到createDocumentBuilder

<codeclass="java">   protectedDocumentBuilder createDocumentBuilder(            DocumentBuilderFactory factory, EntityResolver entityResolver, ErrorHandler errorHandler)            throwsParserConfigurationException {         DocumentBuilder docBuilder = factory.newDocumentBuilder();        if(entityResolver != null) {            docBuilder.setEntityResolver(entityResolver);        }        if(errorHandler != null) {            docBuilder.setErrorHandler(errorHandler);        }        returndocBuilder;    }</code>

上面调用了Javaee的JAXP标准，根据定位的Bean定义资源文件，加载读入并转换成为Document对象过程完成

4、bean生成（根据DOM资源解析成bean）

回顾3： XmlBeanDefinitionReader类中的doLoadBeanDefinitions方法是从特定XML文件中实际载入Bean定义资源的方法，该方法在载入Bean定义资源之后将其转换为Document对象。继续看doLoadBeanDefinitions，进入registerBeanDefinitions

?
1
2
<code> Document doc = this.documentLoader.loadDocument(）后面，有一句returnregisterBeanDefinitions(doc, resource); 
</code>

<codeclass="java">//按照Spring的Bean语义要求 将Bean 定 义  资源解析并转换为容器内部数据结构     publicint registerBeanDefinitions(Document doc, Resource resource) throwsBeanDefinitionStoreException {         //得到BeanDefinitionDocumentReader来对xml格式的BeanDefinition解析        BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();         //获得容器中注册的Bean数量        intcountBefore = getRegistry().getBeanDefinitionCount();         //解析过程入口，这里使用了委派模式，BeanDefinitionDocumentReader只是个接口，//具体的解析实现过程有实现类DefaultBeanDefinitionDocumentReader完成        documentReader.registerBeanDefinitions(doc, createReaderContext(resource));         //统计解析的Bean数量        returngetRegistry().getBeanDefinitionCount() - countBefore;     } </code>

?
1
2
3
4
5
<codeclass="java">  //创建BeanDefinitionDocumentReader对象， 解 析 D ocument对象  
   protectedBeanDefinitionDocumentReader createBeanDefinitionDocumentReader() {  
       returnBeanDefinitionDocumentReader.class.cast(BeanUtils.instantiateClass(this.documentReaderClass)); 
      }
</code>

Bean定义资源的载入解析分为以下两个过程：

首先，通过调用XML解析器将Bean定义资源文件转换得到Document对象，但是这些Document对象并没有按照Spring的Bean规则进行解析。这一步是载入的过程

其次，在完成通用的XML解析之后，按照Spring的Bean规则对Document对象进行解析。

继续

?
1
2
3
4
<codeclass="java">documentReader.registerBeanDefinitions(doc, createReaderContext(resource)); 
 
这里的documentReader为BeanDefinitionDocumentReader对象，BeanDefinitionDocumentReader接口通过registerBeanDefinitions方法调用其实现类DefaultBeanDefinitionDocumentReader对Document对象进行解析
</code>

?
1
2
3
4
5
6
7
8
<codeclass="java">publicvoidregisterBeanDefinitions(Document doc, XmlReaderContext readerContext) {
        this.readerContext = readerContext;//获得XML  描 述 符  
        logger.debug(Loading bean definitions);
        Element root = doc.getDocumentElement();//获得Document的根元素 
        doRegisterBeanDefinitions(root);
    }
 
</code>

<codeclass="java">    protectedvoid doRegisterBeanDefinitions(Element root) {  //BeanDefinitionParserDelegate中定义了Spring Bean 定 义 XML 文件的各种元素        BeanDefinitionParserDelegate parent = this.delegate;        this.delegate = createDelegate(getReaderContext(), root, parent);//下面有解析         if(this.delegate.isDefaultNamespace(root)) { //这里应该是判断是否使用默认命名空间            String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);            if(StringUtils.hasText(profileSpec)) {                String[] specifiedProfiles = StringUtils.tokenizeToStringArray(                        profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);                if(!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {                    return;                }            }        }          //在解析Bean定义之前，进行自定义的解析，增强解析过程的可扩展性         preProcessXml(root);          //从Document的根元素开始进行Bean定义的Document对象，见下面解析        parseBeanDefinitions(root,this.delegate);         //在解析Bean定义之后，进行自定义的解析，增加解析过程的可扩展性         postProcessXml(root);         this.delegate = parent;    }</code>

?
1
2
3
4
5
6
7
8
9
10
11
12
<codeclass="java">//上面的createDelegate（）方法， 创建BeanDefinitionParserDelegate，用于完成真正的解析过程  
protectedBeanDefinitionParserDelegate createDelegate(
            XmlReaderContext readerContext, Element root, BeanDefinitionParserDelegate parentDelegate) {
 
        BeanDefinitionParserDelegate delegate = newBeanDefinitionParserDelegate(readerContext);
 
 //BeanDefinitionParserDelegate初始化Document根元素 
 
        delegate.initDefaults(root, parentDelegate);
        returndelegate;
    }
</code>

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
<codeclass="java">//上面的parseBeanDefinitions
 
// 使 用Spring的Bean规则从Document的根元素开始进行Bean定义的Document对象 
 
protectedvoidparseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
 
         //Bean定义的Document对象使用了Spring默认的XML命名空间       
        if(delegate.isDefaultNamespace(root)) {
 
             //获取Bean定义的Document对象根元素的所有子节点 
            NodeList nl = root.getChildNodes();
            for(inti = 0; i < nl.getLength(); i++) {
 
                //获得Document节点是XML元素节点 
                Node node = nl.item(i); 
                if(nodeinstanceofElement) {
                    Element ele = (Element) node;
                    if(delegate.isDefaultNamespace(ele)) {
                     //如果使用的是默认命名控件，使用Spring的Bean规则解析元素节点 
                        parseDefaultElement(ele, delegate);
                    }
                    else{
                    //没有使用Spring默认的XML命名空间，则使用用户自定义的解//析规则解析元素节点
                        delegate.parseCustomElement(ele);
                    }
                }
            }
        }
        else{
        //使用默认解析规则解析Document根节点 
            delegate.parseCustomElement(root);
        }
    }
</code>

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<codeclass="java">//使用默 认 规 则 是个什么样子呢
    privatevoidparseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
 
        //元素节点是IMPORT导入
        if(delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
            importBeanDefinitionResource(ele);
        }
        //元素节点是Alias相关
        elseif(delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
            processAliasRegistration(ele);
        }
        //元素节点是Bean元素
        elseif(delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
            processBeanDefinition(ele, delegate);
        }
 
        elseif(delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
            // recurse
            doRegisterBeanDefinitions(ele);
        }
    }
 
 
</code>

上面代码的三中Import、Alials、Bean我们主要来看Bean的解析，追踪processBeanDefinition(ele, delegate

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<codeclass="java">protectedvoidprocessBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
 
 //委托给BeanDefinitionParserDelegate来完成对bean元素的 处 理  ，这个类包含了具体的bean解析的过程。  
 // 把解析bean文件得到的信息放到BeanDefinition里，他是bean信息的主要载体，也是IOC容器的管理对象。  
//BeanDefinitionHolder是对BeanDefinition的封装，即Bean定义的封装类
 
        BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
 
        if(bdHolder != null) {//如果存在bean定义的话
 
     //对Document对象中<bean>元素的解析由BeanDefinitionParserDelegate实现
 
            bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
            try{
                //向Spring IoC容器注册解析得到的Bean定义，这是Bean定义向IoC容器注册的入口 ，实际上是放到一个Map里面 
                BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
            }
            catch(BeanDefinitionStoreException ex) {
                getReaderContext().error(Failed to register bean definition with name ' +
                        bdHolder.getBeanName() + ', ele, ex);
            }
              //在完成向Spring IoC容器注册解析得到的Bean定义之后，发送注册事件 
            getReaderContext().fireComponentRegistered(newBeanComponentDefinition(bdHolder));
        }
    }
</bean></code>

这里其实还可以深入了解，bean的解析，追踪上面的这条

?
1
2
<code>BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
</code>

可以进入parseBeanDefinitionElement方法中，里面详细讲了Bean元素是如何解析的。

?
1
2
3
4
5
6
<codeclass="java">//解析<bean>元素的入口 
   publicBeanDefinitionHolder parseBeanDefinitionElement(Element ele) {  
       returnparseBeanDefinitionElement(ele,null); 
   } 
 
</bean></code>

<codeclass="java">  //解析Bean定义资源文件中的<bean>元素，这个 方 法中主要处理<bean>元素的id，name     //和别名属性    publicBeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) {        //获取<bean>元素中的id属性值        String id = ele.getAttribute(ID_ATTRIBUTE);         //获取<bean>元素中的name属性值        String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);         ////获取<bean>元素中的alias属性值        List<string> aliases = newArrayList<string>();         //将<bean>元素中的所有name属性值存放到别名中        if(StringUtils.hasLength(nameAttr)) {             String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, BEAN_NAME_DELIMITERS);             aliases.addAll(Arrays.asList(nameArr));        }        String beanName = id;         //如果<bean>元素中没有配置id属性时，将别名中的第一个值赋值给beanName        if(!StringUtils.hasText(beanName) && !aliases.isEmpty()) {             beanName = aliases.remove(0);            if(logger.isDebugEnabled()) {                 logger.debug(No XML 'id'specified - using ' + beanName +                         ' as bean name and  + aliases +  as aliases);             }        }        //检查<bean>元素所配置的id或者name的唯一性，containingBean标识<bean>        //元素中是否包含子<bean>元素        if(containingBean == null) {             //检查<bean>元素所配置的id、name或者别名是否重复            checkNameUniqueness(beanName, aliases, ele);         }        //详细对<bean>元素中配置的Bean定义进行解析的地方        AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);         if(beanDefinition != null) {             if(!StringUtils.hasText(beanName)) {                 try{                     if(containingBean != null) {                         //如果<bean>元素中没有配置id、别名或者name，且没有包含子//<bean>元素，为解析的Bean生成一个唯一beanName并注册                        beanName = BeanDefinitionReaderUtils.generateBeanName(                                 beanDefinition,this.readerContext.getRegistry(),true);                    }                    else{                         //如果<bean>元素中没有配置id、别名或者name，且包含了子//<bean>元素，为解析的Bean使用别名向IoC容器注册                        beanName = this.readerContext.generateBeanName(beanDefinition);                        //为解析的Bean使用别名注册时，为了向后兼容                                    //Spring1.2/2.0，给别名添加类名后缀                         String beanClassName = beanDefinition.getBeanClassName();                         if(beanClassName != null&&                                 beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&                                 !this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {                             aliases.add(beanClassName);                        }                    }                    if(logger.isDebugEnabled()) {                         logger.debug(Neither XML 'id'nor 'name'specified -  +                                 using generated bean name [ + beanName + ]);                     }                }                catch(Exception ex) {                     error(ex.getMessage(), ele);                     returnnull;                }            }            String[] aliasesArray = StringUtils.toStringArray(aliases);             returnnew BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);         }        //当解析出错时，返回null        returnnull;    }    //详细对<bean>元素中配置的Bean定义其他属性进行解析，由于上面的方法中已经对//Bean的id、name和别名等属性进行了处理，该方法中主要处理除这三个以外的其他属性数据    publicAbstractBeanDefinition parseBeanDefinitionElement(             Element ele, String beanName, BeanDefinition containingBean) {         //记录解析的<bean>        this.parseState.push(newBeanEntry(beanName));         //这里只读取<bean>元素中配置的class名字，然后载入到BeanDefinition中去        //只是记录配置的class名字，不做实例化，对象的实例化在依赖注入时完成        String className = null;        if(ele.hasAttribute(CLASS_ATTRIBUTE)) {             className = ele.getAttribute(CLASS_ATTRIBUTE).trim();         }        try{             String parent = null;            //如果<bean>元素中配置了parent属性，则获取parent属性的值            if(ele.hasAttribute(PARENT_ATTRIBUTE)) {                 parent = ele.getAttribute(PARENT_ATTRIBUTE);             }            //根据<bean>元素配置的class名称和parent属性值创建BeanDefinition            //为载入Bean定义信息做准备            AbstractBeanDefinition bd = createBeanDefinition(className, parent);             //对当前的<bean>元素中配置的一些属性进行解析和设置，如配置的单态(singleton)属性等            parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);             //为<bean>元素解析的Bean设置description信息 bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));            //对<bean>元素的meta(元信息)属性解析            parseMetaElements(ele, bd);             //对<bean>元素的lookup-method属性解析            parseLookupOverrideSubElements(ele, bd.getMethodOverrides());             //对<bean>元素的replaced-method属性解析            parseReplacedMethodSubElements(ele, bd.getMethodOverrides());             //解析<bean>元素的构造方法设置            parseConstructorArgElements(ele, bd);             //解析<bean>元素的<property>设置            parsePropertyElements(ele, bd);             //解析<bean>元素的qualifier属性            parseQualifierElements(ele, bd);             //为当前解析的Bean设置所需的资源和依赖对象            bd.setResource(this.readerContext.getResource());            bd.setSource(extractSource(ele));            returnbd;         }        catch(ClassNotFoundException ex) {             error(Beanclass[ + className + ] not found, ele, ex);         }        catch(NoClassDefFoundError err) {             error(Class that bean class[ + className + ] depends on not found, ele, err);         }        catch(Throwable ex) {             error(Unexpected failure during bean definition parsing, ele, ex);         }        finally{             this.parseState.pop();        }        //解析<bean>元素出错时，返回null        returnnull;    } </bean></bean></property></bean></bean></bean></bean></bean></bean></bean></bean></bean></bean></bean></bean></bean></bean></bean></bean></bean></bean></bean></bean></bean></bean></bean></string></string></bean></bean></bean></bean></bean></code>

上面方法中一些对一些配置如元信息(meta)、qualifier等的解析，我们在Spring中配置时使用的也不多，我们在使用Spring的元素时，配置最多的是property属性

<codeclass="java">   //解析<property>元素中ref,value或者集合等子元素    publicObject parsePropertySubElement(Element ele, BeanDefinition bd, String defaultValueType) {        //如果<property>没有使用Spring默认的命名空间，则使用用户自定义的规则解析//内嵌元素        if(!isDefaultNamespace(ele)) {             returnparseNestedCustomElement(ele, bd);         }        //如果子元素是bean，则使用解析<bean>元素的方法解析        elseif (nodeNameEquals(ele, BEAN_ELEMENT)) {             BeanDefinitionHolder nestedBd = parseBeanDefinitionElement(ele, bd);             if(nestedBd != null) {                 nestedBd = decorateBeanDefinitionIfRequired(ele, nestedBd, bd);             }            returnnestedBd;         }        //如果子元素是ref，ref中只能有以下3个属性：bean、local、parent        elseif (nodeNameEquals(ele, REF_ELEMENT)) {             //获取<property>元素中的bean属性值，引用其他解析的Bean的名称            //可以不再同一个Spring配置文件中，具体请参考Spring对ref的配置规则            String refName = ele.getAttribute(BEAN_REF_ATTRIBUTE);             booleantoParent = false;            if(!StringUtils.hasLength(refName)) {                  //获取<property>元素中的local属性值，引用同一个Xml文件中配置                 //的Bean的id，local和ref不同，local只能引用同一个配置文件中的Bean                refName = ele.getAttribute(LOCAL_REF_ATTRIBUTE);                 if(!StringUtils.hasLength(refName)) {                     //获取<property>元素中parent属性值，引用父级容器中的Bean                    refName = ele.getAttribute(PARENT_REF_ATTRIBUTE);                     toParent = true;                    if(!StringUtils.hasLength(refName)) {                         error('bean','local'or 'parent'is required for<ref> element, ele);                         returnnull;                    }                }            }            //没有配置ref的目标属性值            if(!StringUtils.hasText(refName)) {                 error(<ref> element contains empty target attribute, ele);                 returnnull;            }            //创建ref类型数据，指向被引用的对象            RuntimeBeanReference ref = newRuntimeBeanReference(refName, toParent);             //设置引用类型值是被当前子元素所引用            ref.setSource(extractSource(ele));            returnref;         }        //如果子元素是<idref>，使用解析ref元素的方法解析        elseif (nodeNameEquals(ele, IDREF_ELEMENT)) {             returnparseIdRefElement(ele);         }        //如果子元素是<value>，使用解析value元素的方法解析        elseif (nodeNameEquals(ele, VALUE_ELEMENT)) {             returnparseValueElement(ele, defaultValueType);         }        //如果子元素是null，为<property>设置一个封装null值的字符串数据        elseif (nodeNameEquals(ele, NULL_ELEMENT)) {             TypedStringValue nullHolder = newTypedStringValue(null);            nullHolder.setSource(extractSource(ele));            returnnullHolder;         }        //如果子元素是，使用解析array集合子元素的方法解析        elseif (nodeNameEquals(ele, ARRAY_ELEMENT)) {             returnparseArrayElement(ele, bd);         }        //如果子元素是<list>，使用解析list集合子元素的方法解析        elseif (nodeNameEquals(ele, LIST_ELEMENT)) {             returnparseListElement(ele, bd);         }        //如果子元素是<set>，使用解析set集合子元素的方法解析        elseif (nodeNameEquals(ele, SET_ELEMENT)) {             returnparseSetElement(ele, bd);         }        //如果子元素是<map>，使用解析map集合子元素的方法解析        elseif (nodeNameEquals(ele, MAP_ELEMENT)) {             returnparseMapElement(ele, bd);         }        //如果子元素是<props>，使用解析props集合子元素的方法解析        elseif (nodeNameEquals(ele, PROPS_ELEMENT)) {             returnparsePropsElement(ele);         }        //既不是ref，又不是value，也不是集合，则子元素配置错误，返回null        else{             error(Unknown property sub-element: [ + ele.getNodeName() + ], ele);             returnnull;        }     }</props></map></set></list></array></property></value></idref></ref></ref></property></property></property></bean></property></property></code>

上面代码中对property元素中配置的Array、List、Set、Map、Prop等各种集合子元素的都通过上述方法解析，生成对应的数据对象，比如ManagedList、ManagedArray、ManagedSet等，这些Managed类是Spring对象BeanDefiniton的数据封装，对集合数据类型的具体解析有各自的解析方法实现。如果想了解其中的一种集合是如何解析的，进入相应的方法。

5、Bean是如何在IOC容器中注册的

下面看解析完的bean是怎样在IOC容器中注册的：接着4中的代码，进入

?
1
2
<code>BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
</code>

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<codeclass="java">   publicstaticvoidregisterBeanDefinition(
            BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
            throwsBeanDefinitionStoreException {
 
        //得到需要 注册 的 bean名字
        String beanName = definitionHolder.getBeanName();
        //开始注册
        registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
 
        // 别名也是可以 通过IOC容器和bean联系起来的进行注册 
        String[] aliases = definitionHolder.getAliases();
        if(aliases != null) {
            for(String alias : aliases) {
                registry.registerAlias(beanName, alias);
            }
        }
    }
</code>

?
1
2
<code>上面的registry对象是BeanDefinitionRegistry，上一步是BeanDefinitionReaderUtils.registerBeanDefinition(),即当调用BeanDefinitionReaderUtils向IoC容器注册解析的BeanDefinition时，真正完成注册功能的是DefaultListableBeanFactory。那么DefaultListableBeanFactory怎么会和BeanDefinitionReaderUtils扯到一起呢？
</code>

其实上面的类图还忽略了一点，就是

?
1
2
3
4
5
6
7
<codeclass="java">publicclassDefaultListableBeanFactoryextendsAbstractAutowireCapableBeanFactory
        implementsConfigurableListableBeanFactory, BeanDefinitionRegistry, Serializable {}
 
 
DefaultListableBeanFactory 实现了BeanDefinitionRegistry接口，这下就豁然开朗，那么DefaultListableBeanFactory是如何注册的呢
 
</code>

DefaultListableBeanFactory中使用一个HashMap的集合对象存放IoC容器中注册解析的BeanDefinition，

<codeclass="java">@Override    //---------------------------------------------------------------------    // 这里是IOC容器对BeanDefinitionRegistry接口的实现    //---------------------------------------------------------------------     publicvoid registerBeanDefinition(String beanName, BeanDefinition beanDefinition)            throwsBeanDefinitionStoreException {         .....//这里省略了对BeanDefinition的验证过程        //先看看在容器里是不是已经有了同名的bean,如果有抛出异常。        Object oldBeanDefinition = this.beanDefinitionMap.get(beanName);        if(oldBeanDefinition != null) {            if(!this.allowBeanDefinitionOverriding) {            ...........        }        else{            //把bean的名字加到IOC容器中去            this.beanDefinitionNames.add(beanName);        }        //这里把bean的名字和Bean定义联系起来放到一个HashMap中去,IOC容器通过这个Map来维护容器里的Bean定义信息。        this.beanDefinitionMap.put(beanName, beanDefinition);        removeSingleton(beanName);    }  </code>

<codeclass="java">@Override
    //---------------------------------------------------------------------
    // 这里是IOC容器对BeanDefinitionRegistry接口的实现
    //---------------------------------------------------------------------
 
    publicvoidregisterBeanDefinition(String beanName, BeanDefinition beanDefinition)
            throwsBeanDefinitionStoreException {
 
        .....//这里省略了对BeanDefinition的验证过程
        //先看看在容器里是不是已经有了同名的bean,如果有抛出异常。
        Object oldBeanDefinition = this.beanDefinitionMap.get(beanName);
        if(oldBeanDefinition != null) {
            if(!this.allowBeanDefinitionOverriding) {
            ...........
        }
        else{
            //把bean的名字加到IOC容器中去
            this.beanDefinitionNames.add(beanName);
        }
        //这里把bean的名字和Bean定义联系起来放到一个HashMap中去,IOC容器通过这个Map来维护容器里的Bean定义信息。
        this.beanDefinitionMap.put(beanName, beanDefinition);
        removeSingleton(beanName);
    }
 
 
</code>

这样就完成了Bean定义在IOC容器中的注册，就可被IOC容器进行管理和使用了

总结IOC初始化过程

1、setConfigLocations方法
2、初始化的入口在容器实现中的 refresh()调用来完成
3、AbstractRefreshableApplicationContext实现的 refreshBeanFactory()方法
4、创建DefaultListableBeanFactory，并调用loadBeanDefinitions(beanFactory)装载bean定义
5、转到XmlBeanDefinitionReader中的loadBeanDefinitions。
6、XmlBeanDefinitionReader通过调用其父类DefaultResourceLoader的getResource方法获取要加载的资源
7 、DocumentLoader将Bean定义资源转换成Document对象
8、doLoadBeanDefinitions中进入registerBeanDefinitions 解析 D ocument对象
9、DefaultListableBeanFactory中使用一个HashMap的集合对象存放IoC容器中注册解析的BeanDefinition，

——————————————————————————————————————————————————————————————

0 0