Spring源码解析02：Spring IOC容器之XmlBeanFactory启动流程分析和源码解析 (4)

日期：2021-05-28 栏目：程序人生浏览：次

通过node.getNamespaceURI()获取命名空间并和Spring中固定的命名空间进行比对，如果一致则默认，否则自定义。

3.4 parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate)

功能概述： 上面说到Spring标签包括默认标签和自定义标签两种。解析这两种方式分别不同。以下就默认标签进行说明BeanDefinitionParseDelegate对Bean标签元素的解析过程。

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

知识点：

Spring的4种默认标签举例：

import

alias

bean

beans

3.5 processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate)

功能概述： 在4中默认标签当中，其中核心的是对bean标签的解析。以下就对bean标签的解析来看解析过程。

/**
* DefaultBeanDefinitionDocumentReader
**/
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate){
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele); // 参考4.1源码
if (bdHolder != null) {
  bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder); // 参考4.2源码
  try {
   BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry()); // 参考5.1源码
  }
  ...
  // Send registration event.
  getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
}
}

流程解读：

DefaultBeanDefinitionDocumentReader委托BeanDefinitionParseDelegate的parseBeanDefinitionElement方法进行标签元素的解析。解析后返回BeanDefinitionHolder实例bdHolder,bdHolder实例包含了配置文件中的id、name、alias之类的属性。

返回的bdHolder不为空时，标签元素如果有自定义属性和自定义子节点，还需要再次对以上两个标签解析。具体逻辑参考4.2小节源码。

解析完成后，对bdHolder进行注册，使用BeanDefinitionReaderUtils.registerBeanDefinition()方法。具体逻辑参考5.1小节源码。

发出响应事件，通知相关监听器，bean已经解析完成。

4.1 registerBeanDefinition(String beanName, BeanDefinition beanDefinition)

功能概述： 通过BeanDefinitionParseDelegate对Bean标签的解析，解析得到id和name这些信息封装到BeanDefinitionHolder并返回。

/**
* BeanDefinitionParseDelegate
**/
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
    return parseBeanDefinitionElement(ele, null);
}
/**
* BeanDefinitionParseDelegate
**/
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
        // 解析id属性
  String id = ele.getAttribute(ID_ATTRIBUTE);
        // 解析name属性
  String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);

  List<String> aliases = new ArrayList<>();
  if (StringUtils.hasLength(nameAttr)) {
   String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
   aliases.addAll(Arrays.asList(nameArr));
  }

  String beanName = id;
  if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
   beanName = aliases.remove(0);
  }

  if (containingBean == null) {
   checkNameUniqueness(beanName, aliases, ele);
  }

  AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
    if (beanDefinition != null) {
   ...
   String[] aliasesArray = StringUtils.toStringArray(aliases);
   return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
  }
}
4.2 decorateBeanDefinitionIfRequired(Element ele, BeanDefinitionHolder originalDef, @Nullable BeanDefinition containingBd)

功能概述： 4.1是对默认标签的属性解析，那如果标签有自定义属性和自定义子节点，这时就要通过decorateBeanDefinitionIfRequired解析这些自定义属性和自定义子节点。

/**
* BeanDefinitionParseDelegate
**/
public BeanDefinitionHolder decorateBeanDefinitionIfRequired(
    Element ele, BeanDefinitionHolder originalDef, @Nullable BeanDefinition containingBd) {

    BeanDefinitionHolder finalDefinition = originalDef;

    // Decorate based on custom attributes first.
    // 首先对自定义属性解析和装饰
    NamedNodeMap attributes = ele.getAttributes();
    for (int i = 0; i < attributes.getLength(); i++) {
        Node node = attributes.item(i);
        finalDefinition = decorateIfRequired(node, finalDefinition, containingBd);
    }

    // Decorate based on custom nested elements.
    // 装饰标签下的自定义子节点
    NodeList children = ele.getChildNodes();
    for (int i = 0; i < children.getLength(); i++) {
        Node node = children.item(i);
        if (node.getNodeType() == Node.ELEMENT_NODE) {
            finalDefinition = decorateIfRequired(node, finalDefinition, containingBd);
        }
    }
    return finalDefinition;
}
5.1 registerBeanDefinition(String beanName, BeanDefinition beanDefinition)

功能概述： 通过beanName注册BeanDefinition至BeanDefinitionMap中去，至此完成Bean标签的解析，转换成Bean在容器中的数据结构BeanDefinition.

/**
* BeanDefinitionReaderUtils
**/
public static void registerBeanDefinition(
   BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
  throws BeanDefinitionStoreException {

// Register bean definition under primary name.
    // 使用beanName注册BeanDefinition
String beanName = definitionHolder.getBeanName();

registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());

// Register aliases for bean name, if any.
    // 使用别名注册BeanDefiniion
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
  for (String alias : aliases) {
   registry.registerAlias(beanName, alias);
  }
}
}

/**
* BeanDefinitionParseDelegate
**/
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
   throws BeanDefinitionStoreException {
    ...
    BeanDefinition existingDefinition = this.beanDefinitionMap.get(beanName);
if (existingDefinition != null) {
     ...
     this.beanDefinitionMap.put(beanName, beanDefinition);
}else{
     if (hasBeanCreationStarted()) {
   // beanDefinitionMap是全局变量，会存在并发访问问题
   synchronized (this.beanDefinitionMap) {
    this.beanDefinitionMap.put(beanName, beanDefinition);
    List<String> updatedDefinitions = new ArrayList<>(this.beanDefinitionNames.size() + 1);
    updatedDefinitions.addAll(this.beanDefinitionNames);
    updatedDefinitions.add(beanName);
    this.beanDefinitionNames = updatedDefinitions;
    removeManualSingletonName(beanName);
   }
  }
  else {
   // Still in startup registration phase
   this.beanDefinitionMap.put(beanName, beanDefinition);
   this.beanDefinitionNames.add(beanName);
   removeManualSingletonName(beanName);
  }
  this.frozenBeanDefinitionNames = null;
}
    ...
}
五. 结语

总结Spring IOC基础容器XmlBeanFactory的启动流程概括如下：

执行XmlFactoryBean构造方法，执行加载BeanDefinition方法。

使用XmlBeanDefinitionReader读取器将资源Resource解析成DOM Document对象。

使用DefaultBeanDefinitionDocumentReader读取器从Document对象解析出 Element。

通过BeanDefinitionParserDelegate将Element转换成对应的BeanDefinition。

转载注明出处：https://www.heiqu.com/wpjwff.html

Spring源码解析02：Spring IOC容器之XmlBeanFactory启动流程分析和源码解析 (4)

相关推荐