Spring中的可扩展点（一）自定义标签
  yIqmAAsdee9S 2023年11月02日 73 0


目录

​​1.自定义标签具体步骤​​

​​2.DEMO例程​​

​​2.1 创建User类​​

​​2.2 创建自定义解析器UserBeanDefinitionParser​​

​​2.3 创建自定义处理器UserNameSpaceHandler​​

​​2.4 创建自定义XSD​​

​​2.5 创建Spring.handlers 和 Spring.schemas​​

​​2.6 测试类 Application​​

​​2.7 运行结果及目录结构：​​

​​3.我们创建的几个文件是如何关联到一起的​​

​​4.Spring是如何做到可扩展的​​

1.自定义标签具体步骤

  1. 创建一个需要被自定义标签解析的bean
  2. 创建一个标签解析器Parser，继承自 AbstractSingleBeanDefinitionParser ，用来解析 XSD 中的标签。
  3. 创建一个标签处理器Handler，继承自 NamespaceHandlerSupport， 并实现其init()方法
  4. 创建一个自定义的 XSD 描述文件
  5. 编写 Spring.handlers 和 Spring.schemas 文件，用于引导spring加载对应标签处理器

2.DEMO例程

2.1 创建User类

package com.zoo.customXsd;

/**
 * @author liuxiaobai
 */
public class User {
  private String userName;
  private String passWord;

  public String getUserName() {
    return userName;
  }

  public void setUserName(String userName) {
    this.userName = userName;
  }

  public String getPassWord() {
    return passWord;
  }

  public void setPassWord(String passWord) {
    this.passWord = passWord;
  }

  @Override
  public String toString() {
    return "User{" +
        "userName='" + userName + '\'' +
        ", passWord='" + passWord + '\'' +
        '}';
  }
}

2.2 创建自定义解析器UserBeanDefinitionParser

package com.zoo.customXsd;

import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
import org.springframework.util.StringUtils;
import org.w3c.dom.Element;

/**
 * User标签解析器
 * @author dasouche
 */
public class UserBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {

  @Override
  protected Class<?> getBeanClass(Element element) {
    return User.class;
  }

  @Override
  protected void doParse(Element element, BeanDefinitionBuilder builder) {
    String userName = element.getAttribute("userName");
    String passWord = element.getAttribute("passWord");

    if(StringUtils.hasText(userName)){
      builder.addPropertyValue("userName",userName);
    }

    if(StringUtils.hasText(passWord)){
      builder.addPropertyValue("passWord",passWord);
    }
  }
}

2.3 创建自定义处理器UserNameSpaceHandler

package com.zoo.customXsd;

import org.springframework.beans.factory.xml.NamespaceHandlerSupport;

/**
 * User标签处理器
 * @author dasouche
 */
public class UserNameSpaceHandler extends NamespaceHandlerSupport {
  @Override
  public void init() {
    registerBeanDefinitionParser("user",new UserBeanDefinitionParser());
  }
}

2.4 创建自定义XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
       targetNamespace="http://www.en.com/schema/user"
       elementFormDefault="qualified">

  <xs:element name="user">
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base="xs:string">
          <xs:attribute name="id" type="xs:string"/>
          <xs:attribute name="userName" type="xs:string"/>
          <xs:attribute name="passWord" type="xs:string"/>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>

</xs:schema>

2.5 创建Spring.handlers 和 Spring.schemas

Spring.schemas：

http\://www.en.com/schema/user.xsd=META-INF/user.xsd

Spring.handlers：

http\://www.en.com/schema/user=com.zoo.customXsd.UserNameSpaceHandler

2.6 测试类 Application

package com.zoo;

import com.zoo.customXsd.User;
import org.springframework.context.support.AbstractApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

/**
 * @author liuxiaobai
 */
public class Application {
  public static void main(String[] args) {

    AbstractApplicationContext ac = new ClassPathXmlApplicationContext("applicationContext.xml");
    User user = (User)ac.getBean("user");
    System.out.println(user);
    ac.registerShutdownHook();
  }
}

2.7 运行结果及目录结构：

Spring中的可扩展点（一）自定义标签_spring3.我们创建的几个文件是如何关联到一起的

        首先Spring.schemas做了一个版本与本地xsd文件的映射，作用是让Spring优先加载本地xsd文件（毕竟我们写的user.xsd网络上访问不了）。其次Spring.handlers文件中配置了xsd命名空间与对应的处理器的匹配关系，让UserNameSpaceHandler和user.xsd关联到了一起。最后UserNameSpaceHandler代码内部绑定了和UserBeanDefinitionParser的关系。

4.Spring是如何做到可扩展的

        Spring.schemas关联关系配置在AbstractXmlApplicationContext#loadBeanDefinitions()方法：

Spring中的可扩展点（一）自定义标签_后端_02

        一系列的构造函数跟进去，发现在此处配置了PluggableSchemaResolver和spring.schemas的映射关系：

Spring中的可扩展点（一）自定义标签_xml_03

Spring中的可扩展点（一）自定义标签_java_04

具体调用堆栈：

<init>:63, DelegatingEntityResolver (org.springframework.beans.factory.xml)
<init>:68, ResourceEntityResolver (org.springframework.beans.factory.xml)
loadBeanDefinitions:93, AbstractXmlApplicationContext (org.springframework.context.support)
refreshBeanFactory:137, AbstractRefreshableApplicationContext (org.springframework.context.support)
obtainFreshBeanFactory:674, AbstractApplicationContext (org.springframework.context.support)
refresh:534, AbstractApplicationContext (org.springframework.context.support)
<init>:145, ClassPathXmlApplicationContext (org.springframework.context.support)
<init>:85, ClassPathXmlApplicationContext (org.springframework.context.support)
main:13, Application (com.zoo)

        spring.schemas文件信息的读取在PluggableSchemaResolver#getSchemaMappings()： Spring中的可扩展点（一）自定义标签_spring_05

具体调用堆栈：

getSchemaMappings:149, PluggableSchemaResolver (org.springframework.beans.factory.xml)
resolveEntity:116, PluggableSchemaResolver (org.springframework.beans.factory.xml)
resolveEntity:90, DelegatingEntityResolver (org.springframework.beans.factory.xml)
resolveEntity:78, ResourceEntityResolver (org.springframework.beans.factory.xml)
resolveEntity:110, EntityResolverWrapper (com.sun.org.apache.xerces.internal.util)
resolveEntity:1079, XMLEntityManager (com.sun.org.apache.xerces.internal.impl)
resolveDocument:655, XMLSchemaLoader (com.sun.org.apache.xerces.internal.impl.xs)
findSchemaGrammar:2681, XMLSchemaValidator (com.sun.org.apache.xerces.internal.impl.xs)
handleStartElement:2056, XMLSchemaValidator (com.sun.org.apache.xerces.internal.impl.xs)
startElement:816, XMLSchemaValidator (com.sun.org.apache.xerces.internal.impl.xs)
scanStartElement:375, XMLNSDocumentScannerImpl (com.sun.org.apache.xerces.internal.impl)
scanRootElementHook:614, XMLNSDocumentScannerImpl$NSContentDriver (com.sun.org.apache.xerces.internal.impl)
next:3134, XMLDocumentFragmentScannerImpl$FragmentContentDriver (com.sun.org.apache.xerces.internal.impl)
next:867, XMLDocumentScannerImpl$PrologDriver (com.sun.org.apache.xerces.internal.impl)
next:605, XMLDocumentScannerImpl (com.sun.org.apache.xerces.internal.impl)
next:113, XMLNSDocumentScannerImpl (com.sun.org.apache.xerces.internal.impl)
scanDocument:507, XMLDocumentFragmentScannerImpl (com.sun.org.apache.xerces.internal.impl)
parse:867, XML11Configuration (com.sun.org.apache.xerces.internal.parsers)
parse:796, XML11Configuration (com.sun.org.apache.xerces.internal.parsers)
parse:142, XMLParser (com.sun.org.apache.xerces.internal.parsers)
parse:247, DOMParser (com.sun.org.apache.xerces.internal.parsers)
parse:339, DocumentBuilderImpl (com.sun.org.apache.xerces.internal.jaxp)
loadDocument:77, DefaultDocumentLoader (org.springframework.beans.factory.xml)
doLoadDocument:432, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
doLoadBeanDefinitions:390, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
loadBeanDefinitions:338, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
loadBeanDefinitions:310, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
loadBeanDefinitions:188, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:224, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:195, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:257, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:134, AbstractXmlApplicationContext (org.springframework.context.support)
loadBeanDefinitions:98, AbstractXmlApplicationContext (org.springframework.context.support)
refreshBeanFactory:137, AbstractRefreshableApplicationContext (org.springframework.context.support)
obtainFreshBeanFactory:674, AbstractApplicationContext (org.springframework.context.support)
refresh:534, AbstractApplicationContext (org.springframework.context.support)
<init>:145, ClassPathXmlApplicationContext (org.springframework.context.support)
<init>:85, ClassPathXmlApplicationContext (org.springframework.context.support)
main:13, Application (com.zoo)

        Spring.handlers配置关系在XmlBeanDefinitionReader#registerBeanDefinitions()：

Spring中的可扩展点（一）自定义标签_后端_06

        一系列构造函数跟进去，发现在DefaultNamespaceHandlerResolver类配置了和Spring.handlers文件的对应关系：

Spring中的可扩展点（一）自定义标签_spring_07Spring中的可扩展点（一）自定义标签_apache_08

具体调用堆栈：

<init>:93, DefaultNamespaceHandlerResolver (org.springframework.beans.factory.xml)
createDefaultNamespaceHandlerResolver:552, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
getNamespaceHandlerResolver:540, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
createReaderContext:531, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
registerBeanDefinitions:512, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
doLoadBeanDefinitions:391, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
loadBeanDefinitions:338, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
loadBeanDefinitions:310, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
loadBeanDefinitions:188, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:224, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:195, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:257, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:134, AbstractXmlApplicationContext (org.springframework.context.support)
loadBeanDefinitions:98, AbstractXmlApplicationContext (org.springframework.context.support)
refreshBeanFactory:137, AbstractRefreshableApplicationContext (org.springframework.context.support)
obtainFreshBeanFactory:674, AbstractApplicationContext (org.springframework.context.support)
refresh:534, AbstractApplicationContext (org.springframework.context.support)
<init>:145, ClassPathXmlApplicationContext (org.springframework.context.support)
<init>:85, ClassPathXmlApplicationContext (org.springframework.context.support)
main:13, Application (com.zoo)

        Spring.handlers的读取在DefaultNamespaceHandlerResolver#getHandlerMappings()：

Spring中的可扩展点（一）自定义标签_后端_09

具体堆栈：

getHandlerMappings:158, DefaultNamespaceHandlerResolver (org.springframework.beans.factory.xml)
resolve:119, DefaultNamespaceHandlerResolver (org.springframework.beans.factory.xml)
parseCustomElement:1400, BeanDefinitionParserDelegate (org.springframework.beans.factory.xml)
parseCustomElement:1384, BeanDefinitionParserDelegate (org.springframework.beans.factory.xml)
parseBeanDefinitions:179, DefaultBeanDefinitionDocumentReader (org.springframework.beans.factory.xml)
doRegisterBeanDefinitions:149, DefaultBeanDefinitionDocumentReader (org.springframework.beans.factory.xml)
registerBeanDefinitions:96, DefaultBeanDefinitionDocumentReader (org.springframework.beans.factory.xml)
registerBeanDefinitions:512, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
doLoadBeanDefinitions:391, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
loadBeanDefinitions:338, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
loadBeanDefinitions:310, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
loadBeanDefinitions:188, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:224, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:195, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:257, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:134, AbstractXmlApplicationContext (org.springframework.context.support)
loadBeanDefinitions:98, AbstractXmlApplicationContext (org.springframework.context.support)
refreshBeanFactory:137, AbstractRefreshableApplicationContext (org.springframework.context.support)
obtainFreshBeanFactory:674, AbstractApplicationContext (org.springframework.context.support)
refresh:534, AbstractApplicationContext (org.springframework.context.support)
<init>:145, ClassPathXmlApplicationContext (org.springframework.context.support)
<init>:85, ClassPathXmlApplicationContext (org.springframework.context.support)
main:13, Application (com.zoo)

        配置文件读取完毕，就是最后的标签解析工作了，入口在DefaultBeanDefinitionDocumentReader#parseBeanDefinitions()方法：

Spring中的可扩展点（一）自定义标签_apache_10

        继续跟进到BeanDefinitionParserDelegate#parseCustomElement()方法：

Spring中的可扩展点（一）自定义标签_java_11

        这里我们可以看到已经可以拿到我们自定义的handler了，跟进这个resolve方法：

Spring中的可扩展点（一）自定义标签_apache_12

        可以看到红框对UserNameSpaceHandler进行了一个反射创建，然后蓝框里调用了UserNameSpaceHandler的init()方法，将UserBeanDefinitionParser注册到了UserNameSpaceHandler中，最后绿框将命名空间和对应的handler对应上。

Spring中的可扩展点（一）自定义标签_apache_13

        创建好UserNameSpaceHandler的实例后，可以看到调用了UserNameSpaceHandler的parse方法，然后经过一系列拥有继承关系的parse方法，最终会调用到我们自定义的UserBeanDefinitionParser解析器的parse方法中，从而完成对自定义标签的解析。

具体调用过程：

doParse:21, UserBeanDefinitionParser (com.zoo.customXsd)
doParse:146, AbstractSingleBeanDefinitionParser (org.springframework.beans.factory.xml)
parseInternal:88, AbstractSingleBeanDefinitionParser (org.springframework.beans.factory.xml)
parse:63, AbstractBeanDefinitionParser (org.springframework.beans.factory.xml)
parse:74, NamespaceHandlerSupport (org.springframework.beans.factory.xml)
parseCustomElement:1405, BeanDefinitionParserDelegate (org.springframework.beans.factory.xml)
parseCustomElement:1384, BeanDefinitionParserDelegate (org.springframework.beans.factory.xml)
parseBeanDefinitions:179, DefaultBeanDefinitionDocumentReader (org.springframework.beans.factory.xml)
doRegisterBeanDefinitions:149, DefaultBeanDefinitionDocumentReader (org.springframework.beans.factory.xml)
registerBeanDefinitions:96, DefaultBeanDefinitionDocumentReader (org.springframework.beans.factory.xml)
registerBeanDefinitions:512, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
doLoadBeanDefinitions:391, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
loadBeanDefinitions:338, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
loadBeanDefinitions:310, XmlBeanDefinitionReader (org.springframework.beans.factory.xml)
loadBeanDefinitions:188, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:224, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:195, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:257, AbstractBeanDefinitionReader (org.springframework.beans.factory.support)
loadBeanDefinitions:134, AbstractXmlApplicationContext (org.springframework.context.support)
loadBeanDefinitions:98, AbstractXmlApplicationContext (org.springframework.context.support)
refreshBeanFactory:137, AbstractRefreshableApplicationContext (org.springframework.context.support)
obtainFreshBeanFactory:674, AbstractApplicationContext (org.springframework.context.support)
refresh:534, AbstractApplicationContext (org.springframework.context.support)
<init>:145, ClassPathXmlApplicationContext (org.springframework.context.support)
<init>:85, ClassPathXmlApplicationContext (org.springframework.context.support)
main:13, Application (com.zoo)


【版权声明】本文内容来自摩杜云社区用户原创、第三方投稿、转载，内容版权归原作者所有。本网站的目的在于传递更多信息，不拥有版权，亦不承担相应法律责任。如果您发现本社区中有涉嫌抄袭的内容，欢迎发送邮件进行举报，并提供相关证据，一经查实，本社区将立刻删除涉嫌侵权内容，举报邮箱： cloudbbs@moduyun.com
  1. 分享：
最后一次编辑于 2023年11月08日 0

暂无评论

推荐阅读
  Fo7woytj0C0D   2023年12月05日   32   0   0 apache配置文件python配置文件apachepython
  M5nxXzKbD3Q7   2023年11月12日   22   0   0 xmlmavenjar
  ehrZuhofWJiC   2024年04月26日   34   0   0 日志Java
  Jhm59sn3Kvlc   2023年12月10日   18   0   0 线程池spring初始化线程池初始化spring
  9PSGasUnvz7Z   2023年11月12日   29   0   0 端口号负载均衡springspring负载均衡端口号
  gNBSs4nizMqi   2023年11月28日   35   0   0 phpJavaJavaAPIphpAPI
  eYG94FiPmgxI   2023年12月05日   31   0   0 DockerJava生产环境dockerjava生产环境
  ehrZuhofWJiC   2024年04月26日   53   0   0 Java服务器前端
  Btp0eNAa4Hox   2023年11月12日   33   0   0 xml配置文件nginx配置文件xmlnginx
  Fo7woytj0C0D   2023年12月23日   50   0   0 apache重启mysqlapache重启mysql
  eZw8kcl3fQWu   2023年11月12日   25   0   0 自定义负载均衡springspring负载均衡自定义
  ehrZuhofWJiC   2024年04月26日   32   0   0 Javalinuxpython
  P4J28hGiXXEt   2023年11月12日   35   0   0 端口号Javatomcat
  FHVSBErvDkPx   2023年12月05日   29   0   0 用户名vimJavavimJava用户名
  fXehBe7hd4rt   2023年11月28日   29   0   0 Javajava安装javajava安装
  P4J28hGiXXEt   2023年11月12日   35   0   0 Java服务器web服务器
  P4J28hGiXXEt   2023年11月12日   34   0   0 文本文件Javatomcat
  0G6LfYiaSbjs   2023年11月19日   31   0   0 apachenginxapachenginx
  ehrZuhofWJiC   2024年04月26日   46   0   0 JavaIDEA
yIqmAAsdee9S
yIqmAAsdee9S
作者其他文章 更多
Spring中的可扩展点（一）自定义标签

2023-11-02

Spring中的可扩展点（二）自定义属性编辑器

2023-11-02

最新推荐 更多
Centos yum install和yum groupinstall的区别

2024-05-31

系统概要设计

2024-05-31

配置过滤器（解决乱码）

2024-05-31

【前端传过来三次请求，主键为 业务系统，三次以后就停止发送】

2024-05-31

力扣数据中心有 n 台服务器，分别按从 0 到 n-1 的方式进行了编号

2024-05-17

remix-ide是浏览器的ide，官方已经提供地址，但是需要连接外网。如果是内网，需要自己在服务器里搭建remix-ide；另一种方式是用remix-ide的桌面版。

2024-05-17

Linux：Centos9：配置固定ip

2024-05-17

Linux：shell脚本：基础使用（4）《正则表达式-grep工具》

2024-05-17

MDM（移动设备管理策略系统）、MAM、MCM作用

2024-05-17

Linux配置yum源(本地源和网络源)

2024-05-17

iOS调用系统相册、相机 显示中文标题

2024-05-17

linux 新增磁盘通过fstab自动挂载重启系统后系统故障案例

2024-05-17

Linux网络配置文件:MAC,UUID,设备名,子网掩码,网关,DNS等底层结构、架构图，工作原理 ，使用场景详解

2024-05-17

系统时间正常日志时间不正常

2024-05-17

吃透nginx 403 forbidden报错

2024-05-17

linux系统中解决docker: command not found

2024-05-17

#yyds干货盘点# Go+ HTTP 服务器教程（5.2）

2024-05-17

如何避免Win10监控你的一举一动

2024-05-17

flume 隐藏文件.flumespool-main.meta (系统找不到指定的路径。)

2024-05-17

使用adb命令抓取崩溃日志

2024-05-17

常用标签
数据数据数据数据javalinuxlinuxpythonCentOSredisJavapython区块链技术区块链信息系统字符串MySQL资讯项目管理mysql教程MySQL