Spring IoC源码学习：parseDefaultElement 详解

微信搜索【程序员囧辉】，关注这个坚持分享技术干货的程序员。

目录

Spring IoC源码学习全系列

前言

正文

parseDefaultElement

processBeanDefinition 

代码块1：parseBeanDefinitionElement

代码块2：parseBeanDefinitionElement

代码块3：parseBeanDefinitionAttributes

代码块4：parseConstructorArgElements

代码块5：parseConstructorArgElement

代码块6：parsePropertyValue

代码块7：parsePropertySubElement

代码块8：parseValueElement

代码块9：buildTypedStringValue

代码块10：parseListElement

代码块11：parsePropertyElements

代码块12：parsePropertyElement

代码块13：registerBeanDefinition

代码块14：registerBeanDefinition

代码块15：resetBeanDefinition

代码块16：registerAlias

总结

相关文章

---

Spring IoC源码学习全系列

小白也看得懂的 Spring IoC 核心流程介绍

Spring IoC源码学习：总览

Spring IoC源码学习：ApplicationContext 刷新前的配置

Spring IoC源码学习：obtainFreshBeanFactory详解

Spring IoC源码学习：parseDefaultElement详解

Spring IoC源码学习：parseCustomElement详解

Spring IoC源码学习：context:component-scan 节点详解

Spring IoC源码学习：invokeBeanFactoryPostProcessors详解

Spring IoC源码学习：registerBeanPostProcessors详解

Spring IoC源码学习：finishBeanFactoryInitialization详解

Spring IoC源码学习：getBean详解

Spring IoC源码学习：createBean详解（上）

Spring IoC源码学习：createBean详解（下）

Spring IoC源码学习：@Autowire 详解

Spring IoC源码学习：finishRefresh 详解

 

前言

接着 Spring IoC：obtainFreshBeanFactory详解 继续往下解析，本文来到 parseDefaultElement 方法。该方法是解析默认命名空间节点的方法，是加载 bean 定义模块的最核心方法。

 

正文

首先让我们回到 Spring IoC：obtainFreshBeanFactory详解 文末的 parseBeanDefinitions 方法。

protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
    // 1.默认命名空间的处理
    if (delegate.isDefaultNamespace(root)) {
        NodeList nl = root.getChildNodes();
        // 遍历root的子节点列表
        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)) {
                    // 1.1 默认命名空间节点的处理，例如： <bean id="test" class="" />
                    parseDefaultElement(ele, delegate);
                }
                else {
                    // 1.2 自定义命名空间节点的处理，例如：<context:component-scan/>、<aop:aspectj-autoproxy/>
                    delegate.parseCustomElement(ele);
                }
            }
        }
    } else {
        // 2.自定义命名空间的处理
        delegate.parseCustomElement(root);
    }
}

1.1 默认命名空间节点的处理，见下面 parseDefaultElement 方法。

 

parseDefaultElement

private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
    // 1.对import标签的处理
    if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
        importBeanDefinitionResource(ele);
    }
    // 2.对alias标签的处理
    else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
        processAliasRegistration(ele);
    }
    // 3.对bean标签的处理(最复杂最重要)
    else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
        processBeanDefinition(ele, delegate);
    }
    // 4.对beans标签的处理
    else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
        // recurse
        doRegisterBeanDefinitions(ele);
    }
}

可以看到默认命名空间的一级节点只有4种：import、alias、bean、beans。这4种节点中，最重要、最复杂的就是 <bean> 节点，本文只会介绍 <bean> 节点的处理，理解了 <bean> 节点后，其他的都不难理解。另外，<beans> 节点只是递归调用之前的 doRegisterBeanDefinitions 方法，因此无需再介绍。

接下来，让我们从 processBeanDefinition(ele, delegate) 方法正式开始。

 

processBeanDefinition 

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
    // 1.进行节点定义解析, 经过这个方法后，bdHolder会包含一个Bean节点的所有属性，例如name、class、id
    BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
    if (bdHolder != null) {
        // 2.若存在默认标签的子节点下再有自定义属性，需要再次对自定义标签再进行解析(基本不用，不做深入解析)
        bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
        try {
            // Register the final decorated instance.
            // 3.解析节点定义完成后，需要对解析后的bdHolder进行注册
            BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
        } catch (BeanDefinitionStoreException ex) {
            getReaderContext().error("Failed to register bean definition with name '" +
                    bdHolder.getBeanName() + "'", ele, ex);
        }
        // Send registration event.
        // 4.最后发出响应事件，通知相关的监听器，这个Bean已经加载完成了
        getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
    }
}

1. 进行节点定义解析，见代码块1详解。

2. 例如下图这种，基本不用，不做深入解析。

 

3. 解析节点定义完成后，需要对解析后的 bdHolder 进行注册，见代码块13详解。

4. 发出响应事件，通知相关的监听器，不做深入解析。

 

代码块1：parseBeanDefinitionElement

public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
    return parseBeanDefinitionElement(ele, null);
}

public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) {
    // 1.解析name和id属性
    // 解析id属性
    String id = ele.getAttribute(ID_ATTRIBUTE);
    // 解析name属性
    String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);

    // 分割name属性（通过逗号或分号）
    // 例如：<bean name="demoService,demoServiceAlias" class=""/>，分割后aliases为[demoService, demoServiceAlias]
    List<String> aliases = new ArrayList<String>();
    if (StringUtils.hasLength(nameAttr)) {
        String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
        aliases.addAll(Arrays.asList(nameArr));
    }

    // beanName默认使用id
    String beanName = id;
    if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
        // 如果id为空，并且aliases不为空，则取aliases的第一个元素作为beanName，其他的仍作为别名
        beanName = aliases.remove(0);
        if (logger.isDebugEnabled()) {
            logger.debug("No XML 'id' specified - using '" + beanName +
                    "' as bean name and " + aliases + " as aliases");
        }
    }

    if (containingBean == null) {
        // 检查beanName和aliases是否在同一个 <beans> 下已经存在
        checkNameUniqueness(beanName, aliases, ele);
    }

    // 2.进一步解析bean的其他所有属性并统一封装至GenericBeanDefinition类型实例中
    AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
    if (beanDefinition != null) {
        if (!StringUtils.hasText(beanName)) {
            try {
                // 3.如果bean定义存在，但是beanName为空，则用Spring默认的生成规则为当前bean生成beanName
                if (containingBean != null) {
                    beanName = BeanDefinitionReaderUtils.generateBeanName(
                            beanDefinition, this.readerContext.getRegistry(), true);
                }
                else {
                    // Spring提供的生成规则生成beanName，例如：com.joonwhee.open.demo.service.impl.DemoServiceImpl#0
                    beanName = this.readerContext.generateBeanName(beanDefinition);
                    // Register an alias for the plain bean class name, if still possible,
                    // if the generator returned the class name plus a suffix.
                    // This is expected for Spring 1.2/2.0 backwards compatibility.
                    String beanClassName = beanDefinition.getBeanClassName();