Spring自定义标签体系和应用

我们知道,在使用Dubbo框架时,需要指定配置文件中的application、protocol、registry、provider、service等服务器端和客户端的配置项,典型的配置方法如下所示。通过这些配置项,我们可以基于Spring容器来启动Dubbo服务。

<!-- 提供方应用信息,用于计算依赖关系 -->  

<dubbo:application name="demo-provider"/>  

<!-- 用dubbo协议在20880端口暴露服务 -->  

<dubbo:protocol name="dubbo" port="20880"/>  

<!-- 使用zookeeper注册中心暴露服务地址 -->  

<dubbo:registry address="zookeeper://127.0.0.1:2181" id="registry"/>  

<!-- 默认的服务端配置 -->  

<dubbo:provider registry="registry" retries="0" timeout="5000"/>  

<!-- 和本地bean一样实现服务 -->  

<bean id="demoService" class="org.apache.dubbo.demo.provider.DemoServiceImpl"/>  

<!-- 声明需要暴露的服务接口 -->  

<dubbo:service interface="org.apache.dubbo.demo.DemoServicee" ref="demoService"/>

看到这些配置项,你可能会好奇,因为它们都不是Spring内置的配置项,而是Dubbo框架所特有的。那么,Spring是如何识别和使用这些配置项的呢?这就是今天要介绍的内容,即Spring所具备的自定义标签体系及其应用方式。

什么Spring自定义标签体系?

在介绍Spring的自定义标签体系之前,我们先来回顾一下AbstractApplicationContext中的refresh方法,其中存在如下所示的一行关键代码。

public void refresh() throws BeansException, IllegalStateException {

//获取Beanfactory

ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();

}

上述语句会刷新BeanFactory,加载XML配置文件从而生成Map<String,BeanDefinition>的一个映射。这个加载Bean的场景是一个比较常见的扩展点时机。

我们知道在Spring的XML中配置如下所示的bean的定义,Spring就会在容器启动时进行解析然后转换成特定的BeanDefinition。

<bean id="myClass" class="com.demo.MyClass"/>

显然,对于扩展性而言,我们完全可以在这种Bean定义中添加自己所需的任何标签,从而实现定制化控制功能。Spring允许你自己定义XML结构并且可以用自己的Bean解析器进行解析。从扩展性的角度讲,基于配置文件的扩展也是非常常见和实用的扩展方法。通过这种实现技术,我们自己开发的框架也可以和Spring完成无缝的集成。

Spring自定义标签体系的开发流程

想要做到基于标签的扩展机制,Spring也提供了一套固定的开发流程,主要包括四个步骤。


接下来,让我们对上图中的开发步骤一一进行展开。

编写扩展对象和XSD文件

首先,我们可以根据需要设计一个业务对象,例如如下所示的Account对象。

public class Account{

 private String id;

 private String name;

 private Integer age;

}

如果我们希望该对象中的所有字段都能够进行配置,那么就可以针对这些配置项编写XSD文件,XSD是XML Schema的定义文件,本例中的XSD文件如下所示。

<?xml version="1.0" encoding="UTF-8"?>

<xsd:schema

xmlns="http://spring.xiaoyiran.com/dailyclass/schema/account"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:beans="http://www.springframework.org/schema/beans"

targetNamespace=" http://spring.xiaoyiran.com/dailyclass/schema/account "

elementFormDefault="qualified"

attributeFormDefault="unqualified">

<xsd:import namespace="http://www.springframework.org/schema/beans" />

<xsd:element name="account">

<xsd:complexType>

<xsd:complexContent>

<xsd:extension base="beans:identifiedType">

<xsd:attribute name="name" type="xsd:string" />

<xsd:attribute name="age" type="xsd:int" />

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

</xsd:element>

</xsd:schema>

上述定义中,我们针对Account对象的三个字段做了定义。这里使用的定义方法都是XSD中的固定用法。请注意,我们这里就通过targetNamespace配置项指定了Account对象所属的命名空间。

XSD文件完成后需要存放在classpath下,一般都放在META-INF目录下。

编写NamespaceHandler实现类

想要完成对上述配置项的解析工作,需要用到NamespaceHandler和BeanDefinitionParser这两个核心类。其中NamespaceHandler会根据Schema和节点名找到某个BeanDefinitionParser,然后由BeanDefinitionParser完成具体的解析工作。通过这两个类之间协作过程,我们将完成从XSD到Spring中BeanDefinition的转换过程。


想要从零开始实现一个NamespaceHandler还是有比较复杂的,通常也没有必要。幸好Spring已经为我们提供了默认的NamespaceHandlerSupport实现类。实际上,Spring内部很多特定组件的配置项解析也依赖于在这个NamespaceHandlerSupport类的基础之上演变出各种子类。所以,如果我们想要实现一个自定的NamespaceHandler,最简单的方法就是继承NamespaceHandlerSupport然后在它的init方法中执行如下所示的registerBeanDefinitionParser方法。

public class AccountNamespaceHandler extends NamespaceHandlerSupport {

    public void init() {

        registerBeanDefinitionParser("account", new AccountBeanDefinitionParser());

    }

}

可以看到,这里出现了一个AccountBeanDefinitionParser。通过以上方法,当我们在Spring的在配置中引用<account>配置项时,就会用AccountBeanDefinitionParser来解析配置。让我们一起来看一下。

编写BeanDefinitionParser实现类

上述AccountBeanDefinitionParser就是一个BeanDefinitionParser接口的实现类,该接口专门用来将配置项转换为BeanDefinition。

针对这一接口,Spring同样为我们提供了它的一个抽象实现类AbstractBeanDefinitionParser。请注意,AbstractBeanDefinitionParser类是一个典型的模板类,这点从它的parse方法的主流程就可以看出。

public final BeanDefinition parse(Element element, ParserContext parserContext) {

AbstractBeanDefinition definition = parseInternal(element, parserContext);

if (definition != null && !parserContext.isNested()) {

try {

String id = resolveId(element, definition, parserContext);

String[] aliases = new String[0];

String name = element.getAttribute(NAME_ATTRIBUTE);

BeanDefinitionHolder holder = new BeanDefinitionHolder(definition, id, aliases);

registerBeanDefinition(holder, parserContext.getRegistry());

}

}

return definition;

}

这段代码完成了BeanDefinition从解析到注册的主流程。这里第一句parseInternal是AbstractBeanDefinitionParser类提供的抽象方法,需要子类进行实现。一方面,我们可以直接继承AbstractBeanDefinitionParser以实现这个子类(例如后面要介绍Dubbo就是采用这种实现方法),而在Spring中也抽象了几个AbstractBeanDefinitionParser的实现类以降低二次扩展的难度,其中最典型的就是AbstractSingleBeanDefinitionParser类。我们找到这个类发现它同样也是一个模板类。在AbstractSingleBeanDefinitionParser的parseInternal方法的代码结构如下所示。

protected final AbstractBeanDefinition parseInternal(Element element, ParserContext parserContext) {

//创建BeanDefinitionBuilder

BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition();

  //抽象方法,交由子类实现具体的转换过程

doParse(element, parserContext, builder);

  //返回BeanDefinitionBuilder所构建的BeanDefinition

return builder.getBeanDefinition();

}

显然,这里再次调用了doParse这个抽象方法。请注意这里的BeanDefinitionBuilder,作为BeanDefinition的构造器组件,它同样传递给了doParse方法。

按照Spring中一般的方法命名风格,doParse应该是整个方法调用链的末端方法,也是我们自定义BeanDefinitionParser所需要实现的方法。因此,针对上述示例,我们可以实现如下所示的继承了AbstractSingleBeanDefinitionParser的AccountBeanDefinitionParser类。

public class AccountBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {

    protected Class getBeanClass(Element element) {

        return Account.class;

    }

    protected void doParse(Element element, BeanDefinitionBuilder bean) {

        String name = element.getAttribute("name");

        String age = element.getAttribute("age");

        String id = element.getAttribute("id");

        if (StringUtils.hasText(id)) {

            bean.addPropertyValue("id", id);

        }

        if (StringUtils.hasText(name)) {

            bean.addPropertyValue("name", name);

        }

        if (StringUtils.hasText(age)) {

            bean.addPropertyValue("age", Integer.valueOf(age));

        }

    }

}

这里的核心还是使用BeanDefinitionBuilder添加了各种自定义的配置项。

编写spring.handlers和spring.schemas

实现自定义标签的最后一步是编写spring.handlers和spring.schemas这两个配置文件,这两个文件需要我们自己编写并放入META-INF文件夹中。请注意,这两个文件的地址必须是当前代码工程下的META-INF/spring.handlers和META-INF/spring.schemas。其中,spring.schemas配置文件用来指定XSD文件的路径,XSD文件文件中包含了命名空间的定义。而spring.handlers则用来把命名空间和NamespaceHandler对应起来。


至此,整个基于Spring自定义标签体系的开发流程介绍完毕。接下里,就让我们来看一下Dubbo中如何这套体系实现与Spring框架之间的集成。

解析Dubbo中的自定义标签体系

让我们回顾Dubbo启动方法。我们在今天内容的开头已经提到Dubbo配置项中提供的application、protocol、registry、provider、service等服务器端和客户端的配置项,Dubbo提供了一套解析方法和过程来完成配置项到具体实现类的转变过程。

事实上,Dubbo提供了专门的DubboNamespaceHandler来完成各个配置项的解析,如下所示。

public class DubboNamespaceHandler extends NamespaceHandlerSupport {

    public void init() {

        registerBeanDefinitionParser("application", new DubboBeanDefinitionParser(ApplicationConfig.class, true));

        …

    }

}

可以看到这个DubboNamespaceHandler就直接继承了Spring提供的NamespaceHandlerSupport类,然后针对各个配置项通过registerBeanDefinitionParser方法注册了各自对应的BeanDefinitionParser,Dubbo中这个BeanDefinitionParser就是DubboBeanDefinitionParser。这些类之间关联关系如下图所示。


然后我们来看DubboBeanDefinitionParser中parse方法的代码结构,这个方法比较长,给出它的整体流程。


在上述流程中,Dubbo会分别对一些特定的Bean定义做了特殊处理,包括ProtocolConfig、ServiceBean、ProviderConfig、ConsumerConfig等,分别考虑这些Bean中存在的子节点、ref引用等配置项,我们结合Dubbo配置项示例不难理解这些代码的处理逻辑。而这部分工作涉及到大量对Dubbo中配置属性的解析过程。这些解析过程最终都是使用以下语句完成了对Spring的BeanDefinition的填充。

BeanDefinition.getPropertyValues().addPropertyValue(property, value)

总体而言,DubboBeanDefinitionParser的实现复杂度来自于Dubbo中配置项的复杂度。对于我们日常开发中所需要实现的BeanDefinitionParse组件的开发模式而言,本质上没有什么特殊之处。Dubbo中的整个自定义配置标签体系完全采用了Spring中基于命名空间进行扩展的标准实现机制。通过这样一个过程,就实现了将XML自定义的标签加载到Spring容器中,而不需要使用Spring自己的Bean去定义。这是日常开发过程中的一种简单而实用的技巧,应用非常广泛。

总结

如果想要基于Spring框架来实现一个自定义标签,从而为系统提供更多的可扩展性,那么今天的内容可以帮助你完整这一目标。事实上,如果我们的目标是开发一个与Spring进行有效集成的自定义框架(例如Dubbo和Mybatis),那么自定义标签可以说是必不可少的一个环节,因为在Spring框架中,我们一般都需要依赖于它的自定义标签体系完成一些配置项的设置和装配工作。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mfbz.cn/a/729133.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

Docker Desktop进入界面时一直转圈的解决办法记录

我的win10版本如下&#xff0c;是支持安装的&#xff0c;不支持安装的&#xff0c;可以先升级系统版本&#xff1a; 起初是因为运行Docker Desktop时一直转圈&#xff0c;无法进入主面板&#xff0c;百度之&#xff0c;需要安装hype-v环境&#xff0c;找到以下 勾选Hyper-V下的…

怎么学习PMP才是最正确的?

每个人的学习方式各不相同&#xff0c;不能一概而论说某种学习方式就是错误的。学习方式并没有绝对的对错之分&#xff0c;只能说是否适合自己&#xff0c;是否能够达到预期的学习效果。并不是别人的学习方式就一定适合自己&#xff0c;也不是不适合自己的学习方式就一定是错误…

嵌入式系统基础

嵌入式系统基础主要包括以下几个方面&#xff1a; 1、定义&#xff1a; 嵌入式系统是以应用为中心&#xff0c;以计算机技术为基础&#xff0c;软硬件可裁剪&#xff0c;适应应用系统对功能、可靠性、成本、体积、功耗严格要求的专用计算机系统。它由硬件和软件组成&#xff0…

YOLOv8模型代码学习

1.参考文献 链接1 2.网络模型解析 2.1卷积神经单元&#xff08;conv.py&#xff09; 在该文件中定义了yolov8网络中的卷积神经单元&#xff0c;位置如图所示。 def autopad(k, pNone, d1): # kernel(卷积核), padding(填充), dilation(扩张)"""Pad to same…

数据中心技术:大数据时代的机遇与挑战

在大数据时代&#xff0c;数据中心网络对于存储和处理大量信息至关重要。随着云计算的出现&#xff0c;数据中心已成为现代技术的支柱&#xff0c;支持社交媒体、金融服务等众多行业。然而&#xff0c;生成和处理的大量数据带来了一些挑战&#xff0c;需要创新的解决方案。在这…

不同版本的 Rocky Linux 快速更换阿里镜像源

环境&#xff1a;兼容 Rocky Linux 任意版本。 搞服务器系统从 CentOS 折腾到 Rocky Linux&#xff0c;然后又折腾到 Alma Linux&#xff1b;最近因为 RKE2 没有做 Alma Linux 的兼容性&#xff0c;又折腾到了 Rocky Linux &#xff0c;真的是一把鼻涕一把泪呀。但是实在是不理…

深入理解和实现Windows进程间通信(共享内存)

常见的进程间通信方法 常见的进程间通信方法有&#xff1a; 管道&#xff08;Pipe&#xff09;消息队列共享内存信号量套接字 下面&#xff0c;我们将详细介绍共享内存的原理以及具体实现。 什么是共享内存&#xff1f; Windows共享内存&#xff08;Shared Memory in Windo…

【linux】内核源码TCP->IP->L2层函数调用继续摸索中

日志打印的时候&#xff0c;把行数也打印了&#xff1a; 登录 - Gitee.comhttps://gitee.com/r77683962/linux-6.9.0/commit/b847489a9910f68b9581fd8788807c697c82cdbd 上回基于应用层wget操作找到TCP调用的一些接口&#xff0c;并且已经到IP层的一些接口&#xff0c;当前基…

Windows系统Maven下载安装

下载&#xff1a; 官网地址&#xff1a;https://maven.apache.org/download.cgi 安装&#xff1a; 下载下来的是一个压缩包&#xff0c;首先将其解压到你的Maven目标安装位置 接下来为其配置其环境变量 &#xff08;Maven的基础是Java&#xff0c;因此要首先确认已为你的电…

求求你别学了:从 Prompt 到 RAG,从 RAG 到 DSPy

如本瓜在此前的文章中提到过&#xff0c;Prompt 工程已经不中用了&#xff0c;没有人愿意废那么大的劲来学习如何结构化提问&#xff0c;大家想要的就是傻瓜式提问&#xff0c;但是大模型的回答还是精准的、合意的&#xff1b; 后来&#xff0c;大兴 RAG 技术&#xff0c;做专…

Nuxt快速学习开发 - Nuxt3静态资源Assets

Nuxt 使用两个目录来处理样式表、字体或图像等资产。 public/目录内容按原样在服务器根目录中提供。 assets/目录包含您希望构建工具&#xff08;Vite 或 webpack&#xff09;处理的所有资产。 public/目录 public目录用作静态资产的公共服务器&#xff0c;可在您的应用程序定…

景联文科技构建高质量多轮对话数据库,赋能AI交互新飞跃

近年来&#xff0c;大语言模型的发展极大推动了自然语言处理领域的进步&#xff0c;大语言模型正引领智能对话领域进入一个全新时代&#xff0c;不仅提升了对话体验的自然度和效率&#xff0c;也为探索更加人性化、智能化的交互方式开辟了道路。 景联文科技作为大语言模型数据服…

文心一言 VS 讯飞星火 VS chatgpt (285)-- 算法导论21.2 4题

四、请给出图 21-3 所示操作序列的一个运行时间的渐近紧确界&#xff0c;假定使用链表表示和加权合并启发式策略。如果要写代码&#xff0c;请用go语言。 文心一言&#xff1a; 图 21-3 没有直接给出&#xff0c;但通常这种操作序列可能与某种数据结构&#xff08;如并查集或…

算法:分治(归并)题目练习

目录 题目一&#xff1a;排序数组 题目二&#xff1a;数组中的逆序对 题目三&#xff1a;计算右侧小于当前元素的个数 题目四&#xff1a;翻转对 题目一&#xff1a;排序数组 给你一个整数数组 nums&#xff0c;请你将该数组升序排列。 示例 1&#xff1a; 输入&#xf…

收银系统源码推荐收银系统二次开发

千呼新零售收银系统是一套线下线上一体化的收银系统&#xff0c;给商户提供了含有线下收银/称重、线上小程序商城、精细化会员管理、ERP进销存、营销活动、移动店务管理等一体化解决方案&#xff01; 1. 多样化线下收银 线下收银支持Windows收银、安卓收银、智能称重收银、无人…

BFS:FloodFill算法

文章目录 FloodFill算法简介1.图像渲染2.岛屿数量3.岛屿的最大面积4.被围绕的区域总结 FloodFill算法简介 Flood Fill算法是一种用于确定与某个给定节点相连的区域的算法&#xff0c;常用于计算机图形学和图像处理。该算法可以用于诸如填充多边形、检测连通区域等任务。Flood …

Linux 一键部署 Nginx1.26.1 + ModSecurity3

前言 ModSecurity 是 Apache 基金会的一个开源、高性能的 Web 应用程序防火墙(WAF),它提供了强大的安全规则引擎,用于检测和阻止各种攻击行为,如 SQL 注入、XSS 跨站点脚本攻击等。而 nginx 是一个高性能的 Web 服务器,常用于处理大量的并发请求,具有很高的负载均衡能力…

蓝牙数传芯片TD5325A,蓝牙5.1—拓达半导体

拓达TD5325A芯片是一款支持蓝牙BLE&SPP的纯数传芯片&#xff0c;蓝牙5.1版本。芯片的亮点在于性能强&#xff0c;支持APP端直接对芯片做设置与查询操作&#xff0c;包括修改蓝牙名、UUID、MAC地址&#xff0c;以及直接操作蓝牙芯片自身的IO与PWM口&#xff0c;还包括支持简…

Linux:用户账号和权限管理的命令

目录 一、Linux用户的分类和组的分类 1.1、用户账号和组账号 1.2、用户的分类 1.3、组账号 1.4、用户账号文件/etc/passwd 二、用户管理相关命令 2.1、chage命令&#xff1a;用来修改帐号和密码的有效期限&#xff0c;针对目前系统已经存在的用户 2.2、useradd&#xf…

行车记录仪文件夹“0字节”现象解析与恢复策略

一、行车记录仪文件夹“0字节”现象描述 行车记录仪作为现代驾驶中的必备设备&#xff0c;其储存的视频数据对于事故记录和取证至关重要。然而&#xff0c;有时车主们可能会遇到这样一个问题&#xff1a;行车记录仪的某个文件夹内的文件突然变成了0字节大小&#xff0c;无法正…