Spring源码初探-IOC(2)-Bean的初始化-自定义标签解析

前言

前面一文介绍的是Spring对于DefaultElement的解析,例如bean/import/alias等,但是在Spring体系中也存在很多扩展标签,例如事务、aop等非Default标签。按一般的套路通常是先介绍在Spring体系下如何在XML配置文件中自定义标签,本文先介绍Spring对于自定义标签的解析过程,在知道了Spring怎么“读”XML配置之后,写其能“读懂”的配置就显得非常自然了。

Spring自定义标签的解析过程

废话不多说了,先上图:

SpringIOC自定义标签解析过程.jpg

Delegate parseCustomElement

上篇介绍介绍了BeanDefinitionParserDelegate承担了大部分脏话累活,自定义标签的解析也是从BeanDefinitionParserDelegate开始进行。整个代码部分非常精简

public BeanDefinition parseCustomElement(Element ele, BeanDefinition containingBd) {   
String namespaceUri = getNamespaceURI(ele);   
NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri); 
  if (handler == null) { 
     error("Unable to locate Spring NamespaceHandler for XML schema namespace [" + namespaceUri + "]", ele);      return null;   }
   return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));
}

NameSpaceUri与NameSpaceHandler

整个代码的逻辑就是先得到namespaceUri,然后namespaceUri查询到相应的NameSpaceHandler,利用handler.parse方法解析标签element。Spring的类的命名和方法命名基本可以等同于注释了,我们可能已经开始猜测每个NameSpaceUri会对应一个NamespaceHandler,然后NamespaceHandler会负责解析该NameSpace下自定义的所有标签。

但是NameSpaceUri是个什么鬼,我们可能都知道c++里面的namespace为了避免命名污染,在XML中一样的,为了避免命名冲突,同一个文档中可以出现多个同名标签,只要ns不一样,一般都会这么写<aop:user><tx:user>,虽然element都是user但是却属于不同的ns,那像aop,tx这种前缀是在哪里指定的呢,是在root标签里(最好是).例如beans标签中的
"xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mytag="http://www.w3school.com.cn/david/user" "
就是指定了命名空间,说了一大堆,那NameSpaceUri是什么鬼,
http://www.springframework.org/schema/beans” 就是NameSpaceUri

this.readerContext.getNamespaceHandlerResolver()

会得到一个NamespaceHandlerResolver,这个NamespaceHandlerResolver的实现类是DefaultNamespaceHandlerResolver,在其中会保存一个handlerMappings,就是<NamespaceUri,NamespaceHandler>的map集合,在Spring一启动的时候就会扫描/META-INF下所有名为spring.handlers的文件(貌似不区分这个文件的大小写,同时没有找到spring何时做的这个事情,但确实做了...),利用PropertiesUtil将其中的"a=b"分割,a为key,b为value放入handlerMappings,此时handlerMappings中的value还都只是对应Handler Class的类全名。在DefaultNamespaceHandlerResolver.resolve(NameSpaceUri)时首先从handlerMappings取出对应的value,如果已经是NameSpaceHanlder的子类对象了,则返回。如果还是String的ClassName则反射出对应的Class类对象,然后实例化一个对象,调用它的init()方法,将其放入handlerMappings中(key仍然是NameSpaceUri),然后返回。说了一大堆,终于把如何获得对应NameSpaceUri的NamespaceHandler说明白了
接下来就是解释这句了

handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));

这句就是element的最终解析,delegate表示脏活累活再也不是我一个人干了,我还有handler这个小弟。handler嘿嘿一笑说,你还是navie呀,我也不怎么亲自干活的呢,我也将任务外包了喔。且看handler是怎么委派任务的吧!

NameSpaceHandler任务委派

NameSpaceHandler在parse的时候首先做的一件事情就是findParserForElement(在NameSpaceHandlerSupport中,Support意味助手,意思是告诉大家在自定义NameSpaceHandler时欢迎继承我,我会帮你做很多事情喔lol),顾名思义,一个命名空间下可以定义很多个不同名标签,首先要找到这个element所对应的parser,类似于老板说“这个功能谁负责的?处理一下这是需求”。同样的,NameSpaceHandlerSupport中也保存了parser的Map,那如果是自定义的NameSpaceHandler,那按理说parserMap中不会有对应标签的Parser呀!答案就是在NameSpaceHandlerResolve中,会调用NameSpaceHandler的init(),一种方法就是你在init()中将<elementName,parser>put到parserMap中,但其实由于NameSpaceHandler是你自己定义的,你其实有很多种方法可以在findParserForElement之前将对应的<elementName,parser>put到parserMap中。在findParserForElement后,开始执行parseInternal方法,一路看下来都是在做准备工作,没有实质性的解析工作,其中出现了一个getBeanClass()和getBeanClassName(),告诉parser你的element对应的Java类是啥。最后终于看到了doParse方法,按照经验来说,类中出现parse和doParse这样的一对方法,同时doParse还是用Protected,基本上可以断定这是模板模式或者策略模式。parse会将公共的解析逻辑抽取出来,将个性化的逻辑放入doParse,让子类实现个性化需求。最后调用parser的doParse方法完成相应的解析。最后像parseDefaultElement一样完成BeanDefinition的注册。

小结+如何实现自定义标签

洋洋洒洒写了一堆,小结一下。自定义标签设计到几个重要的类,NameSpaceHandler,BeanDefinitionParser。了解NameSpaceHandler和BeanDefinitionParser的过程就知道怎么自定义标签了,NameSpaceHandler的来源是spring会去扫描META-INF/spring.handlers的文件,所在在spring.handlers写清楚namespaceuri=namespacehanldername就行。同时由于XML验证机制有两种DTD和XSD,这里采用XSD,所以需要按照要求编写XSD文件,同时按照spring的要求,要在META-INF/spring.schemas文件中指定schema文件的位置。在就是需要写出NameSpaceHandler,可以通过集成NameSpaceHandlerSupport,最好是override init()方法完成初始化需求(例如put parser),同时需要定义怎么解析,编写BeanDefinitionParser类,可以通过继承AbstractSingleBeanDefinitionParser或者AbstractBeanDefinitionParser,由于在调用时需要调用doParse和getBeanClass,请override这两个方法完成定制化解析!

TODO 给出实例

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,585评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,724评论 6 342
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,397评论 25 707
  • 请求帮助是非暴力沟通的第四个要素,在表达观察、感受和需要之后,我们请求他人帮助。在本期沙龙活动中,大家通过交流和...
    冰捷_小飞鱼阅读 388评论 0 0
  • 胖人先胖肚,减肥先减腹;小肚腩的表现就是裤子得换大码,小肚腩的内在表现就是皮下脂肪堆积 利用碎片时间,用以下手法推...
    吃痴的瘦阅读 379评论 0 0