Spring源码系列(4)- spring XML文件文件的解析

  • 前言
  • XmIBeanDefinitionReader
  • 开始真正解析
  • 封装BeanDefinition


前言

本章重点将上一篇留下的尾巴说完,本章就一个重点,this.reader.loadBeanDefinitions这个方法, 把这个搞明白就可以了。
每篇只讲一块内容,这样便于大家理解,也不会迷糊。

XmIBeanDefinitionReader

话不多说,先来这段代码。

this.reader.loadBeanDefinitions(resource);

this.reader,我们先来看看reader是何物。
正常情况下,大家在实现解析xml的时候,会怎么做呢?可能大部分人直接上来就是定义Document,直接去解析了。
但是Spring没有这么做,他做了很多扩展,这也是它优秀的一面,比如说这个reader,

ctrl+鼠标左键点击reader,会看到如下代码:

spring boot 项目解析格式不固定的xml文件 spring如何解析xml_封装


XmIBeanDefinitionReader这个类是Spring专为读取xml、环境的配置等设计,它继承了AbstractBeanDefinitionReader,此类最终又实现了BeanDefinitionReader, EnvironmentCapable这两个接口。接下来我们进入loadBeanDefinitions方法。

spring boot 项目解析格式不固定的xml文件 spring如何解析xml_编程语言_02


首先可以看到,这块主要工作是带编码的EncodedResource类的实例化,这里不重要且大家点进去也能看得懂,就忽略了,然后接着往下走。

spring boot 项目解析格式不固定的xml文件 spring如何解析xml_spring_03


最开头的代码不是很重要,大家不需要关注,主要是从InputStream这行开始。

简单说一下流程:

1、获取输入流

2、获取InputSource

3、进入doLoadBeanDefinitions方法。

这块还是比较简单的,重点说一下InputSource,这个大家注意一下,这个类不是Spring的,是jdk类库自带的sax包下解析xml用的。

接下来主要看doLoadBeanDefinitions这个方法。
顺便提一嘴,spring有一个特点,前奏很多,看半天也不定能进入主方法,一般都是do开头的才是真正的进入了主方法,此处也同样。

开始真正解析

spring boot 项目解析格式不固定的xml文件 spring如何解析xml_xml_04


除开catch之外,其余代码很少,也很好理解。我的截图上边都有注释,这里就不在赘述,我们主要看registerBeanDefinitions这个方法。

封装BeanDefinition

registerBeanDefinitions这个方法主要是用来注册BeanDefinition的,下边我们看看它是如何实现的。

spring boot 项目解析格式不固定的xml文件 spring如何解析xml_xml_05


根据注释可以看到,第一行主要是创建了BeanDefinitionDocumentReader,通过委托这个类,来实现xml解析的过程。这里用到了设计模式中的委托模式,委托模式不了解的,大家可以查阅相关资料了解下。。spring中很多地方都用了委托模式。我们重点看documentReader.registerBeanDefinitions这块。

点进去,进入DefaultBeanDefinitionDocumentReader这个默认实现类。

spring boot 项目解析格式不固定的xml文件 spring如何解析xml_spring_06


同样,关键的在doRegisterBeanDefinitions这里。

spring boot 项目解析格式不固定的xml文件 spring如何解析xml_java_07


parseBeanDefinitions这行之前的,都是用来验证xml是否是spring可识别的,具体的xml验证方法主要有xsd和DTD,这块不清楚的可查阅资料,不是本系列的重点内容。

其中在最后可以看到,postProcessXml 这个方法,大家点击进去后,会发现是一个空实现,这就是spring的魅力之处,大家不要觉得空实现就没有用,在后续的扩展中,或者企业开发的时候,有这块的需求,直接就可以实现这个方法。

下边我们真正的进入解析阶段。

spring boot 项目解析格式不固定的xml文件 spring如何解析xml_封装_08

我们重点查看默认标签的解析,自定义标签类似。

spring boot 项目解析格式不固定的xml文件 spring如何解析xml_封装_09


注释很清晰了哈。最开头的是解析import标签和alias标签,这两个相信大家很少用吧。这块不是很重要,建议不看。主要看bean的解析。

进入processBeanDefinition方法

spring boot 项目解析格式不固定的xml文件 spring如何解析xml_封装_10


我们先重点看第一行的方法parseBeanDefinitionElement,这块是通过document解析封装成BeanDefinition的过程。

spring boot 项目解析格式不固定的xml文件 spring如何解析xml_java_11


这块没什么说的,往下看。

spring boot 项目解析格式不固定的xml文件 spring如何解析xml_java_12


这个方法写的并不好,方法写的太长,给阅读者带来一些不便。

不过重点来了,parseBeanDefinitionElement大家看这个,这个就是期待已久的解析过程了,最后封装成AbstractBeanDefinition这个类,这个类也是BeanDefinition的抽象类实现。

spring boot 项目解析格式不固定的xml文件 spring如何解析xml_封装_13


这块的代码无需多说,就是常见的document解析,然后进行封装。通过注释应该很明了的明白。现在回到

spring boot 项目解析格式不固定的xml文件 spring如何解析xml_封装_14


下一篇,我们将会以这红框开始讲起,主要讲解BeanDefinition对象的注册实现。

我们先来看最后一行,

getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));

这里是通过监听器解析及注册完成,这里spring并没有做任何的业务处理,这里主要是为了扩展,比如说需要对注册BeanDefinition事件进行监听的时候,就可以通过注册监听器的方式,并将自己的处理逻辑写到这里。

今天就到这儿。有什么建议,大家随时留言。