从上一篇笔记可以看出,在容器注册 bean
信息的时候,做了很多解析操作,而 xml
文件中包含了很多标签、属性,例如 bean
、 import
标签, meta
、look-up
和 replace
等子元素属性。
上一篇主要介绍 Spring
容器的基础结构,没有细说这些标签是如何解析的。
所以本篇是来进行补坑的,介绍这些标签在代码中是如何识别和解析的~
本篇笔记的结构大致如下:
•介绍概念•展示 demo
代码,如何使用•结合源码分析•聊聊天和思考
再次说下,下载项目看完整注释,跟着源码一起分析~
码云 Gitee 地址: https://gitee.com/vip-augus/spring-analysis-note.git
Github 地址: https://github.com/Vip-Augus/spring-analysis-note
在 Spring
中,标签有两种,默认和自定义:
默认标签 这是我们最常使用到的标签类型了,像我们一开始写的 <bean id="book" class="domain.SimpleBook"/>
,它属于默认标签,除了这个标签外,还有其它四种标签(import
、 alias
、 bean
、 beans
)
•
自定义标签 自定义标签的用途,是为了给系统提供可配置化支持,例如事务标签 <tx:annotation-driven />
,它是 Spring
的自定义标签,通过继承 NamespaceHandler
来完成自定义命名空间的解析。
先看源码是如何区分这两者:
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) { if (delegate.isDefaultNamespace(root)) { // 注释 1.12 遍历 doc 中的节点列表 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)) { // 注释 1.13 识别出默认标签的 bean 注册 // 根据元素名称,调用不同的加载方法,注册 bean parseDefaultElement(ele, delegate); } else { delegate.parseCustomElement(ele); } } } } else { delegate.parseCustomElement(root); } }
可以看到,在代码中,关键方法是 delegate.isDefaultNamespace(ele)
进行判断,识别扫描到的元素属于哪种标签。
找到命名空间 NamespaceURI
变量,如果是 http://www.springframework.org/schema/beans
,表示它是默认标签,然后进行默认标签的元素解析,否者使用自定义标签解析。
本篇笔记主要记录的是默认标签的解析,下来开始正式介绍~
Bean 标签解析入口
定位到上面第三个方法 processBeanDefinition(ele, delegate)
:
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) { // 注释 1.15 解析 bean 名称的元素 BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele); if (bdHolder != null) { bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder); try { // Register the final decorated instance. (注释 1.16 注册最后修饰后的实例) 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)); } }
上一篇笔记只是简单描述这个方法的功能:将 xml
中配置的属性对应到 document
对象中,然后进行注册,下面来完整描述这个方法的处理流程:
•创建实例 bdHolder
:首先委托 BeanDefinitionParserDelegate
类的 parseBeanDefinitionElement
方法进行元素解析,经过解析后,bdHolder
实例已经包含刚才我们在配置文件中设定的各种属性,例如 class
、 id
、 name
、 alias
等属性。•对实例 bdHolder
进行装饰:在这个步骤中,其实是扫描默认标签下的自定义标签,对这些自定义标签进行元素解析,设定自定义属性。•注册 bdHolder
信息:解析完成了,需要往容器的 beanDefinitionMap
注册表注册 bean
信息,注册操作委托给了 BeanDefinitionReaderUtils.registerBeanDefinition
,通过工具类完成信息注册。•发送通知事件:通知相关监听器,表示这个 bean
已经加载完成
看到这里,同学们应该能看出,Spring
源码的接口和方法设计都很简洁,上层接口描述了该方法要做的事情,然后分解成多个小方法,在小方法中进行逻辑处理,方法可以被复用。
所以看源码除了能了解到框架的实现逻辑,更好的去使用和定位问题,还能够学习到大佬们写代码时的设计模式,融入自己的工作或者学习中~
创建 GenericBeanDefinition
关于 GenericBeanDefinition
的继承体系上一篇已经讲过了,所以这里再简单解释一下这个方法的用途:
createBeanDefinition(className, parent);
从方法名字就能看出,它的用途是创建一个 beanDefinition
,用于承载属性的实例。
在最后一步实例化 GenericBeanDefinition
时,还会判断类加载器是非存在。如果存在的话,使用类加载器所在的 jvm
来加载类对象,否则只是简单记录一下 className
。
解析 meta 属性
先讲下 meta
属性的使用(汗,在没了解前,基本没使用该属性=-=)
<bean id="book" class="domain.SimpleBook"> <!-- 元标签 --> <meta key="test_key" value="test_value"/> </bean>
这个元属性不会体现在对象的属性中,而是一个额外的声明,在 parseMetaElements(ele, bd);
方法中进行获取,具体实现是 element
对象的 getAttribute(key)
,将设定的元属性放入 BeanMetadataAttributeAccessor
对象中
因为代码比较简单,所以通过图片进行说明:
最终属性值是以 key-value
形式保存在链表中 Map<String, Object> attributes
,之后使用只需要根据 key
值就能获取到 value
。想到之后在代码设计上,为了扩展性,也可以进行 key-value
形式存储和使用。