Spring源代码解析和配置文件载入

Spring类的继承结构图:

Spring运用了大量的模板方法模式和策略模式，所以各位看源代码的时候，务必留意，每个继承的层次都有不同的作用。然后将同样的地方抽取出来，依赖抽象将不同的处理依照不同的策略去处理。

步骤A. 读取 Resource 文件形成 Document 模型 

    类图: XmlBeanFactory -> XmlBeanDefinitionReader 
    
    Spring 使用 XmlBeanDefinitionReader 来读取并解析 xml 文件，XmlBeanDefinitionReader 是 BeanDefinitionReader 接口的实现。 
    BeanDefinitionReader 定义了 Spring 读取 Bean 定义的一个接口，这个接口中有一些 loadBeanDefinitions 方法, 用于读取 Bean 配置。

 
    BeanDefinitionReader 接口有两个详细的实现。当中之中的一个就是从 Xml 文件里读取配置的 XmlBeanDefinitionReader，还有一个则是从 Java Properties 文件里读取配置的PropertiesBeanDefinitionReader。

    (注:开发者也能够提供自己的 BeanDefinitionReader 实现。依据自己的须要来读取 spring bean 定义的配置。

) 

步骤B. 解析 Document 得到 Bean 配置 

    类图: XmlBeanDefinitionReader-> BeanDefinitionDocumentReader 

    BeanDefinitionDocumentReader 接口中仅仅定义了一个方法 registerBeanDefinitions. 有一个默认实现 DefaultBeanDefinitionDocumentReader. 
    DefaultBeanDefinitionDocumentReader 主要完毕两件事情，解析 <bean> 元素。为扩展 spring 的元素寻找合适的解析器，并把对应的元素交给解析器解析。 

过程: 
    在 XmlBeanFactory 中创建了 XmlBeanDefinitionReader 的实例，并在 XmlBeanFactory 的构造方法中调用了 XmlBeanDefinitionReader 的 loadBeanDefinitions 方法，由 loadBeanDefinitions 方法负责载入 bean 配置并把 bean 配置注冊到 XmlBeanFactory 中。

 
    在 XmlBeanDefinitionReader 的 loadBeanDefinitions 方法中, 调用 DefaultDocumentLoader 的 loadDocument 读取配置文件为 Document, 然后调用 BeanDefinitionDocumentReader 的 registerBeanDefinitions 方法 来解析 Bean. 

源代码解析: 

在XmlBeanFactory初始化时, 须要指定Resource对象. 

public XmlBeanFactory(Resource resource, BeanFactory parentBeanFactory)
    throws BeansException
{
    super(parentBeanFactory);
    reader = new XmlBeanDefinitionReader(this);
    reader.loadBeanDefinitions(resource);
}

1. 先来分析下XmlBeanDefinitionReader这个类. 

public class XmlBeanDefinitionReader extends AbstractBeanDefinitionReader

接着 

public abstract class AbstractBeanDefinitionReader
    implements BeanDefinitionReader

再继续 

public interface BeanDefinitionReader

在BeanDefinitionReader中定义有很多loadBeanDefinitions方法 

public abstract int loadBeanDefinitions(Resource resource)
    throws BeanDefinitionStoreException;

public abstract int loadBeanDefinitions(Resource aresource[])
    throws BeanDefinitionStoreException;

public abstract int loadBeanDefinitions(String s)
    throws BeanDefinitionStoreException;

public abstract int loadBeanDefinitions(String as[])
    throws BeanDefinitionStoreException;

来回头看XmlBeanDefinitionReader对loadBeanDefinitions方法的实现 
在loadBeanDefinitions方法中调用了doLoadBeanDefinitions方法, 跟踪doLoadBeanDefinitions方法 

Document doc = documentLoader.loadDocument(inputSource, getEntityResolver(), errorHandler, validationMode, isNamespaceAware());

通过一个叫documentLoader的东西的loadDocument方法来载入配置文件形成DOM, 来看看documentLoader 

private DocumentLoader documentLoader
...
documentLoader = new DefaultDocumentLoader();

跟踪到DefaultDocumentLoader 

public class DefaultDocumentLoader
    implements DocumentLoader
...
    public Document loadDocument(InputSource inputSource, EntityResolver entityResolver, ErrorHandler errorHandler, int validationMode, boolean namespaceAware)
        throws Exception
    {
        DocumentBuilderFactory factory = createDocumentBuilderFactory(validationMode, namespaceAware);
        if(logger.isDebugEnabled())
            logger.debug("Using JAXP provider [" + factory.getClass().getName() + "]");
        DocumentBuilder builder = createDocumentBuilder(factory, entityResolver, errorHandler);
        return builder.parse(inputSource);
    }
...

哦哦, 我们知道了, 是通过sax解析得到Dom的, 至于怎么解析, 不属于Spring范畴, 不做研究. 

在这一步, 已完毕了从配置文件读取到Domcument. 接着要開始解析Dom了 

再继续, 解析成Dom后接着调用了registerBeanDefinitions方法 

return registerBeanDefinitions(doc, resource);

来看看registerBeanDefinitions的实现 

...
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
int countBefore = getRegistry().getBeanDefinitionCount();
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
return getRegistry().getBeanDefinitionCount() - countBefore;
...

在这里, 有一个BeanDefinitionDocumentReader接口, 实际上Spring对它有一个默认的实现类叫DefaultBeanDefinitionDocumentReader, 来看看它的家族 

public class DefaultBeanDefinitionDocumentReader

public interface BeanDefinitionDocumentReader

BeanDefinitionDocumentReader仅仅有一个registerBeanDefinitions方法 

public abstract void registerBeanDefinitions(Document document, XmlReaderContext xmlreadercontext)
    throws BeanDefinitionStoreException;

该方法须要两个參数, 一个是Document模型,这个应该是我们读取配置文件获取到的, 还有一个是XmlReaderContext对象, 我们在上面方法中看到是通过createReaderContext(resource)得到的, 那就看看详细怎样得到 

protected XmlReaderContext createReaderContext(Resource resource)
{
    if(namespaceHandlerResolver == null)
        namespaceHandlerResolver = createDefaultNamespaceHandlerResolver();
    return new XmlReaderContext(resource, problemReporter, eventListener, sourceExtractor, this, namespaceHandlerResolver);
}

能过构造函数new出来的, 且有一个重要參数resource 
再继续来看DefaultBeanDefinitionDocumentReader对BeanDefinitionDocumentReader的registerBeanDefinitions方法实现 

  public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext)
  {
      ...
BeanDefinitionParserDelegate delegate = createHelper(readerContext, root);
...
      parseBeanDefinitions(root, delegate);
      ...
  }

嘿嘿, 開始解析Dom了哦, 当中主要是parseBeanDefinitions方法, 来看看详细是怎样解析的 

protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate)
{
    if(delegate.isDefaultNamespace(root.getNamespaceURI()))
    {
        NodeList nl = root.getChildNodes();
        for(int i = 0; i < nl.getLength(); i++)
        {
            org.w3c.dom.Node node = nl.item(i);
            if(node instanceof Element)
            {
                Element ele = (Element)node;
                String namespaceUri = ele.getNamespaceURI();
                if(delegate.isDefaultNamespace(namespaceUri))
                    parseDefaultElement(ele, delegate);
                else
                    delegate.parseCustomElement(ele);
            }
        }

    } else
    {
        delegate.parseCustomElement(root);
    }
}

看到了吧, 循环解析Domcument节点 
parseDefaultElement方法和delegate的parseCustomElement方法 
先来看parseDefaultElement方法 

private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate)
{
    if(DomUtils.nodeNameEquals(ele, "import"))
        importBeanDefinitionResource(ele);
    else
    if(DomUtils.nodeNameEquals(ele, "alias"))
        processAliasRegistration(ele);
    else
    if(DomUtils.nodeNameEquals(ele, "bean"))
        processBeanDefinition(ele, delegate);
}

看到这就非常清楚了, 就是依据节点的名称作不同解析, 如我们Spring配置文件里常有下面几种配置 

<import resource="classpath:xxx" />
<bean id="xxx" class="xxx.xxx.xxx" />
<alias name="xxxx" alias="yyyyy"/>

对<import>节点, 调用importBeanDefinitionResource方法解析, 此方法中, 又回到第一步读取配置文件并解析. 如此递归循环. 

...
Resource relativeResource = getReaderContext().getResource().createRelative(location);
int importCount = getReaderContext().getReader().loadBeanDefinitions(relativeResource);
...

对<alias>节点, 调用processAliasRegistration进行别名解析 
我们主要看对<bean>节点调用processBeanDefinition进行解析 

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate)
{
    BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
    if(bdHolder != null)
    {
        bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
        try
        {
            BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
        }
        catch(BeanDefinitionStoreException ex)
        {
            getReaderContext().error("Failed to register bean definition with name '" + bdHolder.getBeanName() + "'", ele, ex);
        }
        getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
    }
}

嘿嘿, 又用到delegate对象了, 且调用它的BeanDefinitionHolder方法, 返回一个BeanDefinitionHolder, 进去看它的parseBeanDefinitionElement方法 

public class BeanDefinitionParserDelegate
{
    private final Set usedNames = new HashSet();
    ...
    public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean)
    {
        ... 解析id, name等属性, 并验证name是否唯一, 并将name保存在usedNames中
        AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
        ...
        return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
    }
    ...
}

能够看到, 在BeanDefinitionHolder中保存了BeanDefinition的定义 
OK, 重头戏開始, 最经典的部分出现了, 请看parseBeanDefinitionElement方法 

public AbstractBeanDefinition parseBeanDefinitionElement(Element ele, String beanName, BeanDefinition containingBean)
{
    ...
    代码太长, 请參考详细代码
    AbstractBeanDefinition bd = BeanDefinitionReaderUtils.createBeanDefinition(parent, className, readerContext.getBeanClassLoader());
    ...
    return abstractbeandefinition;
    ...
}

在这种方法中, 解析了bean的全部属性, 有最经常使用的class, scope, lazy-init等等. 并返回一个AbstractBeanDefinition实例. 至于详细怎么解析, 就仅仅能进一步跟踪了, 只是既然到了这一步, 已经明确了它的基本原理, 详细实现就不作介绍 

这一步将节点解析成BeanDefinitionHolder对象, 再看看怎样注冊, 回到DefaultBeanDefinitionDocumentReader的processBeanDefinition方法 
看到对解析到的bdHolder对象又做了decorateBeanDefinitionIfRequired操作, 来看看实现 
... 暂留空 

接着调用了BeanDefinitionReaderUtils的registerBeanDefinition方法注冊bdHolder, 来看看怎样实现的 

public class BeanDefinitionReaderUtils
{
    public static void registerBeanDefinition(BeanDefinitionHolder bdHolder, BeanDefinitionRegistry beanFactory)
        throws BeanDefinitionStoreException
    {
        String beanName = bdHolder.getBeanName();
        beanFactory.registerBeanDefinition(beanName, bdHolder.getBeanDefinition());
        String aliases[] = bdHolder.getAliases();
        if(aliases != null)
        {
            for(int i = 0; i < aliases.length; i++)
                beanFactory.registerAlias(beanName, aliases[i]);

        }
    }
}

看吧, 又调用了BeanDefinitionRegistry的registerBeanDefinition方法, 跟踪之 (这个要看DefaultListableBeanFactory的实现) 

public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFactory
    implements ConfigurableListableBeanFactory, BeanDefinitionRegistry
{
    private final Map beanDefinitionMap;
    private final List beanDefinitionNames;
    ...
    public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
        throws BeanDefinitionStoreException
    {
        ...
        Object oldBeanDefinition = beanDefinitionMap.get(beanName);
        ...
        beanDefinitionMap.put(beanName, beanDefinition);
        ...
    }
}

这里, 看到了一个最最重要的对象就是beanDefinitionMap, 这个map存放了全部的bean对象, 和我们通常讲的容器概念最为接近, getBean时实际是也是从这里辚取对象, 同样的另一个beanDefinitionNames, 但这个仅仅保存bean的名称 
完毕上面之后, 另一步操作beanFactory.registerAlias(beanName, aliases[i]); 
这个实现实际是上AbstractBeanFactory抽象类所定义的