Spring IoC容器初始化源码(3)—parseDefaultElement、parseCustomElement解析标签，registerBeanDefinition注册Bean定义【三万字】
基于最新Spring 5.x，介绍了包括parseDefaultElement解析默认标签的方法、parseCustomElement解析扩展标签的方法和 registerBeanDefinition注册bean定义的方法的源码！
上一篇文章：Spring IoC容器初始化源码(2)—prepareRefresh准备刷新、obtainFreshBeanFactory加载XML资源、解析＜beans/＞标签中，我们主要讲解了ClassPathXmlApplicationContext IoC容器初始化的refresh方法中的refresh()方法概述、prepareRefresh方法以及obtainFreshBeanFactory方法的前半部分的过程和源码，比如XML资源的加载，以及< beans/>标签的解析。
现在我们继续向下学习refresh()方法，本篇文章的内容是接着上一篇讲解obtainFreshBeanFactory方法的后半部分，主要是parseDefaultElement解析默认标签的方法、parseCustomElement解析扩展标签的方法和registerBeanDefinition注册bean定义的方法的源码。
Spring IoC容器初始化源码 系列文章
Spring IoC容器初始化源码(1)—setConfigLocations设置容器配置信息
Spring IoC容器初始化源码(2)—prepareRefresh准备刷新、obtainFreshBeanFactory加载XML资源、解析＜beans/＞标签
Spring IoC容器初始化源码(3)—parseDefaultElement、parseCustomElement解析默认、扩展标签，registerBeanDefinition注册Bean定义
Spring IoC容器初始化源码(4)—＜context:component-scan/＞标签解析、spring.components扩展点、自定义Spring命名空间扩展点
Spring IoC容器初始化源码(5)—prepareBeanFactory、invokeBeanFactoryPostProcessors、registerBeanPostProcessors方法
Spring IoC容器初始化源码(6)—finishBeanFactoryInitialization实例化Bean的整体流程以及某些扩展点
Spring IoC容器初始化源码(7)—createBean实例化Bean的整体流程以及构造器自动注入
Spring IoC容器初始化源码(8)—populateBean、initializeBean实例化Bean以及其他依赖注入
＜ context:property-placeholder/＞标签以及PropertySourcesPlaceholderConfigurer占位符解析器源码深度解析
三万字的ConfigurationClassPostProcessor配置类后处理器源码深度解析
基于JavaConfig的AnnotationConfigApplicationContext IoC容器初始化源码分析
文章目录
- Spring IoC容器初始化源码 系列文章
- 1 parseDefaultElement解析默认标签
-
- 1.1 processBeanDefinition解析< bean/>标签注册Bean定义
-
- 1.1.1 parseBeanDefinitionElement解析< bean/>标签获取BeanDefinitionHolder
-
- 1.1.1.1 checkNameUniqueness校验beanName唯一性
- 1.1.1.2 parseBeanDefinitionElement解析< bean/>标签获取bean定义
-
- 1.1.1.2.1 createBeanDefinition创建BeanDefinition
- 1.1.1.2.2 parseBeanDefinitionAttributes解析< bean/>标签的各种属性
- 1.1.1.2.3 parseConstructorArgElements解析所有< constructor-arg/>子标签
-
- 1.1.1.2.3.1 parseConstructorArgElement解析一个< constructor-arg/>子标签
- 1.1.1.2.4 parsePropertyElements解析所有< property>子标签
-
- 1.1.1.2.4.1 parsePropertyElement解析一个< property/>子标签
- 1.1.1.2.5 parsePropertyValue解析标签元素的值
-
- 1.1.1.2.5.1 parsePropertySubElement解析值子标签
- 1.1.1.2.5.1.1 parseValueElement解析< value/>值标签
- 1.1.1.2.5.1.2 解析< array/>、< list/>、< set/>值标签
- 1.1.1.2.5.1.3 parseMapElement解析< map/>值标签
- 1.1.1.2.5.1.4 解析< props/>集合值标签
- 1.1.2 registerBeanDefinition注册Bean定义
-
- 1.1.2.1 registerBeanDefinition注册BeanDefinition
-
- 1.1.2.1.1 resetBeanDefinition重置BeanDefinition缓存
- 1.1.2.2 registerAlias注册别名映射
- 1.2 importBeanDefinitionResource解析< import/>标签注册bean定义
- 1.3 processAliasRegistration解析< alias/>标签注册别名映射
- 2 parseCustomElement解析扩展标签
-
- 2.1 resolve解析namespaceUri
-
- 2.1.1 getHandlerMappings获取NamespaceHandler映射
- 2.1.2 init初始化标签节点解析/装饰器
-
- 2.1.2.1 registerBeanDefinitionParser、registerBeanDefinitionDecorator注册bean定义解析/装饰器
- 2.2 parse解析自定义标签节点
- 3 小结
1 parseDefaultElement解析默认标签
parseDefaultElement被上一篇文章的末尾的方法parseBeanDefinitions方法调用，用于解析< beans/>根标签下的默认命名空间（xmlns=“http://www.springframework.org/schema/beans”）下的标签，就是四个标签: < import/>、< alias/>、< bean/>、< beans/>。
- < import/>标签表示引入其他XML文件，使用importBeanDefinitionResource方法解析；
- < alias/>标签表示设置bean别名，使用processAliasRegistration方法解析；
- < bean/>标签表示一个bean定义，使用processBeanDefinition方法解析，这个是核心标签。
- < beans/>标签，表示嵌套的< beans/>标签，那么递归的调用doRegisterBeanDefinitions方法解析，这个方法在上一篇文章中已经介绍了。
//-----DefaultBeanDefinitionDocumentReader的常量属性
/**
*
3. 解析beans根标签下的默认命名空间（xmlns="http://www.springframework.org/schema/beans"）下的标签
4. 就是四个标签:
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
//如果是1.1 processBeanDefinition解析< bean/>标签注册Bean定义
processBeanDefinition方法位于DefaultBeanDefinitionDocumentReader类中，但是方法内部还是委托BeanDefinitionParserDelegate解析器来解析的。
processBeanDefinition方法主要做了四件事：
- 核心方法。调用BeanDefinitionParserDelegate.parseBeanDefinitionElement方法将< bean/>标签对应的Element元素对象，解析为bean定义——BeanDefinition，返回BeanDefinitionHolder对象bdHolder，这个holder对象封装了“bean定义”——BeanDefinition、bean的名称——beanName以及bean别名数组——aliasesArray。
- 继续调用BeanDefinitionParserDelegate.decorateBeanDefinitionIfRequired方法。对于< bean/>标签下的自定义属性和子标签进行解析，基本不会出现自定义属性和子标签的情况。自定义属性就是除了< bean/>标签自带的属性之外的属性，自定义子标签就是非默认命名空间下的标签。
- 核心方法。调用BeanDefinitionReaderUtils.registerBeanDefinition方法将解析之后的BeanDefinition注册到Registry中，这个Registry实际上就是上下文容器内部的DefaultListableBeanFactory实例。
- 最后发布注册事件，通知相关的监听器，这个Bean已经加载完成了。这是一个空实现，留给子类扩展。
我们主要学习第一步：< bean/>标签的解析获取BeanDefinition的过程，以及第三步：注册BeanDefinition的过程。
/**
* DefaultBeanDefinitionDocumentReader的方法
*
* 处理给定的
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
/*
* 1 核心实现。解析1.1.1 parseBeanDefinitionElement解析< bean/>标签获取BeanDefinitionHolder
我们首先看delegate解析器的parseBeanDefinitionElement方法，从方法名字也能看出来，它的目的就是解析< bean/>标签，并且对解析出来的各种值进行处理后封装成为bean定义对象—BeanDefinition，最后将BeanDefinition、bean的名称- beanName以及bean别名-aliasesArray封装成BeanDefinitionHolder返回。
解析< bean/>标签实际上就是解析< bean/>标签的各种属性、值以及子标签，而我们此前通过SAX解析出来的Element对象就封装了一个标签的全部属性和值，这里只需要提取出来然后做自己的逻辑就行了。
BeanDefinitionParserDelegate中定义了几乎全部的标签属性名常量。
parseBeanDefinitionElement的大概步骤如下：
- 解析、校验< bean/>标签的id和name属性。
- 将name值根据","、";"、" "拆分成为一个别名数组aliases。将id设置为beanName。
- 如果没有设置id属性，那么将第一个别名从aliases移除并作为beanName。
- 对于外部bean，调用checkNameUniqueness方法校验beanName的唯一性
- 调用另一个parseBeanDefinitionElement方法，解析、检验 < bean/>标签的其他属性和子标签并且统一封装至一个GenericBeanDefinition实例beanDefinition中，这是核心方法（使用组件注解的bean定义将被封装成ScannedGenericBeanDefinition，使用@Bean注解的bean定义将被封装成ConfigurationClassBeanDefinition）。
- 如果beanDefinition不为null，那么继续处理beanName，如果没有设置id或者name属性，那么beanName就是空，此时需要按照Spring提供的规则自己生成beanName了，我们在IoC学习部分已经讲过了，但是不全面，这里我们完整的表达一下：
- 如果没有设置id，那么使用设置的第一个name属性作为beanName；
- 如果没有设置id和name，那么使用Spring的规则生成beanName，采用的生成器是DefaultBeanNameGenerator：
- 对于内部bean：
- 内部bean的beanName生成规则就是：“类的全路径名#当前beanDefinition对象的一致性hash码的16进制表示”。
- 即#后面的字符通过"Integer.toHexString(System.identityHashCode(beanDefinition)) "公式生成。由于采用了一致性哈希值，因此生成的beanName不会重复。
- 对于外部bean：
- 外部bean的beanName生成规则就是：“类的全路径名#0”、“类的全路径名#1”、“类的全路径名#2”……
- 有n个没有命名的同类型外部bean，那么名字后面就是从[0,n-1]类似于索引递增的进行命名，如果中途遇到同名bean，那么跳过这个索引，使用下一个。
- 将类的全路径名作为别名。
- 对于内部bean：
- 最后将bean定义——BeanDefinition、bean名字——beanName、bean别名数组——aliasesArray封装至一个BeanDefinitionHolder对象中返回。
另外，方法中的containingBean属性，在很多文章中都没有介绍，这实际上和内部bean有关。containingBean表示当前的bean的包含bean，如果当前标签元素对应一个外部bean，那么该属性为null；如果当前标签元素对应一个内部bean，那么该属性就是它的外部bean的BeanDefinition。
内部bean是什么？这相当于一个专属于某个bean属性bean，或者类似于匿名bean，为该标签设置的name、id、scope属性都是没意义的，将会使用外部bean的属性，但是仍然会生成beanName。在我们IoC学习的部分有详细的案例，在此不做赘述！
/**
* BeanDefinitionParserDelegate的方法
*
* 解析提供的
@Nullable
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
//调用另一个parseBeanDefinitionElement方法，containingBean参数传递null
return parseBeanDefinitionElement(ele, null);
}
//-----BeanDefinitionParserDelegate的相关属性-----
/**
* 一些属性值的分隔符号常量：","、";"、" "
* 比如name属性就可以使用分隔符表示定义多个属性
*/
public static final String MULTI_VALUE_ATTRIBUTE_DELIMITERS = ",; ";
/**
* id属性名常量
*/
public static final String ID_ATTRIBUTE = "id";
/**
* name属性名常量
*/
public static final String NAME_ATTRIBUTE = "name";
/**
* BeanDefinitionParserDelegate的方法
*
* 解析提供的
* 直接使用element对象的相关方法即可获取对应
@Nullable
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
/*
* 1 解析、检验 id和name属性
*/
//获取id属性的值id
String id = ele.getAttribute(ID_ATTRIBUTE);
//获取name属性的值nameAttr
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
//别名集合
List<String> aliases = new ArrayList<>();
/*
* 如果nameAttr不是null也不是""，那么根据","、";"、" "拆分nameAttr为别名数组
*/
if (StringUtils.hasLength(nameAttr)) {
//将 nameAttr 根据","、";"、" "拆分成为一个别名数组
String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
//添加到别名集合aliases中
aliases.addAll(Arrays.asList(nameArr));
}
//beanName默认设置为id
String beanName = id;
//如果没有指定id属性，并且定义了name别名属性
if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
//移除aliases列表的第一个字符串，将其作为beanName，其他的仍然作为别名
beanName = aliases.remove(0);
if (logger.isTraceEnabled()) {
logger.trace("No XML 'id' specified - using '" + beanName +
"' as bean name and " + aliases + " as aliases");
}
}
//如果是外部bean，进行唯一性校验
//内部bean不会检查，实际上内部bean的id 和name属性都没有意义，这一点我们在IoC的学习部分已经介绍了
if (containingBean == null) {
/*
* 检查当前1.1.1.1 checkNameUniqueness校验beanName唯一性
BeanDefinitionParserDelegate内部具有一个usedNames的集合，存储了当前< beans/>标签下所有使用的 bean 名称和别名，以便检查每个 bean 元素的唯一性。一个< beans/>标签对应一个BeanDefinitionParserDelegate解析器。
checkNameUniqueness方法用于从usedNames集合中检查当前的bean的名字和别名的唯一性，如果名字和别名在同一个< beans/>标签内不唯一，那么直接抛出异常。如果唯一，则将当前的bean的名字和别名加入到usedNames集合中，为后面的bean的唯一性检查所使用。
/**
* BeanDefinitionParserDelegate的属性
*
* 存储一个
private final Set<String> usedNames = new HashSet<>();
/**
* BeanDefinitionParserDelegate的方法
*
* 检查当前
protected void checkNameUniqueness(String beanName, List<String> aliases, Element beanElement) {
//被找到的name
String foundName = null;
//如果beanName不为空并且usedNames已经包含了这个beanName
if (StringUtils.hasText(beanName) && this.usedNames.contains(beanName)) {
//foundName赋值给beanName
foundName = beanName;
}
//如果没有找到beanName，那么继续找aliases
if (foundName == null) {
//获取第一个找到的name赋值给beanName
foundName = CollectionUtils.findFirstMatch(this.usedNames, aliases);
}
//如果foundName(被找到的name)属性不为null，说明有重复的名字和别名，直接抛出异常
if (foundName != null) {
error("Bean name '" + foundName + "' is already used in this 1.1.1.2 parseBeanDefinitionElement解析< bean/>标签获取bean定义
parseBeanDefinitionElement(ele,beanName,containingBean)方法被前面的parseBeanDefinitionElement(ele,containingBean)方法调用。
该方法用于解析 < bean/>标签的其他属性（不考虑名称或别名，因此此前已经解析过了），以及内部的其他子标签，并且将解析结果统一封装至一个GenericBeanDefinition实例中返回，如果在解析期间出现问题，则可能会返回null。
我们主要学习createBeanDefinition、parseBeanDefinitionAttributes、parseConstructorArgElement、parsePropertyElement这几个方法。
//-----BeanDefinitionParserDelegate的相关属性-----
public static final String CLASS_ATTRIBUTE = "class";
public static final String PARENT_ATTRIBUTE = "parent";
public static final String DESCRIPTION_ELEMENT = "description";
/**
* BeanDefinitionParserDelegate的方法
*
* 解析
@Nullable
public AbstractBeanDefinition parseBeanDefinitionElement(
Element ele, String beanName, @Nullable BeanDefinition containingBean) {
//记录解析过程，开始
this.parseState.push(new BeanEntry(beanName));
/*1 解析class属性*/
String className = null;
if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
//去除前后空白
className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
}
/*2 解析parent属性*/
String parent = null;
if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
parent = ele.getAttribute(PARENT_ATTRIBUTE);
}
try {
/*3 使用给定的bean className和bean parentName属性创建BeanDefinition对象。*/
//BeanDefinition的实际类型是GenericBeanDefinition类型
AbstractBeanDefinition bd = createBeanDefinition(className, parent);
/*4 1.1.1.2.1 createBeanDefinition创建BeanDefinition
createBeanDefinition使用给定的bean className和bean parentName属性创建BeanDefinition对象。
BeanDefinition的实际类型是GenericBeanDefinition类型。BeanDefinition对象非常重要，这就是XML中的“bean定义”在Java中的抽象！我们常说的bean定义就是指XML中定义的某个bean在Java中对应的BeanDefinition对象！
/**
* BeanDefinitionParserDelegate的方法
*
* 使用给定的bean className和bean parentName属性创建BeanDefinition对象。
* BeanDefinition的实际类型是GenericBeanDefinition类型
*
* @param className bean的class属性值
* @param parentName bean的parent属性值
* @return 新创建的 bean 定义(BeanDefinition)
* @throws ClassNotFoundException 解析bean的class失败
*/
protected AbstractBeanDefinition createBeanDefinition(@Nullable String className, @Nullable String parentName)
throws ClassNotFoundException {
//调用BeanDefinitionReaderUtils工具类的方法
return BeanDefinitionReaderUtils.createBeanDefinition(
parentName, className, this.readerContext.getBeanClassLoader());
}
/**
* BeanDefinitionReaderUtils的方法
*
* 使用给定的bean className和bean parentName属性创建GenericBeanDefinition对象。
*
* @param parentName bean的parent属性值
* @param className bean的class属性值
* @param classLoader 用于加载 bean 类的类加载器，可以为null（按名称注册 bean class ）
* @return bean 定义
* @throws ClassNotFoundException 如果无法加载 bean 的class
*/
public static AbstractBeanDefinition createBeanDefinition(
@Nullable String parentName, @Nullable String className, @Nullable ClassLoader classLoader) throws ClassNotFoundException {
//创建GenericBeanDefinition对象
GenericBeanDefinition bd = new GenericBeanDefinition();
//设置parentName属性
bd.setParentName(parentName);
//如果className不为null
if (className != null) {
//类加载器不为null
if (classLoader != null) {
//通过全路径的className获取Class对象，并设置到beanClass属性中
bd.setBeanClass(ClassUtils.forName(className, classLoader));
} else {
//将className直接设置到beanClass属性中
bd.setBeanClassName(className);
}
}
//返回已创建GenericBeanDefinition对象
return bd;
}
1.1.1.2.2 parseBeanDefinitionAttributes解析< bean/>标签的各种属性
这一步就是机械化的解析< bean/>标签剩下属性，并将结果同样封装到该bean对应的BeanDefinition对象中。
在此前createDelegate方法创建解析器的时候，就已经解析了外部< beans/>根标签的属性，并存入defaults属性对象中。在parseBeanDefinitionAttributes方法中某些属性如果没有设置值，那么将使用外部< beans/>标签的属性值。如果当前bean自己设置了值，那么就不会使用外部< beans/>根标签的属性，这就是我们在IoC学习过程中所说的一些属性设置覆盖原则。
//-----BeanDefinitionParserDelegate的部分属性-----
private static final String SINGLETON_ATTRIBUTE = "singleton";
public static final String SCOPE_ATTRIBUTE = "scope";
public static final String ABSTRACT_ATTRIBUTE = "abstract";
public static final String TRUE_VALUE = "true";
public static final String LAZY_INIT_ATTRIBUTE = "lazy-init";
public static final String AUTOWIRE_ATTRIBUTE = "autowire";
public static final String DEPENDS_ON_ATTRIBUTE = "depends-on";
public static final String AUTOWIRE_CANDIDATE_ATTRIBUTE = "autowire-candidate";
public static final String PRIMARY_ATTRIBUTE = "primary";
public static final String INIT_METHOD_ATTRIBUTE = "init-method";
public static final String DESTROY_METHOD_ATTRIBUTE = "destroy-method";
public static final String FACTORY_METHOD_ATTRIBUTE = "factory-method";
public static final String FACTORY_BEAN_ATTRIBUTE = "factory-bean";
/**
* 分隔符号：","、";"、" "
*/
public static final String MULTI_VALUE_ATTRIBUTE_DELIMITERS = ",; ";
/**
* BeanDefinitionParserDelegate的方法
*
* 解析
*
* 在此前createDelegate方法创建解析器的时候，就已经解析了外部
public AbstractBeanDefinition parseBeanDefinitionAttributes(Element ele, String beanName,
@Nullable BeanDefinition containingBean, AbstractBeanDefinition bd) {
/*如果具有singleton属性*/
if (ele.hasAttribute(SINGLETON_ATTRIBUTE)) {
//抛出异常，singleton属性在1.x版本之后已经不被支持，使用scope属性代替
//error("Old 1.x 'singleton' attribute in use - upgrade to 'scope' declaration", ele);
}
/*否则，如果具有scope属性*/
else if (ele.hasAttribute(SCOPE_ATTRIBUTE)) {
//设置scope属性值
bd.setScope(ele.getAttribute(SCOPE_ATTRIBUTE));
}
/*否则，当前bean是一个内部bean，进行内部bean处理*/
else if (containingBean != null) {
//内部bean的定义接收外部包含bean定义的属性
//这里能够看出来，内部bean自己设置scope属性值是没意义的
bd.setScope(containingBean.getScope());
}
//如果具有abstract属性
if (ele.hasAttribute(ABSTRACT_ATTRIBUTE)) {
//设置abstract属性
bd.setAbstract(TRUE_VALUE.equals(ele.getAttribute(ABSTRACT_ATTRIBUTE)));
}
//获取lazy-init属性的值lazyInit
String lazyInit = ele.getAttribute(LAZY_INIT_ATTRIBUTE);
//如果是默认值或者是""
if (isDefaultValue(lazyInit)) {
//那么使用外部1.1.1.2.3 parseConstructorArgElements解析所有< constructor-arg/>子标签
首先获取< bean/>标签元素下面的所有子节点元素，然后循环遍历，如果如果当前节点是一个标签节点并且标签名为"constructor-arg"，那么继续调用parseConstructorArgElement方法解析该< constructor-arg/>标签。
< constructor-arg/>标签对应着构造器注入的标签，解析后的结果将统一封装到BeanDefinition中的ConstructorArgumentValues属性中。
/**
* BeanDefinitionParserDelegate的属性
*
3. 解析
public void parseConstructorArgElements(Element beanEle, BeanDefinition bd) {
//获取1.1.1.2.3.1 parseConstructorArgElement解析一个< constructor-arg/>子标签
parseConstructorArgElement用于解析一个< constructor-arg/>子标签，并将相关属性和值存入当前< bean/>标签元素对应的BeanDefinition的ConstructorArgumentValues属性中。
大概步骤为：
- 首先解析index、type、name属性，获取值indexAttr、typeAttr、nameAttr；
- 如果indexAttr的值不为null也不为””，即设置了index索引属性：
- indexAttr尝试转换为数值index，如果无法转换或者转换之后的值小于0，那么抛出异常。
- 调用parsePropertyValue方法解析标签的值（值可能来自value属性、ref属性、或者子标签）并返回解析结果。
- 将返回的值解析结果、typeAttr、nameAttr等属性封装到一个ConstructorArgumentValues.ValueHolder类型的对象valueHolder中。
- 从目前的BeanDefinition中查找，判断当前的index是否已存在：
- 如果存在，说明index属性重复，抛出异常。
- 如果不存在，那么正常。将当前< constructor-arg/>子标签的解析结果以key-value的形式封装（key就是index，value就是valueHolder）封装到BeanDefinition中的ConstructorArgumentValues属性中的indexedArgumentValues属性中。
- 如果indexAttr的值为null或者”” ，即没设置index属性：
- 调用parsePropertyValue方法解析标签的值（值可能来自value属性、ref属性、或者子标签）并返回解析结果。
- 将返回的值解析结果、typeAttr、nameAttr等属性封装到一个ConstructorArgumentValues.ValueHolder类型的对象valueHolder中。
- 将当前< constructor-arg/>子标签的解析结果valueHolder封装到BeanDefinition中的ConstructorArgumentValues属性中的genericArgumentValues属性中。
- 最后返回BeanDefinition，已经封装了当前< constructor-arg>标签的解析结果。
从源码可知，所有的< constructor-arg/>子标签的结果都存入BeanDefinition中的ConstructorArgumentValues属性中。其中具有index索引的以“index-valueHolder”的形式存入该属性对象内部的indexedArgumentValues属性中，就是一个Map；没有设置index索引的以单个valueHolder的形式存入该属性对象内部的genericArgumentValues属性中，就是一个List。
//--------BeanDefinitionParserDelegate的相关属性---------
public static final String INDEX_ATTRIBUTE = "index";
public static final String TYPE_ATTRIBUTE = "type";
public static final String NAME_ATTRIBUTE = "name";
/**
* BeanDefinitionParserDelegate的方法
*
* 解析一个
public void parseConstructorArgElement(Element ele, BeanDefinition bd) {
//获取index、type、name属性的值indexAttr、typeAttr、nameAttr
String indexAttr = ele.getAttribute(INDEX_ATTRIBUTE);
String typeAttr = ele.getAttribute(TYPE_ATTRIBUTE);
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
/*如果indexAttr不为null也不为""，即设置了1.1.1.2.4 parsePropertyElements解析所有< property>子标签
首先获取< bean/>标签元素下面的所有子标签元素，然后循环遍历，如果如果当前节点是一个标签节点并且标签名为"property"，那么继续调用parsePropertyElement方法解析该< property/>标签。
< property/>标签对应着我们手动设置的setter方法注入的标签，解析后的结果将统一封装到BeanDefinition中的propertyValues属性中。
/**
* BeanDefinitionParserDelegate的属性
*
3. 解析
public void parsePropertyElements(Element beanEle, BeanDefinition bd) {
//获取1.1.1.2.4.1 parsePropertyElement解析一个< property/>子标签
parsePropertyElement用于解析一个< property/>子标签，并将相关属性和值存入当前< bean/>标签元素对应的BeanDefinition的propertyValues属性中。
大概步骤为：
- 首先解析name属性，获取属性名称propertyName。如果propertyName值为null或者""，那么抛出异常。
- 继续校验如果当前< bean/>标签元素对应的BeanDefinition的propertyValues属性中包含了当前propertyName，即name重复，那么抛出异常。
- 调用parsePropertyValue方法，解析< property/>子标签元素的值，值可能来自value属性、ref属性、或者子标签，返回相应的值封装对象。
- 这个方法和解析constructor-arg标签的代码中的值解析是调用的同一个方法，区别是propertyName属性不为null，而这个propertyName属性仅仅是为了异常日志打印而已，没有其他作用。
- 将属性名propertyName和解析出来的值封装成为一个PropertyValue类型的对象pv，将pv封装到BeanDefinition中的propertyValues属性中，实际上是将pv封装到该属性对象内部的propertyValueList集合中。
/**
* BeanDefinitionParserDelegate的属性
* name属性名常量
*/
public static final String NAME_ATTRIBUTE = "name";
/**
1. BeanDefinitionParserDelegate的方法
2.
3. 解析一个
public void parsePropertyElement(Element ele, BeanDefinition bd) {
//获取name属性值propertyName，即属性名称
String propertyName = ele.getAttribute(NAME_ATTRIBUTE);
//如果属性名称为null或者""，那么抛出异常
if (!StringUtils.hasLength(propertyName)) {
error("Tag 'property' must have a 'name' attribute", ele);
return;
}
//记录解析
this.parseState.push(new PropertyEntry(propertyName));
try {
//如果当前1.1.1.2.5 parsePropertyValue解析标签元素的值
parsePropertyValue方法用于解析、获取< property/>标签和< constructor-arg/>标签的值，这里的值可能来自于value属性、ref属性，或者是一个< list/>、< map/>等等子标签，因此返回的值可能是标签上的一个value属性、ref属性的解析结果，也可能是标签内部的值标签，比如list、map等标签的解析结果。
在解析< constructor-arg/>标签的值时，"propertyName"属性为 null，在解析< property/>标签的值时，"propertyName"属性为不为null。这个propertyName属性主要用于异常日志输出，没啥其他用处。
大概步骤为：
- 校验“值子标签”只能有一个，对于< property/>、< constructor-arg/>标签内部不属于< description/>和< meta/>标签的其他子标签，比如< ref/>, < value/>, < list/>,< etc/>,< map/>等等，它们都被算作"值子标签"。值子标签就是对应着< property/>、< constructor-arg/>标签的值，Spring要求最多只能有其中一个值子标签，校验不通过则抛出异常“must not contain more than one sub-element”。
- 继续校验< property/>标签和< constructor-arg/>标签的ref属性、value属性以及值子标签这三者只能有一个，因为这三个都表示该< property/>标签和< constructor-arg/>的值，只需要一个就行了，校验不通过则抛出异常“is only allowed to contain either ‘ref’ attribute OR ‘value’ attribute OR sub-element”。
- 校验通过，开始解析：
- 如果具有ref属性，那么肯定没有value属性以及值子标签，那么解析ref属性：
- 获取ref属性值refName，如果refName为””，那么抛出异常。
- 根据refName新建一个RuntimeBeanReference对象，这就是一个值对象，表示引用了其他对象，将在创建该bean实例时动态的解析，返回该对象，方法结束！
- 如果具有value属性，那么肯定ref属性以及值子标签，那么解析value属性：
- 根据value属性的值，创建一个TypedStringValue对象，这就是一个值对象，表示一个String类型的值对象，仅仅持有value字符串的，运行时值可以转换为其它类型，比如int、long等等，返回该对象，方法结束！
- 否则，如果具有值子标签，那么肯定没有ref属性以及value属性，那么调用parsePropertySubElement方法统一解析所有类型的值子标签，并返回解析结果。
- 否则，啥都没有设置，抛出异常。
- 如果具有ref属性，那么肯定没有value属性以及值子标签，那么解析ref属性：
//--------BeanDefinitionParserDelegate的相关属性---------
public static final String META_ELEMENT = "meta";
public static final String DESCRIPTION_ELEMENT = "description";
public static final String REF_ATTRIBUTE = "ref";
public static final String VALUE_ATTRIBUTE = "value";
/**
* BeanDefinitionParserDelegate的方法
*
* 用于解析、获取
、等等子标签
*
* 在解析
@Nullable
public Object parsePropertyValue(Element ele, BeanDefinition bd, @Nullable String propertyName) {
String elementName = (propertyName != null ?
" element for property '" + propertyName + "'" :
" element" );
/*
* 1 校验 值子标签只能有一个
*
* 对于
,
, 1.1.1.2.5.1 parsePropertySubElement解析值子标签
< property/>或者< constructor-arg/>标签元素的值也是可以使用子标签表示的，可能是< bean/>、< ref/>、< idref/>……等标签，此时调用parsePropertySubElement方法，用于解析< property/>或者< constructor-arg/>标签内部对应的值子标签。
该方法可以解析的值子标签类型有：< bean/>、< ref/>、< idref/>、< value/>、< null/>、< array/>、< list/>、< set/>、< map/>、< props/>等标签。
/**
* BeanDefinitionParserDelegate的方法
*
* 该方法仅仅被parsePropertyValue(Element ele, BeanDefinition bd, @Nullable String propertyName)方法调用
* 解析标签下面的一个……等值子标签
*
* @param ele 标签的一个值子标签元素，不知道具体是什么类型的
* @param bd 当前所属
@Nullable
public Object parsePropertySubElement(Element ele, @Nullable BeanDefinition bd) {
//调用另一个parsePropertySubElement方法，第三个属性为null
return parsePropertySubElement(ele, bd, null);
}
下面的三个参数的parsePropertySubElement方法非常重要。
该方法用于解析< property/>或者< constructor-arg/>标签下面的值子标签，同时用于解析单value集合标签(< array/>、< list/>、< set/>)下的值子标签，以及< map/>集合标签下的< key/>标签的子标签和表示value的值子标签，以及标签的递归解析。
//------BeanDefinitionParserDelegate的相关属性-------
public static final String BEAN_ELEMENT = "bean";
public static final String REF_ELEMENT = "ref";
public static final String BEAN_REF_ATTRIBUTE = "bean";
public static final String PARENT_REF_ATTRIBUTE = "parent";
public static final String IDREF_ELEMENT = "idref";
public static final String VALUE_ELEMENT = "value";
public static final String NULL_ELEMENT = "null";
public static final String ARRAY_ELEMENT = "array";
public static final String LIST_ELEMENT = "list";
public static final String SET_ELEMENT = "set";
public static final String MAP_ELEMENT = "map";
public static final String PROPS_ELEMENT = "props";
/**
* BeanDefinitionParserDelegate的方法，该方法也被其他子标签的解析方法调用
*
* 该方法用于解析
、
@Nullable
public Object parsePropertySubElement(Element ele, @Nullable BeanDefinition bd, @Nullable String defaultValueType) {
/*
* 1 如果不是默认命名空间下的标签，那么走自定义的解析逻辑
*/
if (!isDefaultNamespace(ele)) {
//会返回一个BeanDefinitionHolder作为值
return parseNestedCustomElement(ele, bd);
}
/*
* 2 否则，如果值子标签是
标签，这表示值是一个list集合
*/
else if (nodeNameEquals(ele, LIST_ELEMENT)) {
return parseListElement(ele, bd);
}
/*
* 9 否则，如果子标签是1.1.1.2.5.1.1 parseValueElement解析< value/>值标签
parseValueElement用于解析< value/>值标签，将结果封装成为一个TypedStringValue对象返回，内部还可以包含指定的类型，在运行时会进行转换。
/**
* BeanDefinitionParserDelegate的属性
* type属性名常量
*/
public static final String TYPE_ATTRIBUTE = "type";
/**
* BeanDefinitionParserDelegate的方法
*
* 返回给定
public Object parseValueElement(Element ele, @Nullable String defaultTypeName) {
//获取字面值
String value = DomUtils.getTextValue(ele);
//获取type属性值specifiedTypeName
String specifiedTypeName = ele.getAttribute(TYPE_ATTRIBUTE);
String typeName = specifiedTypeName;
//如果没有指定类型，那么使用外部标签指定的type
if (!StringUtils.hasText(typeName)) {
typeName = defaultTypeName;
}
try {
//使用typeName和value创建TypedStringValue对象typedValue返回
TypedStringValue typedValue = buildTypedStringValue(value, typeName);
typedValue.setSource(extractSource(ele));
typedValue.setSpecifiedTypeName(specifiedTypeName);
return typedValue;
} catch (ClassNotFoundException ex) {
error("Type class [" + typeName + "] not found for element" , ele, ex);
return value;
}
}
/**
* BeanDefinitionParserDelegate的方法
*
* 使用给定的值和目标类型，构建一个TypedStringValue
* TypedStringValue用于包装
protected TypedStringValue buildTypedStringValue(String value, @Nullable String targetTypeName)
throws ClassNotFoundException {
ClassLoader classLoader = this.readerContext.getBeanClassLoader();
TypedStringValue typedValue;
//如果没有指定类型targetTypeName，那么使用默认那么使用要给value的参数构建一个TypedStringValue
if (!StringUtils.hasText(targetTypeName)) {
typedValue = new TypedStringValue(value);
}
//否则，如果类加载器不为null
else if (classLoader != null) {
//那么获取targetTypeName类型的Class对象，并构建一个TypedStringValue
Class<?> targetType = ClassUtils.forName(targetTypeName, classLoader);
typedValue = new TypedStringValue(value, targetType);
}
//否则，使用两个字符串参数构建一个
else {
typedValue = new TypedStringValue(value, targetTypeName);
}
return typedValue;
}
1.1.1.2.5.1.2 解析< array/>、< list/>、< set/>值标签
< array/>、< list/>、< set/>值标签的特点就是单value类型的集合，它们的解析方法比较相近，这里统一讲解。对应的解析结果分别是ManagedArray、ManagedList、ManagedSet类型的对象。
此前IoC学习的时候我们讲过Spring支持集合合并，这里也会调用parseMergeAttribute方法处理merge属性。
对于集合标签内部的子标签，可能是其他任何值标签，因此需要同样递归上面三个参数的parsePropertySubElement方法进行递归解析。
/**
* BeanDefinitionParserDelegate的属性
* value-type属性名常量
*/
public static final String VALUE_TYPE_ATTRIBUTE = "value-type";
/**
* BeanDefinitionParserDelegate的方法
*
* 解析
public Object parseArrayElement(Element arrayEle, @Nullable BeanDefinition bd) {
//获取value-type属性值elementType
String elementType = arrayEle.getAttribute(VALUE_TYPE_ATTRIBUTE);
//获取
* 解析
标签元素
*/
public List<Object> parseListElement(Element collectionEle, @Nullable BeanDefinition bd) {
//获取value-type属性值elementType
String defaultElementType = collectionEle.getAttribute(VALUE_TYPE_ATTRIBUTE);
//获取
标签的子标签集合，里面的一个子标签相当于一个list集合元素
NodeList nl = collectionEle.getChildNodes();
//创建用于托管List元素的标记集合类ManagedList，其中可能包括运行时 bean 引用（要解析为 bean 对象）。
//将会返回该对象作为解析结果
ManagedList<Object> target = new ManagedList<>(nl.getLength());
target.setSource(extractSource(collectionEle));
target.setElementTypeName(defaultElementType);
//设置mergeEnabled属性，表示是否需要合并父bean的集合属性
target.setMergeEnabled(parseMergeAttribute(collectionEle));
//调用parseCollectionElements继续解析
parseCollectionElements(nl, target, bd, defaultElementType);
return target;
}
/**
* BeanDefinitionParserDelegate的方法
*
* 解析
public Set<Object> parseSetElement(Element collectionEle, @Nullable BeanDefinition bd) {
//获取value-type属性值elementType
String defaultElementType = collectionEle.getAttribute(VALUE_TYPE_ATTRIBUTE);
//获取
* 处理集合标签的merge属性，用于与父bean配置的集合合并。
*/
public boolean parseMergeAttribute(Element collectionElement) {
//获取merger属性
String value = collectionElement.getAttribute(MERGE_ATTRIBUTE);
//如果是默认值，那么获取外部
3. 解析单value类型的集合标签
4. 5. @param elementNodes 单value类型的集合标签内部子标签集合
6. @param target 用于托管集合元素的标记集合类
7. @param bd bean定义
8. @param defaultElementType value-type属性值
*/
protected void parseCollectionElements(
NodeList elementNodes, Collection<Object> target, @Nullable BeanDefinition bd, String defaultElementType) {
//循环子标签集合
for (int i = 0; i < elementNodes.getLength(); i++) {
Node node = elementNodes.item(i);
//如果属于标签并且不是description标签
if (node instanceof Element && !nodeNameEquals(node, DESCRIPTION_ELEMENT)) {
//那么递归调用parsePropertySubElement解析这些标签，将返回的结果添加到target中
target.add(parsePropertySubElement((Element) node, bd, defaultElementType));
}
}
}
1.1.1.2.5.1.3 parseMapElement解析< map/>值标签
< map/>集合标签的解析和上面的单value集合标签的解析有些区别，它更加复杂，将会返回ManagedMap类型的解析结果。大概步骤如下：
- 获取相关属性：key-type、value-type、merge，将值设置到用于托管Map元素的标记集合类ManagedMap对象中。
- 遍历< map/>集合标签下的遍历所有子标签元素，进行解析：
- 遍历< entry/>子标签的子标签集合，尝试校验并获取key和value对应的标签，可能为null。key对应的< key/>子标签可以没有，但最多有一个；value对应的value值子标签可以没有，但最多有一个；
- 解析key的值。这里就类似于parsePropertyValue方法的逻辑，key的值可能来自于< entry/>标签的key属性、key-ref属性、或者< key/>标签。在同一个< entry/>标签中只能出现三者的其中一个。
- 解析value的值。这里就类似于parsePropertyValue方法的逻辑，value的值可能来自于< entry/>标签的value属性、value-ref属性或者其他value值标签。在同一个< entry/>标签中只能出现三者的其中一个。
- 如果设置了value-type属性，那么只能使用value属性设置value值，但是如果使用value属性，那么可以不设置value-type属性。
- 将解析之后的key、value值添加到ManagedMap中。
- 返回ManagedMap对象。
从源码就能看到对于其他的值子标签的解析同样是递归调用三个参数的parsePropertySubElement方法解析，这里的第三个参数defaultValueType就是对应着外层标签的key-type，value-type属性，或者< entry/>标签的value-type属性（将覆盖< map/>标签的value-type属性）。
//------BeanDefinitionParserDelegate的相关属性------
public static final String VALUE_TYPE_ATTRIBUTE = "value-type";
public static final String KEY_TYPE_ATTRIBUTE = "key-type";
public static final String ENTRY_ELEMENT = "entry";
public static final String KEY_ELEMENT = "key";
public static final String DESCRIPTION_ELEMENT = "description";
public static final String KEY_ATTRIBUTE = "key";
public static final String KEY_REF_ATTRIBUTE = "key-ref";
public static final String VALUE_REF_ATTRIBUTE = "value-ref";
public static final String VALUE_ATTRIBUTE = "value";
/**
* BeanDefinitionParserDelegate的方法
*
* 解析标签元素
*
* @param bd BeanDefinition
* @param mapEle 标签元素
*/
public Map<Object, Object> parseMapElement(Element mapEle, @Nullable BeanDefinition bd) {
/*
* 1 获取、设置相关属性：key-type、value-type、merge，设置到用于托管Map元素的标记集合类ManagedMap中
*/
//获取key-type属性值defaultKeyType作为key的默认类型
String defaultKeyType = mapEle.getAttribute(KEY_TYPE_ATTRIBUTE);
//获取value-type属性值defaultValueType作为value的默认类型
String defaultValueType = mapEle.getAttribute(VALUE_TYPE_ATTRIBUTE);
//获取所有的 element is only allowed to contain one sub-element" , entryEle);
} else {
//否则记录
keyEle = candidateEle;
}
}
//如果不是 -> ignore it
}
//否则，就是表示value的值标签
// 如果valueEle不为null，那么说明当前 element must not contain more than one value sub-element" , entryEle);
} else {
//否则记录
valueEle = candidateEle;
}
}
}
}
/*
* 2.2 解析key的值
* 这里就类似于parsePropertyValue方法的逻辑，key的值可能来自于 element is only allowed to contain either " +
"a 'key' attribute OR a 'key-ref' attribute OR a sub-element" , entryEle);
}
/*2.2.1 如果具有key属性，那么肯定没有key-ref属性以及 element contains empty 'key-ref' attribute" , entryEle);
}
//key封装为一个RuntimeBeanReference对象
RuntimeBeanReference ref = new RuntimeBeanReference(refName);
ref.setSource(extractSource(entryEle));
key = ref;
}
/*2.2.3 否则，如果具有 element must specify a key" , entryEle);
}
/*
* 2.3 解析value的值
* 这里就类似于parsePropertyValue方法的逻辑，value的值可能来自于 element is only allowed to contain either " +
"'value' attribute OR 'value-ref' attribute OR sub-element" , entryEle);
}
//如果具有value-type属性，并且（具有value-ref属性，或者没有value属性，或者具有value值子标签，那么抛出异常
//意思就是value-type属性如果被设置了，那么一定和value属性绑定；反过来，如果设置了value属性，那么value-type属性则不一定需要
if ((hasValueTypeAttribute && hasValueRefAttribute) ||
(hasValueTypeAttribute && !hasValueAttribute) ||
(hasValueTypeAttribute && valueEle != null)) {
error(" element is only allowed to contain a 'value-type' " +
"attribute when it has a 'value' attribute", entryEle);
}
/*2.3.1 如果具有value属性，那么肯定没有value-ref属性以及value值子标签*/
if (hasValueAttribute) {
//获取 element contains empty 'value-ref' attribute" , entryEle);
}
//value封装为一个RuntimeBeanReference对象
RuntimeBeanReference ref = new RuntimeBeanReference(refName);
ref.setSource(extractSource(entryEle));
value = ref;
}
/*2.3.3 否则，如果具有value值子标签，那么肯定没有value属性以及value-ref属性*/
else if (valueEle != null) {
//递归调用parsePropertySubElement方法解析value值子标签
value = parsePropertySubElement(valueEle, bd, defaultValueType);
}
/*2.3.4 否则，啥都没有，抛出异常*/
else {
error(" element must specify a value" , entryEle);
}
//解析之后的key、value值添加到ManagedMap中
// Add final key and value to the Map.
map.put(key, value);
}
//返回ManagedMap对象
return map;
}
//----解析 element must not contain more than one value sub-element" , keyEle);
} else {
subElement = (Element) node;
}
}
}
//如果1.1.1.2.5.1.4 解析< props/>集合值标签
parsePropsElement方法用于解析< props/>集合值标签，比较简单，因为properties集合的key和value只能是String类型，不需要递归解析。将会返回ManagedProperties类型的解析结果。
//------BeanDefinitionParserDelegate的相关属性------
public static final String PROP_ELEMENT = "prop";
public static final String KEY_ATTRIBUTE = "key";
/**
1. BeanDefinitionParserDelegate的方法
2.
3. 解析
public Properties parsePropsElement(Element propsEle) {
//创建用于托管Properties元素的标记集合类ManagedProperties
ManagedProperties props = new ManagedProperties();
props.setSource(extractSource(propsEle));
//设置mergeEnabled属性，表示是否需要合并父bean的集合属性
props.setMergeEnabled(parseMergeAttribute(propsEle));
//获取所有的1.1.2 registerBeanDefinition注册Bean定义
当我们将BeanDefinitionHolder创建完毕之后，所谓的bean定义就创建完了，随后会调用BeanDefinitionReaderUtils.registerBeanDefinition方法将BeanDefinitionHolder注册到注册表Registry中，这个Registry实际上就是上下文容器内部的DefaultListableBeanFactory实例。
如果该方法注册完毕并且发送注册事件完毕之后，那么refresh()方法中的obtainFreshBeanFactory方法步骤就算真正结束了，随后将会进入下一步。
registerBeanDefinition方法的大概逻辑就是：
- 获取BeanDefinitionHolder对象中持有的BeanDefinition、beanName和aliases。
- 调用registerBeanDefinition方法。将beanName和对应的BeanDefinition注册到registry的对应缓存集合中，这个缓存实际上就是上下文容器内部的DefaultListableBeanFactory实例中的beanDefinitionMap和beanDefinitionNames两个缓存。
- 调用registerAlias方法，将beanName和aliases中的每一个别名注册到registry的缓存中。这个缓存实际上就是上下文容器内部的DefaultListableBeanFactory的父类SimpleAliasRegistry注册表实例中的aliasMap缓存。
这些缓存并不是对象实例的缓存，实际上到目前为止还没有bean被初始化，但是很明显，这些缓存定义了一个bean实例的全部特点，是为后面的bean实例初始化做准备的。
/**
* BeanDefinitionReaderUtils的方法
*
* 向给定的 bean 工厂注册给定的 bean 的定义
*
* @param definitionHolder 封装了了bean 定义、包括bean的名称和别名
* @param registry bean工厂的注册器
* 这个Registry实际上就是容器内部的DefaultListableBeanFactory实例，
* 因为DefaultListableBeanFactory实现了BeanDefinitionRegistry接口
*/
public static void registerBeanDefinition(
BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
throws BeanDefinitionStoreException {
//获取bean的名称
String beanName = definitionHolder.getBeanName();
/*
* 1 将beanName和对应的BeanDefinition注册到registry中的相关缓存中
* 这个Registry实际上就是容器内部的DefaultListableBeanFactory实例
*/
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
/*
* 2 注册 bean的别名（如果有）
*/
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
for (String alias : aliases) {
//注册bean的名称和对应的每一个别名的映射到缓存SimpleAliasRegistry的aliasMap缓存集合中
registry.registerAlias(beanName, alias);
}
}
}
1.1.2.1 registerBeanDefinition注册BeanDefinition
registerBeanDefinition方法大概步骤为：
将beanName和BeanDefinition注册到registry的缓存中。这个缓存实际上就是上下文容器内部的DefaultListableBeanFactory实例中的beanDefinitionMap和beanDefinitionNames两个缓存。同时还会使用到allowBeanDefinitionOverriding属性判断是否可以进行bean定义的覆盖。
registerBeanDefinition方法详细步骤为：
- 首先尝试从注册表的缓存beanDefinitionMap中查找当前beanName的bean定义existingDefinition。
- 如果existingDefinition不为null，即找到了同名bean定义，那么进行ban定义覆盖的校验和操作：
- 通过allowBeanDefinitionOverriding属性判断是否不允许 bean 的覆盖，如果不允许，那么抛出异常；如果允许，那么进行覆盖，即设置beanDefinitionMap缓存的该beanName的value值为最新的BeanDefinition。
- 如果existingDefinition为null，即没找到同名bean定义，那么将beanName以及对应的beanDefinition设置到beanDefinitionMap缓存，将当前的beanName存入beanDefinitionNames缓存，将当前的beanName从手动注册bean名称集合manualSingletonNames缓存中移除。
- 如果找到了同名bean定义，或者单例bean实例的缓存singletonObjects已中包含给定beanName的实例。那么将当前beanName对应的在DefaultSingletonBeanRegistry中的实例缓存清除，重置给定 beanName 的所有 bean 定义缓存，包括从它派生的 bean 的缓存(merge)，以及重置以给定beanName为父类bean的子类Bean缓存。
- 否则如果此工厂的 bean 定义被冻结，即不应进一步修改或后处理，那么删除所有的按类型映射的任何缓存：allBeanNamesByType和singletonBeanNamesByType。在finishBeanFactoryInitialization方法中就会冻结 bean 定义，并且进行bean初始化操作。
//-----------DefaultListableBeanFactory的相关属性----------
/**
* beanName到bean definition映射的map，这就是一个beanDefinition注册表缓存
* 后面创建bean实例的时候会使用
*/
private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<>(256);
/**
* 按注册顺序排列的beanName的列表
*/
private volatile List<String> beanDefinitionNames = new ArrayList<>(256);
/**
* DefaultListableBeanFactory的方法
*
* 在此注册表缓存中注册一个新的 bean 定义
* 这里将会校验前面设置的allowBeanDefinitionOverriding属性
*
* @param beanName 要注册的 bean 实例的名称
* @param beanDefinition 要注册的 bean 实例的定义
*/
@Override
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
throws BeanDefinitionStoreException {
Assert.hasText(beanName, "Bean name must not be empty");
Assert.notNull(beanDefinition, "BeanDefinition must not be null");
//bean definition注册前的校验，methodOverrides校验
if (beanDefinition instanceof AbstractBeanDefinition) {
try {
((AbstractBeanDefinition) beanDefinition).validate();
} catch (BeanDefinitionValidationException ex) {
throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,
"Validation of bean definition failed", ex);
}
}
//尝试从注册表缓存中查找当前beanName的BeanDefinition
BeanDefinition existingDefinition = this.beanDefinitionMap.get(beanName);
/*
* 1 如果找到了同名的BeanDefinition，进行ban定义覆盖的校验和操作
*/
if (existingDefinition != null) {
/*
* 判断是否不允许 bean 的覆盖
*
* allowBeanDefinitionOverriding属性我们在“customizeBeanFactory配置beanFactory”的部分已经讲过
* 普通应用默认为true，boot应用默认false，可以自定义配置
*/
if (!isAllowBeanDefinitionOverriding()) {
//如果不允许，那么就是出现同名bean，那么直接抛出异常
throw new BeanDefinitionOverrideException(beanName, beanDefinition, existingDefinition);
}
/*
* 否则，表示允许，继续判断角色相关，不必关心
* 打印日志，用框架定义的 Bean 覆盖用户自定义的 Bean
*/
else if (existingDefinition.getRole() < beanDefinition.getRole()) {
// e.g. was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE
if (logger.isInfoEnabled()) {
logger.info("Overriding user-defined bean definition for bean '" + beanName +
"' with a framework-generated bean definition: replacing [" +
existingDefinition + "] with [" + beanDefinition + "]");
}
}
/*
* 否则，表示允许，继续如果当前的beanDefinition不等于找到的此前的existingDefinition
* 打印日志，将会使用新beanDefinition覆盖旧的beanDefinition
*/
else if (!beanDefinition.equals(existingDefinition)) {
if (logger.isDebugEnabled()) {
logger.debug("Overriding bean definition for bean '" + beanName +
"' with a different definition: replacing [" + existingDefinition +
"] with [" + beanDefinition + "]");
}
}
/*
* 否则，表示允许，打印日志，将会使用同样（equals比较返回true）新的beanDefinition覆盖旧的beanDefinition
*/
else {
if (logger.isTraceEnabled()) {
logger.trace("Overriding bean definition for bean '" + beanName +
"' with an equivalent definition: replacing [" + existingDefinition +
"] with [" + beanDefinition + "]");
}
}
//使用新的beanDefinition覆盖旧的existingDefinition
this.beanDefinitionMap.put(beanName, beanDefinition);
}
/*2 如果没找到同名的BeanDefinition，这是正常情况*/
else {
/*如果已经有其他任何bean实例开始初始化了*/
if (hasBeanCreationStarted()) {
// Cannot modify startup-time collection elements anymore (for stable iteration)
//加锁防止并发操作集合
synchronized (this.beanDefinitionMap) {
//当前的beanName和beanDefinition存入beanDefinitionMap缓存
this.beanDefinitionMap.put(beanName, beanDefinition);
//当前的beanName存入beanDefinitionNames缓存
//重新生成一个list集合替换
List<String> updatedDefinitions = new ArrayList<>(this.beanDefinitionNames.size() + 1);
updatedDefinitions.addAll(this.beanDefinitionNames);
updatedDefinitions.add(beanName);
this.beanDefinitionNames = updatedDefinitions;
//当前的beanName从手动注册bean名称集合manualSingletonNames缓存中移除
//因为如果这里自动注册了beanName，那么需要从manualSingletonNames缓存中移除代表手动注册的单例beanName。
removeManualSingletonName(beanName);
}
}
/*否则，其他任何bean实例没有开始初始化*/
else {
//仍处于启动注册阶段，不加锁
//当前的beanName和beanDefinition存入beanDefinitionMap缓存
this.beanDefinitionMap.put(beanName, beanDefinition);
//当前的beanName存入beanDefinitionNames缓存
this.beanDefinitionNames.add(beanName);
//当前的beanName从手动注册bean名称集合manualSingletonNames缓存中移除
//因为如果这里自动注册了beanName，那么需要从manualSingletonNames缓存中移除代表手动注册的单例beanName。
removeManualSingletonName(beanName);
}
//仅仅在与初始化时才会使用到，很少使用
this.frozenBeanDefinitionNames = null;
}
/*
* 3 如果找到的旧的BeanDefinition不为null，或者单例bean实例的缓存singletonObjects已中包含给定beanName的实例
* 那么将当前beanName对应的在DefaultSingletonBeanRegistry中的实例缓存清除，需要重新生成实例
*/
if (existingDefinition != null || containsSingleton(beanName)) {
/*
* 将当前beanName对应的在DefaultSingletonBeanRegistry中的实例缓存清除
* 重置给定 beanName 的所有 bean 定义缓存，包括从它派生的 bean 的缓存(merge)。
* 以及重置以给定beanName为父类bean的子类Bean缓存。
*/
resetBeanDefinition(beanName);
}
/*
* 4 否则，如果此工厂的 bean 定义是否冻结，即不应进一步修改或后处理。
* 那么删除所有的按类型映射的任何缓存：allBeanNamesByType和singletonBeanNamesByType
* 在finishBeanFactoryInitialization方法中就会冻结 bean 定义，并且进行bean初始化操作
* 一般不会出现
*/
else if (isConfigurationFrozen()) {
clearByTypeCache();
}
}
1.1.2.1.1 resetBeanDefinition重置BeanDefinition缓存
如果此前已经注册了同名的BeanDefinition，或者单例bean实例的缓存singletonObjects中已经包含给定beanName的实例，那么需要重置BeanDefinition的相关缓存。
将DefaultSingletonBeanRegistry注册表中的当前beanName对应的实例缓存清除（destroySingleton），并且重置给定 beanName 的BeanDefinition缓存，包括已合并的 bean定义 缓存(mergedBeanDefinitions)，以及重置以给定beanName为父类bean的子类Bean。
/**
* DefaultSingletonBeanRegistry的属性
* 单例的 beanName 到 bean instance的缓存
*/
private final Map<String, Object> singletonObjects = new ConcurrentHashMap<>(256);
/**
* 父类DefaultSingletonBeanRegistry的方法
*
* 判断单例bean实例的缓存中是否已经包含给定beanName的实例
*
* @param beanName
* @return
*/
@Override
public boolean containsSingleton(String beanName) {
return this.singletonObjects.containsKey(beanName);
}
/**
* DefaultListableBeanFactory的方法
*
* 重置给定 bean 的所有 bean 定义缓存，包括从它派生的 bean 的缓存。
* 通知所有后处理器已重置指定的 bean 定义。
*
* @param beanName 要重置的 bean 的名称
*/
protected void resetBeanDefinition(String beanName) {
//删除给定beanName的mergedBeanDefinitions的缓存，这是已合并的bean定义缓存
clearMergedBeanDefinition(beanName);
//从单例缓存中删除相应的单例（如果有），这个方法之前讲过了
//实际上就是删除DefaultSingletonBeanRegistry中的关于单例bean实现的缓存
destroySingleton(beanName);
//通知所有后处理器已重置指定的 bean 定义。
for (BeanPostProcessor processor : getBeanPostProcessors()) {
if (processor instanceof MergedBeanDefinitionPostProcessor) {
((MergedBeanDefinitionPostProcessor) processor).resetBeanDefinition(beanName);
}
}
// 重置所有以当前beanName为父类bean的子类Bean
for (String bdName : this.beanDefinitionNames) {
if (!beanName.equals(bdName)) {
BeanDefinition bd = this.beanDefinitionMap.get(bdName);
//如果 bd 不为null，并且给定beanName等于bd的parentName属性
if (bd != null && beanName.equals(bd.getParentName())) {
//递归调用resetBeanDefinition重置BeanDefinition
resetBeanDefinition(bdName);
}
}
}
}
1.1.2.2 registerAlias注册别名映射
别名映射缓存aliasMap位于SimpleAliasRegistry注册表中，SimpleAliasRegistry是DefaultListableBeanFactory的父类。
aliasMap是一个map，key为一个alias别名，value就是beeanName，通过名称获取bean实例的时候就会从别名映射缓存中先获取真实的beanName，然后再获取beanName对应的bean实例。
/**
* SimpleAliasRegistry的属性
* 别名映射的map缓存 alias -> beanName
*/
private final Map<String, String> aliasMap = new ConcurrentHashMap<>(16);
/**
1. 父类SimpleAliasRegistry的方法
2.
3. 注册别名映射缓存
4. 5. @param name beanName
5. @param alias 一个别名
*/
@Override
public void registerAlias(String name, String alias) {
//必须不为null也不能是空字符串
Assert.hasText(name, "'name' must not be empty");
Assert.hasText(alias, "'alias' must not be empty");
//加锁
synchronized (this.aliasMap) {
/*如果beanName就等于alias别名，那么不算做别名*/
if (alias.equals(name)) {
//从缓存中移除指定alias为key的缓存
this.aliasMap.remove(alias);
if (logger.isDebugEnabled()) {
logger.debug("Alias definition '" + alias + "' ignored since it points to same name");
}
}
/*否则，注册别名映射缓存*/
else {
//尝试通过给定的别名从当aliasMap中获取以存在的beanName
String registeredName = this.aliasMap.get(alias);
//如果registeredName不为null，说明存在相同的别名
if (registeredName != null) {
//如果registeredName等于name，说明已经注册过该beanName的别名了，直接返回，无需重新注册
if (registeredName.equals(name)) {
// An existing alias - no need to re-register
return;
}
/*
* 如果不允许别名覆盖，则抛出异常，默认是允许的
* 就是使用的前面讲的customizeBeanFactory方法设置的allowBeanDefinitionOverriding属性来判断
*/
if (!allowAliasOverriding()) {
throw new IllegalStateException("Cannot define alias '" + alias + "' for name '" +
name + "': It is already registered for name '" + registeredName + "'.");
}
//输出日志，别名映射缓存将会覆盖
if (logger.isDebugEnabled()) {
logger.debug("Overriding alias '" + alias + "' definition for registered name '" +
registeredName + "' with new target name '" + name + "'");
}
}
/*
* 检查beanName和alias是否存在循环的name引用
* 比如a的别名是b，b的别名是a，那么抛出异常
*/
checkForAliasCircle(name, alias);
//没有循环的name引用，那么加入缓存
this.aliasMap.put(alias, name);
if (logger.isTraceEnabled()) {
logger.trace("Alias definition '" + alias + "' registered for name '" + name + "'");
}
}
}
}
1.2 importBeanDefinitionResource解析< import/>标签注册bean定义
Spring boot之前的web项目，为了将不同的配置分开方便管理，通常会有多个XML配置文件，然后再通过< import/>标签将其他配置文件引入到一个配置文件之中。
过程比较简单，那就是根据resource属性指定的路径解析成Resource资源，然后调用loadBeanDefinitions加载资源中的bean定义即可，loadBeanDefinitions方法我们在此前解析< bean/>标签的processBeanDefinition方法中已经讲过了。
注意点：
- 这里的路径既可以是绝对路径也可以是相对路径：
- 相对路径是根据当前< import/>标签所在文件路径将相对路径转为绝对路径然后再进行解析。
- 源码中，绝对路径还包括以"classpath*:"、"classpath:"开头的路径，因为"classpath:"开头的路径将会固定加载本项目resources目录下的配置文件，"classpath*:"开头的路径将会固定加载本项目resources目录下的配置文件以及引入的外部jar中配置文件。
- 这里的路径可以使用占位符：
- 默认是使用严格的模式解析占位符，没有默认值的无法解析的占位符则抛出IllegalArgumentException异常。占位符的属性一般都是我们单独设置在一个外部properties属性文件中的，然后通过< context:property-placeholder/>标签引入外部配置文件。
- 需要注意的是，< context:property-placeholder/>标签解析的属性并不会被注入到environment中，实际上是存放到PropertySourcesPlaceholderConfigurer对象中的，这个对象包括了environment环境变量的全部属性以及配置文件标签或者PropertySources加载进来的属性，实际上只会用来解析bean定义内的属性值和@Value、@Resource注解的值中的${…:…}占位符，而对于< import/>标签中以及其他标签的占位符的解析仅仅是从environment环境变量的属性集合中获取的，因此肯定由于获取外部配置不到而造成“Could not resolve placeholder的异常”。所以，我们可以在加载、解析标签之前将配置信息设置到environment环境变量中，比如System.setProperty和initPropertySources扩展点，对于web应用可以使用ApplicationContextInitializer配置容器启动加载的属性。关于properties属性文件的加载，后面会讲：Spring 5.x 源码(8)—PropertySourcesPlaceholderConfigurer占位符解析器源码深度解析。
/**
* DefaultBeanDefinitionDocumentReader的属性
*/
public static final String RESOURCE_ATTRIBUTE = "resource";
/**
* DefaultBeanDefinitionDocumentReader的方法
*
* 解析
protected void importBeanDefinitionResource(Element ele) {
//获取resource属性值
String location = ele.getAttribute(RESOURCE_ATTRIBUTE);
//如果没有为null或者""或者空白字符，那么将抛出异常
if (!StringUtils.hasText(location)) {
getReaderContext().error("Resource location must not be empty", ele);
return;
}
/*
* 使用环境变量对象的resolveRequiredPlaceholders方法来解析资源路径字符串，这说明资源路径也可以使用占位符${..:..}
* resolvePlaceholders方法将会使用严格模式，没有默认值的无法解析的占位符则抛出IllegalArgumentException异常
* 在setConfigLocations部分中我们就学过了该方法
*/
location = getReaderContext().getEnvironment().resolveRequiredPlaceholders(location);
Set<Resource> actualResources = new LinkedHashSet<>(4);
// 判断该路径是绝对的还是相对的 URI
boolean absoluteLocation = false;
try {
//如果是以"classpath*:"、"classpath:"开头或者可以据此创立一个URL对象，或者此URI是一个绝对路径，那么就是绝对URI
absoluteLocation = ResourcePatternUtils.isUrl(location) || ResourceUtils.toURI(location).isAbsolute();
} catch (URISyntaxException ex) {
// cannot convert to an URI, considering the location relative
// unless it is the well-known Spring prefix "classpath*:"
}
/*绝对路径*/
if (absoluteLocation) {
try {
//加载指定路径下面的配置文件
int importCount = getReaderContext().getReader().loadBeanDefinitions(location, actualResources);
if (logger.isTraceEnabled()) {
logger.trace("Imported " + importCount + " bean definitions from URL location [" + location + "]");
}
} catch (BeanDefinitionStoreException ex) {
getReaderContext().error(
"Failed to import bean definitions from URL location [" + location + "]", ele, ex);
}
}
/*相对路径*/
else {
// No URL -> considering resource location as relative to the current file.
try {
int importCount;
//尝试转换为单个资源
Resource relativeResource = getReaderContext().getResource().createRelative(location);
//此资源是否存在确定的一个文件，如果使用了Ant通配符，表示匹配多个资源文件，那么不会存在
if (relativeResource.exists()) {
//如果是确定的一个文件，那么解析该文件，这个loadBeanDefinitions方法在前面就讲过了
importCount = getReaderContext().getReader().loadBeanDefinitions(relativeResource);
actualResources.add(relativeResource);
} else {
//获取基础文件路径，也就是1.3 processAliasRegistration解析< alias/>标签注册别名映射
在XML中可以单独使用< alias/>标签来为bean定义设置别名。常见格式为：
<alias name="x" alias="y"/>
name表示bean定义中的id或者name属性值，alias表示设置的别名。
源码很简单，那就是获取name和alias属性，调用registerAlias方法，将beanName和alias注册到registry的缓存中。这个缓存实际上就是上下文容器内部的DefaultListableBeanFactory的父类SimpleAliasRegistry注册表实例中的aliasMap缓存。
我们在解析< bean/>标签的processBeanDefinition中就讲过了registerAlias方法，所以说，< bean/>标签中设置的别名和< alias/>标签设置的别名都是存放在同一个缓存aliasMap中的。再次提醒，一定不要出现循环别名映射，否则直接抛出异常，这个我们在前文也讲过了。
//--------DefaultBeanDefinitionDocumentReader的属性--------
public static final String NAME_ATTRIBUTE = "name";
public static final String ALIAS_ATTRIBUTE = "alias";
/**
* DefaultBeanDefinitionDocumentReader的方法
*
*
* 解析给定的
protected void processAliasRegistration(Element ele) {
//获取name和alias属性
String name = ele.getAttribute(NAME_ATTRIBUTE);
String alias = ele.getAttribute(ALIAS_ATTRIBUTE);
boolean valid = true;
//name不能为null、""、空白字符，否则抛出异常："Name must not be empty"
if (!StringUtils.hasText(name)) {
getReaderContext().error("Name must not be empty", ele);
valid = false;
}
//alias不能为null、""、空白字符，否则抛出异常："Alias must not be empty"
if (!StringUtils.hasText(alias)) {
getReaderContext().error("Alias must not be empty", ele);
valid = false;
}
if (valid) {
try {
/*
* 调用registerAlias方法，将beanName和aliases中的每一个别名注册到registry的缓存中。
* 这个缓存实际上就是上下文容器内部的DefaultListableBeanFactory的父类SimpleAliasRegistry注册表实例中的aliasMap缓存。
* 这个方法我们在解析2 parseCustomElement解析扩展标签
在parseBeanDefinitions(root, this.delegate)方法中，对于基本标签也就是默认命名空间（http://www.springframework.org/schema/beans）下的标签的解析使用的是parseDefaultElement方法，比如< import/>、< alias/>、< bean/>、< beans/>。
而对于我们引入的其他命名空间（比如http://www.springframework.org/schema/context、http://www.springframework.org/schema/aop）下的标签的解析则是采用的parseCustomElement方法，比如< mvc/>、< task/>、< context/>、< aop/>标签的解析。扩展标签的解析方法parseCustomElement直接位于BeanDefinitionParserDelegate解析器中。
现在我们就来看看自定义命名空间下的标签的解析方法parseCustomElement的源码，这个方法也非常重要。比如annotation-config、component-scan等等注解支持的标签都是由它解析的。
- 首先获取readerContext中的namespaceHandlerResolver，在前面的createReaderContext方法中已被初始化了，随后通过namespaceHandlerResolver的resolve方法根据namespaceUri获取对应的handler对象，比如AopNamespaceHandler、ContextNamespaceHandler等等。
- 调用handler对象的parse方法解析标签节点元素，并传递一个新建的解析上下文ParserContext对象，同样是返回一个BeanDefinition类型的对象，但是有可能直接返回null，比如后面讲的< context:component-scan/>标签的解析，最终就直接返回null。
/**
* DefaultBeanDefinitionDocumentReader的方法
*
* 解析自定义标签元素（在默认命名空间之外的标签）
*
* @param ele 要解析的标签元素
* @return 生成的bean定义
*/
@Nullable
public BeanDefinition parseCustomElement(Element ele) {
//调用另一个parseCustomElement方法，containingBd参数为null
return parseCustomElement(ele, null);
}
/**
1. DefaultBeanDefinitionDocumentReader的方法
2.
3. 解析自定义标签元素（在默认命名空间之外的标签）
4. 5. @param ele 要解析的标签元素
6. @param containingBd 外部包含bean的定义，可能为null
7. @return 生成的bean定义
*/
@Nullable
public BeanDefinition parseCustomElement(Element ele, @Nullable BeanDefinition containingBd) {
//获取节点的命名空间URI
//节点的命名空间URI为 http://www.springframework.org/schema/context
// 节点的命名空间URI为 http://www.springframework.org/schema/aop
String namespaceUri = getNamespaceURI(ele);
if (namespaceUri == null) {
return null;
}
/*
* 1 先获取readerContext中的namespaceHandlerResolver，在前面的createReaderContext方法中已被初始化了
* 随后通过namespaceHandlerResolver的resolve方法根据namespaceUri获取对应的handler对象
* 比如AopNamespaceHandler、ContextNamespaceHandler等等
*/
NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);
//如果没找到handler，那么返回并抛出异常
if (handler == null) {
error("Unable to locate Spring NamespaceHandler for XML schema namespace [" + namespaceUri + "]", ele);
return null;
}
/*
* 2 使用handler的parse方法解析节点元素，传递一个新建的解析上下文ParserContext对象
*/
return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));
}
2.1 resolve解析namespaceUri
readerContext的namespaceHandlerResolver属性的resolve方法用于解析namespaceUri返回对应的NamespaceHandler。
在前面的createReaderContext方法中就介绍过，namespaceHandlerResolver的默认实现就是DefaultNamespaceHandlerResolver。
- 首先会调用getHandlerMappings方法获取全部的处理器映射缓存集合handlerMappings：
- 这个缓存是在getHandlerMappings第一次调用时才会加载的（懒加载），将会加载本项目以及引入的外部jar包中的指定路径下的handler文件，默认位置就是"META-INF/spring.handlers"。
- 加载进来的数据被存入该缓存map中，默认是namespaceUri字符串以及对应的NamespaceHandler的全路径类名字符串键值对。后续调用该方法时将不会加载而是直接从缓存获取
- 随后根据给定的namespaceUri作为key从该缓存中查找对应的value。如果是第一次查找给定的namespaceUri，那么获取的value仅仅是一个NamespaceHandler的全路径类名字符串：
- 因此在第一次调用到某个namespaceUri的resolve方法时，需要将value表示的全路径类名字符串反射创建为一个NamespaceHandler对象，并通过init()方法进行初始化。
- 随后使用该对象作为新的value替换handlerMappings缓存集合中原来的全路径类名字符串，方便后续直接从缓存中获取handler对象而不需要再次解析。
/**
* DefaultNamespaceHandlerResolver的方法
*
* 懒加载handlerMappings,并且根据给定的namespaceUri解析NamespaceHandler
*
* @param namespaceUri 相关命名空间Uri
* @return 加载的NamespaceHandler，或者null
*/
@Override
@Nullable
public NamespaceHandler resolve(String namespaceUri) {
/*
* 1 获取全部handlerMappings集合
* handlerMappings在使用时才会被加载，懒加载，刚加载进来（第一次解析）时的样式为：
* http://www.springframework.org/schema/p -> org.springframework.beans.factory.xml.SimplePropertyNamespaceHandler
* key和value都是字符串，key为namespaceUri字符串，value就是对应的NamespaceHandler的全路径类名字符串
*/
Map<String, Object> handlerMappings = getHandlerMappings();
//然后根据给定的namespaceUri获取handlerOrClassName
Object handlerOrClassName = handlerMappings.get(namespaceUri);
/*如果没有获取到，直接返回null*/
if (handlerOrClassName == null) {
return null;
}
/*否则，如果获取的value已经被解析为NamespaceHandler对象，那么直接返回*/
else if (handlerOrClassName instanceof NamespaceHandler) {
return (NamespaceHandler) handlerOrClassName;
}
/*否则，第一次解析handlerOrClassName*/
else {
String className = (String) handlerOrClassName;
try {
//获取class对象
Class<?> handlerClass = ClassUtils.forName(className, this.classLoader);
if (!NamespaceHandler.class.isAssignableFrom(handlerClass)) {
throw new FatalBeanException("Class [" + className + "] for namespace [" + namespaceUri +
"] does not implement the [" + NamespaceHandler.class.getName() + "] interface");
}
//实例化NamespaceHandler对象
NamespaceHandler namespaceHandler = (NamespaceHandler) BeanUtils.instantiateClass(handlerClass);
/*
* 初始化NamespaceHandler对象，为当前命名空间下的不同标签节点指定不同的解析器
*/
namespaceHandler.init();
//重新存入该namespaceUri，将handlerOrClassName，即全路径类名，替换为namespaceHandler，即解析后的对象，避免后续再次解析
handlerMappings.put(namespaceUri, namespaceHandler);
//返回handler对象
return namespaceHandler;
} catch (ClassNotFoundException ex) {
throw new FatalBeanException("Could not find NamespaceHandler class [" + className +
"] for namespace [" + namespaceUri + "]", ex);
} catch (LinkageError err) {
throw new FatalBeanException("Unresolvable class definition for NamespaceHandler class [" +
className + "] for namespace [" + namespaceUri + "]", err);
}
}
}
2.1.1 getHandlerMappings获取NamespaceHandler映射
getHandlerMappings方法用于获取处理器映射缓存，第一次调用该方法时将会从指定路径懒加载指定的mapping映射文件到handlerMappings缓存集合中，后续再次调用该方法时将直接返回缓存的map。
/**
* DefaultNamespaceHandlerResolver的属性
*
* NamespaceHandler映射map集合
*/
@Nullable
private volatile Map<String, Object> handlerMappings;
/**
* DefaultNamespaceHandlerResolver的属性
*
* 要搜索的handlerMappings资源位置
* createReaderContext中创建DefaultNamespaceHandlerResolver的时候就被初始化为"META-INF/spring.handlers"
*/
private final String handlerMappingsLocation;
/**
* DefaultNamespaceHandlerResolver的方法
*
* 懒加载指定的NamespaceHandler映射
*/
private Map<String, Object> getHandlerMappings() {
//获取handlerMappings
Map<String, Object> handlerMappings = this.handlerMappings;
//如果为null，那么加载，不为null直接返回
if (handlerMappings == null) {
//加锁
synchronized (this) {
//再次判断
handlerMappings = this.handlerMappings;
if (handlerMappings == null) {
if (logger.isTraceEnabled()) {
logger.trace("Loading NamespaceHandler mappings from [" + this.handlerMappingsLocation + "]");
}
try {
//加载指定路径下的mapping文件为Properties集合，默认路径为"META-INF/spring.handlers"
Properties mappings =
PropertiesLoaderUtils.loadAllProperties(this.handlerMappingsLocation, this.classLoader);
if (logger.isTraceEnabled()) {
logger.trace("Loaded NamespaceHandler mappings: " + mappings);
}
//Properties转换为ConcurrentHashMap
handlerMappings = new ConcurrentHashMap<>(mappings.size());
CollectionUtils.mergePropertiesIntoMap(mappings, handlerMappings);
//赋给handlerMappings
this.handlerMappings = handlerMappings;
} catch (IOException ex) {
throw new IllegalStateException(
"Unable to load NamespaceHandler mappings from location [" + this.handlerMappingsLocation + "]", ex);
}
}
}
}
//返回handlerMappings
return handlerMappings;
}
2.1.2 init初始化标签节点解析/装饰器
NamespaceHandler的init方法，用于为当前为命名空间下的不同标签节点指定不同的解析/装饰器，即BeanDefinitionParser和BeanDefinitionDecorator。
比如Context命名空间下的ContextNamespaceHandler的init方法如下，我们可以看到常见的标签节点比如"component-scan"，该标签的解析器就是一个ComponentScanBeanDefinitionParser实例。
/**
* NamespaceHandler继承了NamespaceHandlerSupport，而NamespaceHandlerSupport实现了NamespaceHandler
*/
public class ContextNamespaceHandler extends NamespaceHandlerSupport {
/**
* 为context 命名空间下的不同标签节点指定不同的解析器
*/
@Override
public void init() {
registerBeanDefinitionParser("property-placeholder", new PropertyPlaceholderBeanDefinitionParser());
registerBeanDefinitionParser("property-override", new PropertyOverrideBeanDefinitionParser());
registerBeanDefinitionParser("annotation-config", new AnnotationConfigBeanDefinitionParser());
registerBeanDefinitionParser("component-scan", new ComponentScanBeanDefinitionParser());
registerBeanDefinitionParser("load-time-weaver", new LoadTimeWeaverBeanDefinitionParser());
registerBeanDefinitionParser("spring-configured", new SpringConfiguredBeanDefinitionParser());
registerBeanDefinitionParser("mbean-export", new MBeanExportBeanDefinitionParser());
registerBeanDefinitionParser("mbean-server", new MBeanServerBeanDefinitionParser());
}
}
2.1.2.1 registerBeanDefinitionParser、registerBeanDefinitionDecorator注册bean定义解析/装饰器
init()方法中的注册解析/装饰器的方法就是调用的registerBeanDefinitionParser/registerBeanDefinitionDecorator方法，这两个方法位于NamespaceHandlerSupport中，用于注册处理特定标签节点的BeanDefinitionParser和BeanDefinitionDecorator实现，注册的所有解析/装饰器保存在NamespaceHandlerSupport内部的parsers/decorators缓存map中。
NamespaceHandlerSupport直接实现了NamespaceHandler，而其他的自定义的NamespaceHandler则是继承的NamespaceHandlerSupport。
一个NamespaceHandler的具体实现仅仅是将解析某个命名空间所需要的全部解析器和装饰器统一调用registerBeanDefinitionParser和registerBeanDefinitionDecorator方法注册到NamespaceHandlerSupport中而已，比如ContextNamespaceHandler。
NamespaceHandlerSupport是用于实现自定义NamespaceHandler的支持类，内部的parsers映射缓存了所有注册的解析器，decorators映射缓存了所有注册的装饰器，格式为：标签名字符串->解析器/装饰器实例。
真正的的单个Node节点的解析和装饰则分别是通过BeanDefinitionParser解析器和BeanDefinitionDecorator装饰器这两个策略接口的实现来完成的。
//---------NamespaceHandlerSupport的相关属性-----------
/**
* value存储BeanDefinitionParser的实现，对应的所处理的Element标签元素节点的本地名称作为key
*/
private final Map<String, BeanDefinitionParser> parsers = new HashMap<>();
/**
* value存储BeanDefinitionDecorator的实现，对应的所处理的Element标签元素节点的本地名称作为key
*/
private final Map<String, BeanDefinitionDecorator> decorators = new HashMap<>();
/**
* NamespaceHandlerSupport的方法
*
* 子类可以调用它来注册提供的BeanDefinitionParser，用来以处理指定的Element标签元素节点。元素名称是本地（非命名空间限定）名称。
*/
protected final void registerBeanDefinitionParser(String elementName, BeanDefinitionParser parser) {
this.parsers.put(elementName, parser);
}
/**
* NamespaceHandlerSupport的方法
*
* 子类可以调用它来注册提供的BeanDefinitionDecorator来处理指定的元素。元素名称是本地（非命名空间限定）名称。
*/
protected final void registerBeanDefinitionDecorator(String elementName, BeanDefinitionDecorator dec) {
this.decorators.put(elementName, dec);
}
2.2 parse解析自定义标签节点
在parseCustomElement方法的最后是调用具体handler实现的parse方法来解析对应的标签节点元素。实际上是调用的父类NamespaceHandlerSupport实现的逻辑，而NamespaceHandlerSupport的parse方法同样是通过委派给此前通过init方法的注册到parsers缓存中的BeanDefinitionParser来解析对应的Element标签元素的。
/**
* 具体handler实现的父类NamespaceHandlerSupport的方法
*
* 通过委派给的注册的BeanDefinitionParser来解析对应的Element标签元素
*/
@Override
@Nullable
public BeanDefinition parse(Element element, ParserContext parserContext) {
//查找该element标签元素对应的BeanDefinitionParser解析器parser
BeanDefinitionParser parser = findParserForElement(element, parserContext);
//如果parser不为null，那么就使用解析器的parse方法来解析该标签，返回解析后的BeanDefinition
return (parser != null ? parser.parse(element, parserContext) : null);
}
/**
* NamespaceHandlerSupport的方法
*
* 使用提供的Element的本地名称从缓存parsers中查找BeanDefinitionParser
*/
@Nullable
private BeanDefinitionParser findParserForElement(Element element, ParserContext parserContext) {
//获取element的本地名称
String localName = parserContext.getDelegate().getLocalName(element);
//从parsers缓存中查找BeanDefinitionParser
BeanDefinitionParser parser = this.parsers.get(localName);
if (parser == null) {
parserContext.getReaderContext().fatal(
"Cannot locate BeanDefinitionParser for element [" + localName + "]", element);
}
//返回
return parser;
}
3 小结
这篇文章的内容是接着上一篇讲解obtainFreshBeanFactory方法的后半部分，我们对本次学习的重点做一个简单的总结，其中还有很多细节没有写出来，需要通看文章才能找到：
parseDefaultElement解析默认标签的方法，用于解析< beans/>根标签下的默认命名空间（xmlns=“http://www.springframework.org/schema/beans”）下的标签，就是四个标签：< import/>、< alias/>、< bean/>、< beans/>：- 我们主要学习了
parseBeanDefinitionElement方法，也就是< bean/>标签的解析，将< bean />标签解析成为一个获取BeanDefinitionHolder对象，这个holder对象封装了“bean定义”——BeanDefinition、bean的名称——beanName以及bean别名数组——aliasesArray。还涉及到基于XML的beanName的生成规则、同名bean定义覆盖等知识点。- parseBeanDefinitionElement方法中还调用了
registerBeanDefinition方法，对解析出来的BeanDefinitionHolder进行注册，主要是注册到beanDefinitionMap、beanDefinitionNames、aliasMap这三个缓存中，这其中又涉及到别名映射的解析。
- parseBeanDefinitionElement方法中还调用了
- 我们主要学习了
parseCustomElement解析扩展标签的方法，用于解析我们引入的其他命名空间（比如http://www.springframework.org/schema/context、http://www.springframework.org/schema/aop）下的标签，比如< mvc/>、< task/>、< context/>、< aop/>……。- 我们并没有介绍某个扩展标签的具体解析，因为不同的标签有不同的解析方法，下一篇文章，我们将会介绍< context:component-scan/>标签的解析源码！
相关文章：
https://spring.io/
Spring 5.x 学习
Spring 5.x 源码
如有需要交流，或者文章有误，请直接留言。另外希望点赞、收藏、关注，我将不间断更新各种Java学习博客！