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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,193评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,306评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,130评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,110评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,118评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,085评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,007评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,844评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,283评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,508评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,667评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,395评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,985评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,630评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,797评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,653评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,553评论 2 352

推荐阅读更多精彩内容