乐趣区

谈谈spring如何自定义标签

jiezi

干货点

了解如何基于 spring 自定义标签，这是自定义组件的第一步。而最重要的是了解了这个过程后也可以大致了解 spring 自身部分组件是怎么相互工作和触发的，如 spring-aop，组件可以通过反调 AopNamespaceHandler 了解大致面貌。

系列文描述

书写该系列文的初衷是因为最近正在负责一个组件的开发，于是打算将接触和学习到的知识写进博客里。这第一篇，记录基于 spring 如何自定义标签。

自定义标签的作用

自定义标签可以说是 spring 为了给类似你我这样的开发人员扩展组件使用的，因为它提供了一个标准的公共可插拔的接口；目前我们都知道 spring 非常强大，不过实际上除了 spring-core 和 spring-beans 外，其他都是通过自定义标签扩展实现的，其次还有一些开源组件也是，如 dubbo 等。所以，对于想扩展 spring 组件的小伙伴来说，了解如何自定义标签和相应的原理是必须走的第一步。

那么如何自定义标签

自定义标签可以简单分为四个步骤，分别是

  • 编写.schemas 文件，通知 spring 容器我们定义的 xsd 文件在哪里；
  • 编写.xsd 文件，定义配置时可以使用的属性限制或者说支持的那些属性配置；
  • 编写.handlers 文件，扩展 NamespaceHandler 命名空间注册器和定义解析器；
  • 在 xml 文件中使用自定义标签

下面我将以目前开发组件中的代码做例子，从在 xml 文件中使用开始一步一步逆推，复盘整个自定义标签的过程。

首先，先看下目录情况

common 是我自定义的一个组件组，其中包含的 resource 组件便是这次使用了自定义标签的主体，可以从截图中看出部分相关文件的存放位置。

test-demo 是为了测试这次组件中的自定义标签是否有作用而存在，test-demo 只是导入了 common 组件组而已，再从中调用 resource 组件。好了，目录结构描述完了，接下来进入正题。

看下 xml 文件如何使用自定义标签

在第 4 行这里引入了 resource 对应的命名空间，spring 会从本地扫.handlers，从中找到对应的 Key 值和 Value 值，如

spring 容器会将 Key 值对应的具体命名空间注册注册入容器，至于这个空间注册器是怎么样的，后面再表，继续描述 xml 文件。
在之后，我们可以在 xmlns:schemaLocation 中找到类似的 Key&Value 的配置，这次的配置是告诉 spring 容器从哪里查找 XSD 文件，这点可以从第六行找到，对应的 XSD 文件地址是:
http://www.nuofankj.com/resou…
细心的话不难发现，这是一个网络地址，是的，确实如此，不过 spring 的容器却是先在本地扫.schemas 文件，并且读取其中的键值对关系，从中找到本地的文件地址，如果找不到，才会从网络中读取。如spring.schemas 文件:

该文件以一种键值对的形式表明了文件在本地的地址，那就是 resource.xsd，之后 spring 容器便会找到resource.xsd 文件做校验。如


众所周知，XSD 文件的作用是定义配置时可以使用的属性限制或者说支持那些属性配置。我们可以直接看 applicationContext.xml 中的配置

走到这一步就说明配置文件配置好了，接下来便是如何解析的问题了。也就是上文提到com.nuofankj.resource.schema.NamespaceHandler。

那么 NamespaceHandler 类是什么样的

该类扩展自 NamespaceHandlerSupport，目的是将组件注册到 Spring 容器中。其中以 SchemaNames.CONFIG_ELEMENT 为名注册了一个类 ConfigDefinitionParser，SchemaNames.CONFIG_ELEMENT 对应的变量就是 config 字符串，目的就是为了解析

显然，ConfigDefinitionParser就是作为解析器存在的。

接下来看看该解析器是什么样的

该解析器继承了 AbstractBeanDefinitionParser 类，并且重写 parseInternal 方法，其中的参数 element 携带了 resource:config 中的所有配置，我们可以将自身的解析业务放在该函数中。以我自定义的组件为例：

我这边的业务是将 SchemaNames.PACKAGE_ELEMENT 包下的所有类扫出来并且放入 list 中保存，已经读取出 type、suffix 等相关配置。

到这一步，自定义标签的过程就全部理清楚了。
相关源码地址：https://github.com/wiatingpub…

Java 源码分析、go 语言应用、微服务，更多干货欢迎关注公众号：

退出移动版