spring源码（3）Register the bean definitions（2）

最新推荐文章于 2022-09-10 18:12:45 发布

javaduqing

最新推荐文章于 2022-09-10 18:12:45 发布

阅读量750

点赞数 1

分类专栏： spring源码 spring源码分析文章标签： spring spring源码 beanDefini

本文链接：https://blog.csdn.net/disiwei1012/article/details/76039263

版权

spring源码同时被 2 个专栏收录

21 篇文章 2 订阅

订阅专栏

spring源码分析

17 篇文章 9 订阅

订阅专栏

接着上一节继续：

protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
    //默认标签的解析
    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);
                }
            }
        }
    }
    //自定义标签的解析
    else {
        delegate.parseCustomElement(root);
    }
}

private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
    //import标签解析
    if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
        importBeanDefinitionResource(ele);
    }
    //alias标签解析
    else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
        processAliasRegistration(ele);
    }
    //bean标签解析
    else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
        processBeanDefinition(ele, delegate);
    }

    //beans标签的解析
    else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
        // recurse
        doRegisterBeanDefinitions(ele);
    }
}

一、首先来看Spring如何解析bean标签

1、总体序列图、Bean标签处理流程：

真正解析是从 processBeanDefinition开始
BeanDefinitionDocumentReader委托BeanDefinitionDelegate类的parseBeanDefinitionElement方法去解析，返回一个BeanDefinitionHolder类型的bdHolder
当返回的bdHolder不为空的情况下，若存在默认标签的子节点下再有自定义属性，还需要再次对自定义标签进行解析
解析完成后，需要对bdHolder进行注册，同样将注册委托给BeanDefinitionReaderUtils的registerBeanDefinition方法
最后通知监听器，这个bean已经加载完成

bean标签解析UML序列图

这里写图片描述

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
    /*
     * 首先，委托BeanDefinitionParserDelegate类的parseBeanDefinitionElement方法进行元素解析，
     * 返回BeanDefinitionHolder类型的实例bdHolder，经过这个方法后，bdHolder实例已经包含我们配置文件中配置的各种属性了，
     * 例如class、name、name、id之类的属性。
     */
    BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
    if (bdHolder != null) {
        /*
         * 当返回的bdHolder不为空的情况下若存在默认标签的子节点下再有自定义属性，还需要再次对自定义标签进行解析
         */
        bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
        try {
            // Register the final decorated instance.
            /*
             * 解析完成后需要进行注册，同样，注册操作委托给* * * BeanDefinitionReaderUtils.registerBeanDefinition
             */
            BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
        }
        catch (BeanDefinitionStoreException ex) {
            getReaderContext().error("Failed to register bean definition with name '" +
                    bdHolder.getBeanName() + "'", ele, ex);
        }
        // Send registration event.
        /*
         * 最后发出响应事件，通知相关的监听器，这个Bean已经加载完成了
         */
        getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
    }
}

从Spring Framework Reference Documentation中可以查询到bean标签的属性有9个属性：

class
name
scope
constructor arguments
properties
autowiring mode
lazy-initialization mode
initialization method
destruction method

下面会依次看到对以上标签的解析，解析的不止这9个

2、用于属性承载的BeanDefinition

BeanDefinition是一个接口，在spring中有三种实现：RootBeanDefinition、ChildBeanDefinition、GenericBeanDefinition。三种实现均继承了AbstractBeanDefinition，其中BeanDefinition是配置文件bean元素在容器中的内部表现形式。bean标签拥有class,scope,lazy-init等配置属性，BeanDefinition和bean标签中的属性是一一对应的。其中RootBeanDefinition是最常用的实现类，它对应一般性的bean标签，GenericBeanDefinition是自2.5版本以后新加入的bean文件配置属性定义类，是一站式服务类。
在配置文件中可以定义父类bean标签，和子类bean标签，一个父类bean标签用RootBeanfinition表示，而子bean用ChildBeanDefinition表示，而没有父bean的bean就使用RootBeanDefinition表示。AbstractBeanDefinition对两者共同的类信息进行抽象。
spring通过BeanDefinition将配置文件中的bean配置信息转换成容器的内部表示，并将BeanDefinition注册到BeanDefinitionRegistry中。Spring容器的BeanDefinitionRegistry就像spring配置信息的内部数据库，主要以map形式保存，后续操作直接从BeanDefinitionRegistry中读取配置信息。
这里写图片描述

3、属性及子元素解析

    public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) {

        //获取id属性值
        String id = ele.getAttribute(ID_ATTRIBUTE);
        //获取name属性值
        String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
        //获取别名list，根据name属性值
        List<String> aliases = new ArrayList<String>();
        if (StringUtils.hasLength(nameAttr)) {
            //通过这句【MULTI_VALUE_ATTRIBUTE_DELIMITERS】我们知道，name属性的值可以以逗号或者分号分隔
            //public static final String MULTI_VALUE_ATTRIBUTE_DELIMITERS = ",; ";
            String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
            aliases.addAll(Arrays.asList(nameArr));
        }
        //bean的名称默认等于id属性值
        String beanName = id;
        if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
            //如果beanName为空，且别名list不空，则取出第一个值为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) {
            //检测bean的名称的唯一性
            checkNameUniqueness(beanName, aliases, ele);
        }
        //获取到beanName后，解析其他属性
        AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
        if (beanDefinition != null) {
            //如果beanName为空
            if (!StringUtils.hasText(beanName)) {
                try {
                    if (containingBean != null) {
                        beanName = BeanDefinitionReaderUtils.generateBeanName(
                                beanDefinition, this.readerContext.getRegistry(), true);
                    }
                    else {
                        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();
                        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);
                    return null;
                }
            }
            String[] aliasesArray = StringUtils.toStringArray(aliases);
            return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
        }

        return null;
    }

bean标签的Id和name属性处理如下：

默认id属性为beanName，如果id属性值为空，则取name属性的第一个名称；
然后判断beanName的唯一性；
如果beanName依然为空，则使用默认的方式生成唯一的beanName；
最后将bean标签的Class属性值也作为该bean的别名。

public AbstractBeanDefinition parseBeanDefinitionElement(
            Element ele, String beanName, BeanDefinition containingBean) {
        //parseState记录解析的bean
        this.parseState.push(new BeanEntry(beanName));

        String className = null;
        //获取bean标签class属性
        if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
            className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
        }

        try {
            //获取bean标签parent属性
            String parent = null;
            if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
                parent = ele.getAttribute(PARENT_ATTRIBUTE);
            }
            //创建GenericBeanDefinition，记录className，和parent
            AbstractBeanDefinition bd = createBeanDefinition(className, parent);
            //解析其他所有属性
            parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
            //解析子元素description
            bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
            //解析子元素meta
            parseMetaElements(ele, bd);
            //解析子元素loopup-method
            parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
            //解析子元素replaced-method
            parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
            //解析子元素constructor-arg
            parseConstructorArgElements(ele, bd);
            //解析子元素property
            parsePropertyElements(ele, bd);
            //解析子元素qualifier
            parseQualifierElements(ele, bd);
            //记录Resource
            bd.setResource(this.readerContext.getResource());
            bd.setSource(extractSource(ele));

            return bd;
        }
        catch (ClassNotFoundException ex) {
            error("Bean class [" + 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();
        }

        return null;
    }