spring源碼(3)Register the bean definitions(2)

接着上一節繼續:

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標籤處理流程:

  1. 真正解析是從 processBeanDefinition開始
  2. BeanDefinitionDocumentReader委託BeanDefinitionDelegate類的parseBeanDefinitionElement方法去解析,返回一個BeanDefinitionHolder類型的bdHolder
  3. 當返回的bdHolder不爲空的情況下,若存在默認標籤的子節點下再有自定義屬性,還需要再次對自定義標籤進行解析
  4. 解析完成後,需要對bdHolder進行註冊,同樣將註冊委託給BeanDefinitionReaderUtils的registerBeanDefinition方法
  5. 最後通知監聽器,這個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;
    }

序列圖地址:https://www.processon.com/view/link/59634e78e4b0c2773f86e3ac
bean標籤parent屬性請參考官方文檔7.7 Bean definition inheritance

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章