六、注册BeanDefinitions

注册BeanDefinitions

通过XmlBeanDefinitionReader.doLoadDocument()获取了XML Documents对象后，会使用该Document对象和Resource资源对象通过XmlBeanDefinitionReader.registerBeanDefinitions()开始注册BeanDefinitions。

public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
    // <1> 创建 BeanDefinitionDocumentReader 对象
    BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
    // <2> 获取已注册的 BeanDefinition 数量
    int countBefore = getRegistry().getBeanDefinitionCount();
    // <3> 创建 XmlReaderContext 对象，参数createReaderContext(resource)
    // <4> 注册 BeanDefinition
    documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
    // 计算新注册的 BeanDefinition 数量
    return getRegistry().getBeanDefinitionCount() - countBefore;
}

createBeanDefinitionDocumentReader()方法

createBeanDefinitionDocumentReader()实例化BeanDefinitionDocumentReader对象，用来从XML文件中读取bean定义，默认实例化指定的documentReaderClass，即DefaultBeanDefinitionDocumentReader.class。

private Class<? extends BeanDefinitionDocumentReader> documentReaderClass =
			DefaultBeanDefinitionDocumentReader.class;
protected BeanDefinitionDocumentReader createBeanDefinitionDocumentReader() {
    return BeanUtils.instantiateClass(this.documentReaderClass);
}

registerBeanDefinitions()方法

BeanDefinitionDocumentReader.registerBeanDefinitions(Document doc, XmlReaderContext readerContext) 方法，注册 BeanDefinition ，在接口 BeanDefinitionDocumentReader 中定义。

机翻方法注释：从给定的DOM文档中读取bean定义，并在给定的阅读器上下文中向注册表注册它们。

public interface BeanDefinitionDocumentReader {
	void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) throws BeanDefinitionStoreException;

}

DefaultBeanDefinitionDocumentReader

该类是BeanDefinitionDocumentReader的实现类，且是唯一一个。

@Override
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
    this.readerContext = readerContext;
	//获取XML Document Root Element并执行注册
    doRegisterBeanDefinitions(doc.getDocumentElement());
}

protected void doRegisterBeanDefinitions(Element root) {
    // 保存原有的 BeanDefinitionParserDelegate 对象
    BeanDefinitionParserDelegate parent = this.delegate;
    // <1> 创建 BeanDefinitionParserDelegate 对象，并进行设置到 delegate
    this.delegate = createDelegate(getReaderContext(), root, parent);
    // <2> 给定的ＵＲＬ是否包含默认命名空间检查 <beans /> 根标签的命名空间是否为空，或者是 http://www.springframework.org/schema/beans
    if (this.delegate.isDefaultNamespace(root)) {
        // <2.1> 处理 profile 属性。<bean profile=""></bean>，比如之前区分Test,Dev...等环境需要定义好几个application-xxx.xml文件，现在使用profile即可。
        String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
        if (StringUtils.hasText(profileSpec)) {
            // <2.2> 使用分隔符切分，可能有多个 profile 。
            String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
                profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
            // <2.3> 如果所有 profile 都无效，则不进行注册
            if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
                if (logger.isDebugEnabled()) {
                    logger.debug("Skipped XML bean definition file due to specified profiles [" + profileSpec +
                                 "] not matching: " + getReaderContext().getResource());
                }
                return;
            }
        }
    }
    // <3> 解析前处理，目前是个空方法，需要子类去实现。
    preProcessXml(root);
    // <4> 解析
    parseBeanDefinitions(root, this.delegate);
    // <5> 解析后处理，目前是个空方法，需要子类去实现。
    postProcessXml(root);
    // 设置 delegate 为开头保存的　BeanDefinitionParserDelegate 对象
    this.delegate = parent;
}

createDelegate()方法

BeanDefinitionParserDelegate负责解析BeanDifinition对象，定义了解析XML Element的各种方法，如下获取BeanDefinitionParserDelegate：

createDelegateprotected BeanDefinitionParserDelegate createDelegate(
    XmlReaderContext readerContext, Element root, @Nullable BeanDefinitionParserDelegate parentDelegate) {
    // 创建 BeanDefinitionParserDelegate 对象
    BeanDefinitionParserDelegate delegate = new BeanDefinitionParserDelegate(readerContext);
    // 初始化默认
    delegate.initDefaults(root, parentDelegate);
    return delegate;
}

parseBeanDefinitions()方法

对给定的Element进行解析：

protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
    // <1> 根节点是否使用默认命名空间，
    if (delegate.isDefaultNamespace(root)) {
        // 遍历子节点
        NodeList nl = root.getChildNodes();
        for (int i = 0; i < nl.getLength(); i++) {
            Node node = nl.item(i);
            if (node instanceof Element) {
                Element ele = (Element) node;
                //该节点是否使用默认命名空间，执行默认解析。
                if (delegate.isDefaultNamespace(ele)) {
                    parseDefaultElement(ele, delegate);
                }
                //如果不是默认命名空间，执行自定义解析。
                else {
                    delegate.parseCustomElement(ele);
                }
            }
        }
    }
    //<2>如果不是默认命名空间，执行自定义解析。
    else {
        delegate.parseCustomElement(root);
    }
}

• Spring有两种Bean声明方式：
  1. 配置文件式声明，例：<bean id="lizi" class="com.jievhaha.lizi"/>，使用<1>处解析
  2. 自定义注解方式：<tx:anntation-driven>，执行<2>处解析

子节点或者根节点使用默认命名空间，执行默认解析，如下：

private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
    if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
        importBeanDefinitionResource(ele);
    }
    else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
        processAliasRegistration(ele);
    }
    else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
        processBeanDefinition(ele, delegate);
    }
    else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
        // recurse
        doRegisterBeanDefinitions(ele);
    }
}

createReaderContext()方法

文章开头，注册BeanDefinition对象时需要上送XmlReaderContext对象：

private ProblemReporter problemReporter = new FailFastProblemReporter();
private ReaderEventListener eventListener = new EmptyReaderEventListener();
private SourceExtractor sourceExtractor = new NullSourceExtractor();

public XmlReaderContext createReaderContext(Resource resource) {
    return new XmlReaderContext(resource, this.problemReporter, this.eventListener,
                                this.sourceExtractor, this, getNamespaceHandlerResolver());
}

小结

XmlBeanDefinitionReader.doLoadBeanDefinitions解析过程时序图：

红框是解析过程。