Spring XML配置解析机制

XML的解析机制

通过AbstractXmlApplicationContext类可以看到,XML解析是由XmlBeanDefinitionReader类实现的:

我们先看一看spring的xml配置文件的结构:

Spring的xml配置文件遵循了xml规范,我们常用的component-scan或者aop config分别在context和aop这两个命名空间中,beans是根标签,beans的每一个子标签对应一个BeanDefinition对象。

我们再看看Spring在xml解析的思路,打开spring-context包或者spring-aop包,以context包为例,可以在jar包的META-INF目录下看到以下文件:

打开其中的spring.handlers文件,可以看到以下内容:

文件内容是命名空间与某个NamespaceHandler接口的实现类的映射关系,aop包中的spring.handlers文件的内容也类似:

再打开spring.schemas文件,可以看到类似如下内容:

其中三个方法:

1. init方法表示初始化;

2. parse方法表示解析一个BeanDefinition对象并注册到BeanDefinitionRegistry接口中,BeanDefinitionRegistry接口和BeanDefinition的意义前文描述过,这里不再重述;

3. decorator方法表示解析一个xml标签,并对Bean定义做装饰,所谓的装饰即对bean定义的子标签做处理;

打开一个NamespaceHandler类,比如AopNamespaceHandler,可以看到其init方法中在注册BeanDefinitionParser和BeanDefinitionDecorator对象:

对应NamespaceHandler接口中的方法,registerBeanDefinitionParser方法则是注册用于将该命名空间下的某个标签解析成BeanDefinition对象,registerBeanDefinitionDecoreator方法则是用于解析某个Bean配置的该命名空间下的子标签。打开某个BeanDefinitionParser的实现,即可看到解析bean定义(BeanDefinition)。

回到XmlBeanDefinitionReader类,此类中除了读取xml文件的内容外,有一个初始化相关的重要属性namespaceHandlerResolver,此属性的接口类型如下:

接口声明非常简单,即通过namespace的url获取NamespaceHandler,从此接口的定义来看正是使用spring.handlers文件中的内容并为bean定义的解析提供服务。从XmlBeanDefinitionReader接口中可以看到此属性的初始化:

默认使用的是DefaultNamespaceHandlerResolver类,此类的实现比较简单,加载spring.handlers文件并初始化NamespaceHandler。

XML配置的扩展

前文描述了spring的xml配置解析的思路,是通过在jar包的META-INF/spring.handlers文件中的NamespaceHandler来解析bean的,基于spring的xml解析机制,我们可以自定义实现xmlns以及相关的BeanDefinitionParser和BeanDefinitionDecorator。

假设需要实现以下xml配置功能:

这个配置的意思是,/META-INF/app.properties文件中取变量(用${xxx}表示),如果${env}的值等于local,则配置TestBean,如果存在${appName}则设置appName属性,如果不存在${run_mode}则设置runMode属性值为0。

配置文件中新的标签有两种使用方式:

1. 作为beans的第一级子标签,这种使用方式需要BeanDefinitionParser来处理

2. 作为bean标签的子标签,作用于property属性之上,这种使用方式是对bean的装饰过程,需要BeanDefinitionDecorator来处理

从这份配置内容可以看出引入了新的名叫ctl的xmlns,ctl是自定义的命名空间,按照前文所述的spring xml解析机制,那么我们为ctl命名空间编写xsd文件以及spring.handlers和spring.schemas文件:

编写CtlNamespaceHandler类:

以if标签为例,IfBeanDefinitionParser类的实现如下(省略细节,后面有详细代码链接):

详细代码见github: https://github.com/gaohanghbut/springcfg

你可能感兴趣的:(Spring XML配置解析机制)