回顾
前面我们也已经看到了，Spring的注册Bean的大概流程
- 选择XML的校验模式（有DTO选DTO，没有就为XSD）
- 使用DefaultLoadDocument解析Dom对象
- 注册Bean
- 解析Profiles属性（判断当前激活环境是否符合Profiles）
- 解析Bean，有两种解析方式（bean标签，bean注解）
那么下面，bean标签里面包含了所有内容，所以，我们就来看Bean标签是如何解析的
Bean标签的解析及注册
解析Bean的方法在parseBeanDefinitions里面
可以看到，对于Bean的解析和注册，共有两种方式
- parseDefaultElement：配置文件里面Bean标签的解析
- parseCustomElement：@Bean注解的解析，即基于注解的解析
下面就来看配置文件是怎样进行解析的
parseDefaultElement方法
下面就直接来看看源码
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);
}
}
对于nodeNameEquals方法，可以看到传进去的，参数都是Element对象和标签名称
而delegate.nodeNameEquals是判断传进来的标签的！下面就来看看他是如何判断的
因为对于默认的命名空间来说，其仅仅支持这4种标签（前面使用parseDefaultElement方法都是先判断命名空间的）
nodeNameEquals方法（判断当前的标签是什么标签）
下面就来看看是怎么判断的
判断方法很简单
- 判断标签的名字是不是对应名字（前面已经对标签解析了，可以取到标签的名字）
- 判断标签的localName是不是对应名字
- 注意，这判断是交给delegate去做的，也就是BeanDefinitionParserDelegate
- 从这里就可以看到delegate做了两件事
- 前面提到的，判断是否是默认的命名空间
- 判断标签是哪种类型
解析Bean标签
从上面解析过程可以看到，对于默认的命名空间，支持的标签解析有以下
- import标签
- alias标签
- bean标签
- beans标签
其中对于bean标签，解析是最难的，所以把bean标签解析看懂了，其他什么的也会很快理解
下面直接看bean解析的代码
processBeanDefinition方法
这个方法就是解析Bean标签的
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
//获取BeanDefinitionHolder对象
//这个对象其实已经包含了标签里面的各种属性，id、class、name、alias那些
//也就是说，第一步是让BeanDefinitionDelegate去解析Bean标签，并且获取里面的那些属性
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
//如果获取的属性，进行下面处理
if (bdHolder != null) {
//上面已经将节点解析完了，但是子标签还没进行解析
//所以下面的那一步就是解析子标签，同样去获取id、name的那些属性（bean中的bean）
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
try {
// Register the final decorated instance.
// 对标签、子标签都解析完了之后
// 将解析的BeanDefinitionHolder交给BeanDefinitionReaderUtils去进行注册
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));
}
//获取不到BeanDefinitionHolder，什么都不做
}
其实主要就三个步骤
- BeanDefinitionDelegate解析节点，包括子节点，解析出BeanDefinitionHolder对象
- BeanDefinitionReaderUtils，使用解析出来的BeanDefinitionHolder来进行注册Bean
- 注册完后，开始通知相关的监听器，代表这个Bean已经加载完了
解析BeanDefinition
BeanDefinition其实就是代表一个Bean（下面是官方文档的说明）
解析BeanDefinition是由BeanDefinitionDelegate负责的，具体的方法是parseBeanDefinitionElement
看源码前，先看下官方文档对于bean的命名定义
主要源码如下
/**
* Parses the supplied {@code <bean>} element. May return {@code null}
* if there were errors during parse. Errors are reported to the
* {@link org.springframework.beans.factory.parsing.ProblemReporter}.
*/
@Nullable
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
// 获取当前bean标签的id属性
String id = ele.getAttribute(ID_ATTRIBUTE);
// 获取当前bean标签的name属性
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
// 对别名进行处理，其实这里并不是指alias标签，因为bean没有alias属性
// 但是一个bean可以有多个名字，用逗号或者分号或空格间隔！
// 但id只能有一个
// 所以，下面对name的操作主要还是针对aliases
//并且存储在arrayList中，arrayList已经够用了！不需要考虑扩容
List<String> aliases = new ArrayList<>();
if (StringUtils.hasLength(nameAttr)) {
String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
aliases.addAll(Arrays.asList(nameArr));
}
//下面还是继续对id和name属性的处理
String beanName = id;
//先判断有没有ID！
//id是必须要有的
//如果没有ID且有name
//那么第一个name就会设置为ID
if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
//进入到这个代码块就代表没有ID，但有name
//让第一个name作为ID属性
//同时，由于第一个name作为了ID属性，它也不在是name属性了
//会从alias数组里面移除
beanName = aliases.remove(0);
//来点日志提示没有ID属性，并且让第一个name为ID
if (logger.isTraceEnabled()) {
logger.trace("No XML 'id' specified - using '" + beanName +
"' as bean name and " + aliases + " as aliases");
}
}
//如果提供要解析的Bean为null
//这里可以理解，如果提供解析的bean不为null
//就根据提供解析的bean来解析
//如果为null，就主要就是根据element去解析
if (containingBean == null) {
//检查bean名称是否正确
//具体来说是验证指定的bean名称是否未使用
checkNameUniqueness(beanName, aliases, ele);
}
//对其他标签的解析
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
if (beanDefinition != null) {
//如果此时还没有beanName，使用默认规则为该bean去生成beanName
if (!StringUtils.hasText(beanName)) {
try {
//如果有提供解析的bean
if (containingBean != null) {
//使用generateBeanName去生成
//注意这里不会提供name属性
beanName = BeanDefinitionReaderUtils.generateBeanName(
beanDefinition, this.readerContext.getRegistry(), true);
}
//如果根据element去注册bean，那代表就是根节点！
//根节点一定有id和name属性
//下面会对根节点去生成id和name属性
else {
//否则，用readContext去生成id
beanName = this.readerContext.generateBeanName(beanDefinition);
// 并且还会默认bean的class名称作为name属性
//因为beanName还为空的话，肯定是name一个都没有提供的
String beanClassName = beanDefinition.getBeanClassName();
if (beanClassName != null &&
beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&
!this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {
//将以class生成的name保存在aliases中
aliases.add(beanClassName);
}
}
if (logger.isTraceEnabled()) {
logger.trace("Neither XML 'id' nor 'name' specified - " +
"using generated bean name [" + beanName + "]");
}
}
catch (Exception ex) {
error(ex.getMessage(), ele);
return null;
}
}
//将List转化为数组
String[] aliasesArray = StringUtils.toStringArray(aliases);
//将解析出来的信息又封装在BeanDefinitionHolder中
return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
}
//如果对没有其他标签
//直接返回null，不解析了
return null;
}
所以，我们可以将bean的解析过程分为下面几步
-
处理id和name属性，进行解析和提取
-
进一步去解析bean中的其他属性，并且统一封装在AbstractBeanDefinition中，这里还不知道具体在哪个类
-
此时bean已经大体处理完了，不过此时bean可能没有id，所以要保证id，所以要提供机制去生成
- 假如解析的bean是前面提供的，那么BeanDefinitionReaderUtils.generateBeanName方法生成
- 假如解析的bean不是前面提供的，具体根据element去生成，那就由readerContext去生成
- 并且还会根据class去生成name！
-
最后，将获取到的bean信息封装到新的BeanDefinitionHolder对象！
在这里，我们又认识了一个对象，当bean解析完后会生成beanDefinition对象，但是里面没有id和name属性，这些都是单独处理的，所以其实一个完整的bean，是一个beanDefinitionHolder对象
进一步解析bean中的其他属性
下面就来看看spring是怎样做进一步解析bean的其他标签的！
/**
* Parse the bean definition itself, without regard to name or aliases. May return
* {@code null} if problems occurred during the parsing of the bean definition.
*/
@Nullable
public AbstractBeanDefinition parseBeanDefinitionElement(
Element ele, String beanName, @Nullable BeanDefinition containingBean) {
//这一步是用来在解析过程中跟踪逻辑位置的
this.parseState.push(new BeanEntry(beanName));
//获取class属性
String className = null;
if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
}
//获取parent属性
String parent = null;
if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
parent = ele.getAttribute(PARENT_ATTRIBUTE);
}
//下面就是解析其他属性的
try {
//创造BeanDefinition实体（也就是bean承载）
AbstractBeanDefinition bd = createBeanDefinition(className, parent);
//硬编码解析默认bean的各种属性
parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
//下面进行一些bean的属性进行加工解析
//解析元数据
parseMetaElements(ele, bd);
//解析lookup-method属性
parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
//解析replaced-method属性
parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
//解析构造函数的参数
parseConstructorArgElements(ele, bd);
//解析property子元素
parsePropertyElements(ele, bd);
//解析qualified子元素
parseQualifierElements(ele, bd);
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;
}
步骤如下
-
开启追踪过程
-
创建beanDefinition实体去承载Bean
-
硬编码去解析默认bean的各种属性
-
对一些特殊属性进行二次加工
- 元数据
- property子元素
- qualifier子元素
- 构造函数的参数
- lookup-method属性
- replaced-method属性
-
关闭追踪
431
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
