自定义标签的解析
自定义标签的解析
一. 自定义标签使用
在spring中存在默认标签与自定义标签两种,例如:<bean/>为默认标签,<tx:annotation-driven/>为自定义标签。spring自定义标签比较灵活,可以扩展自定义标签。
扩展spring自定义标签主要步骤:
- 创建一个需要扩展的组件;
- 定义一个XSD文件描述组件内容;
- 创建一个类,该类实现BeanDifinitionParser接口,主要用来解析XSD文件中的定义和组件的定义;
- 创建一个NamespaceHandler类,该类扩展NamespaceHandlerSupport,主要作用是将组件注册到spring的容器中;
- 编写spring.handlers和spring.schemas文件
二.自定义标签解析
其实思路非常的简单,无非就是根据对应的bean获取对应的命名空间,然后根据命名空间解析对应的处理器,然后根据用户自定义的处理器进行解析,说起来容易,做起来可没那么简单,让我们来看看如何获取命名空间。
2.1.获取命名空间
标签的解析是从命名空间开始,无论是Spring默认的还是自定义的,都是以命名空间为基础的.至于如何实现,在org.w3c.dom.Node 中已经提供好的方法:
public String getNamespaceURI(Node node) {
return node.getNamespaceURI();
}
2.2 提取自定义标签处理器.
有了命名空间,就可以进行NamespaceHandler的提取了,分析NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);在readerContext初始化的时候其属性namespaceHandlerResolver已经被初始化为DefaultNamespaceHandlerResolver的实例,所以,这里调用的resolve方法其实调用的是DefaultNamespaceHandlerResolver类中的方法。
resolve方法
当得到自定义命名空间处理后马上执行namespaceHandler.init()来进行自定义BeanDefinitionParse的注册。在这里,可以注册多个标签解析器,上一篇文章中示例只有支持<myname:user的写法,当然也可以注册多个解析器,如<myname:A;<myname:B等,使得myname的命名空间中可以支持多种标签解析。
getHandlerMappings方法
注册后,命名空间处理器就可以根据标签的不同来调用不同的解析器进行解析。那么,根据上面的函数与之前介绍过的例子,我们基本可以推断getHandlerMappings的主要功能就是读取Spring.handlers配置文件并将配置文件缓存在map中。
该方法借助工具类PropertiesLoaderUtils对属性handlerMappingsLoaction进行了配置文件的读取,handlerMappingsLocation被默认初始化为“META-INF/Spring.handlers”
2.3 标签解析
得到了解析器已经要分析的元素后,Spring就可以将解析工作问题委托给自定义解析器取解析了。在Spring中的代码为:
return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));
以之前提到的示例进行分析,此时的handler已经被实例化成为了我们自定义的MyNamespaceHandler了,而MyNamespaceHandler也已经完成了初始化工作,但是在我们实现的自定义命名空间处理器中并没有实现parse方法,所以推断,这个方法是父类中的实现,查看父类NamespaceHandlerSupport中的parse方法。
NamespaceHandlerSupport 类
解析过程中首先是寻找元素对应的解析器,进而调用解析器中的parse方法,那么结合示例来说,其实就是首先获取在MyNameSpaceHandler类中的init方法中注册的对应的UserBeanDefinitionParser实例,并调用其parse方法进行进一步的解析。
parse方法的处理
示例中的UserBeanDefinitionParser类继承了AbstractSingleBeanDefinitionParser类,AbstractSingleBeanDefinitionParser继承了AbstractBeanDefinitionParser 类
AbstractBeanDefinitionParser 类
虽说是对自定义配置文件的解析,但是,我们可以看到,在这个函数中大部分的代码是用来处理将解析后的AbstractBeanDefinition转化为BeanDefinitionHolder并注册的功能,而真正去做解析的事情委托给了函数parseInternal,正是这个函数里调用了我们自定义的解析函数。
AbstractSingleBeanDefinitionParser 类
在parseInternal中并不是直接调用自定义的doParse函数,而是进行了一系列的数据准备,包括对beanClass,scope,lazyInit等属性的准备。
回顾一下全部的自定义标签处理过程,虽然在实例中我们定义UserBeanDefinitionParser,但是在其中我们只是做了与自己业务逻辑相关的部分。不过我们没做并不是代表没有,在这个处理过程中通用也是按照Spring中默认标签的处理方式进行,包含创建BeanDefinition以及进行相应默认属性的设置,对应这些工作Spring都默默地帮我们实现了,只是暴露出一些接口来供用户实现个性化的业务。通过对本文的了解,相信对Spring中自定义标签的使用以及在解析自定义标签过程中Spring为我们做了哪些工作会有一个全面的了解。到此,我们完成了Spring中全部的解析工作,理解了Spring将bean从配置文件到加载到内存中的全过程。
#读书笔记#