本文主要基于 Spring 5.0.6.RELEASE
摘要: 原创出处 http://cmsblogs.com/?p=2731 「小明哥」,谢谢!
作为「小明哥」的忠实读者,「老艿艿」略作修改,记录在理解过程中,参考的资料。
import
标签解析完毕了,我们一起来看看 Spring 中最复杂也是最重要的标签 bean
标签的解析过程。
1. processBeanDefinition
在方法 #parseDefaultElement(...)
方法中,如果遇到标签为 bean
时,则调用 #processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate)
方法,进行 bean
标签的解析。代码如下:
// DefaultBeanDefinitionDocumentReader.java |
整个过程分为四个步骤:
- 调用
BeanDefinitionParserDelegate#parseBeanDefinitionElement(Element ele, BeanDefinitionParserDelegate delegate)
方法,进行元素解析。- 如果解析失败,则返回
null
,错误由 ProblemReporter 处理。 - 如果解析成功,则返回 BeanDefinitionHolder 实例
bdHolder
。BeanDefinitionHolder 为持有name
和alias
的 BeanDefinition。 - 详细解析,见 「2. parseBeanDefinitionElement」 。
- 如果解析失败,则返回
- 若实例
bdHolder
不为空,则调用BeanDefinitionParserDelegate#decorateBeanDefinitionIfRequired(Element ele, BeanDefinitionHolder bdHolder)
方法,进行自定义标签处理。 - 解析完成后,则调用
BeanDefinitionReaderUtils#registerBeanDefinition(BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
方法,对bdHolder
进行 BeanDefinition 的注册。 - 发出响应事件,通知相关的监听器,完成 Bean 标签解析。
2. parseBeanDefinitionElement
BeanDefinitionParserDelegate#parseBeanDefinitionElement(Element ele, BeanDefinitionParserDelegate delegate)
方法,进行 <bean>
元素解析。代码如下:
// BeanDefinitionParserDelegate.java |
这个方法还没有对 bean
标签进行解析,只是在解析动作之前做了一些功能架构,主要的工作有:
<1>
处,解析id
、name
属性,确定aliases
集合<2>
处,检测beanName
是否唯一。代码如下:/**
* 已使用 Bean 名字的集合
*
* Stores all used bean names so we can enforce uniqueness on a per
* beans-element basis. Duplicate bean ids/names may not exist within the
* same level of beans element nesting, but may be duplicated across levels.
*/
private final Set<String> usedNames = new HashSet<>();
/**
* Validate that the specified bean name and aliases have not been used already
* within the current level of beans element nesting.
*/
protected void checkNameUniqueness(String beanName, List<String> aliases, Element beanElement) {
// 寻找是否 beanName 已经使用
String foundName = null;
if (StringUtils.hasText(beanName) && this.usedNames.contains(beanName)) {
foundName = beanName;
}
if (foundName == null) {
foundName = CollectionUtils.findFirstMatch(this.usedNames, aliases);
}
// 若已使用,使用 problemReporter 提示错误
if (foundName != null) {
error("Bean name '" + foundName + "' is already used in this <beans> element", beanElement);
}
// 添加到 usedNames 集合
this.usedNames.add(beanName);
this.usedNames.addAll(aliases);
}这里有必要说下
beanName
的命名规则:<3.1>
处,如果id
不为空,则beanName = id
。<3.2>
处,如果id
为空,但是aliases
不空,则beanName
为aliases
的第一个元素<3.3>
处,如果两者都为空,则根据默认规则来设置 beanName 。因为默认规则不是本文的重点,所以暂时省略。感兴趣的胖友,自己研究下哈。
<4>
处,调用#parseBeanDefinitionElement(Element ele, String beanName, BeanDefinition containingBean)
方法,对属性进行解析并封装成 AbstractBeanDefinition 实例beanDefinition
。详细解析,见 「2.1 parseBeanDefinitionElement」 。<5>
处,根据所获取的信息(beanName
、aliases
、beanDefinition
)构造 BeanDefinitionHolder 实例对象并返回。其中,BeanDefinitionHolder 的简化代码如下:/**
* BeanDefinition 对象
*/
private final BeanDefinition beanDefinition;
/**
* Bean 名字
*/
private final String beanName;
/**
* 别名集合
*/
private final String[] aliases;
TODO 芋艿,需要进一步确认,未来参考下 《Spring专题之IOC源码分析》 ,进行细化。
2.1 parseBeanDefinitionElement
#parseBeanDefinitionElement(Element ele, String beanName, BeanDefinition containingBean)
方法,对属性进行解析并封装成 AbstractBeanDefinition 实例,代码如下:
/** |
到这里,bean
标签的所有属性我们都可以看到其解析的过程,也就说到这里我们已经解析一个基本可用的 BeanDefinition 。
2.2 createBeanDefinition
#createBeanDefinition(String className, String parentName)
方法,创建 AbstractBeanDefinition 对象。代码如下:
/** |
3. 小节
由于解析过程 bean
标签的属性较为漫长,篇幅较大,为了更好的观看体验,将这篇博文进行拆分。
下篇博客主要介绍 BeanDefinition ,以及解析默认 bean
标签的各种属性的过程,即 #parseBeanDefinitionAttributes(Element ele, String beanName, BeanDefinition containingBean, AbstractBeanDefinition bd)
方法。