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.rhkb.cn/news/355518.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

SpringBoot 实现RequestBodyAdvice封装统一接受类功能

一、相关往期文章 SpringBootVue实现AOP系统日志功能_aop的vue完整项目 Spring AOP (面向切面编程&#xff09;原理与代理模式—实例演示_面向切面aop原理详解 二、需求分析 按照一般情况&#xff0c;统一接受类可以像以下的方式进行处理&#xff1a; 如果不想使用 Request…

Shiro721 反序列化漏洞(CVE-2019-12422)

目录 Shiro550和Shiro721的区别 判断是否存在漏洞 漏洞环境搭建 漏洞利用 利用Shiro检测工具 利用Shiro综综合利用工具 这一篇还是参考别的师傅的好文章学习Shiro的反序列化漏洞 上一篇也是Shiro的反序列化漏洞&#xff0c;不同的是一个是550一个是721&#xff0c;那么这…

【vue scrollTo 数据无限滚动 】

vue数据无限滚动 参考来源 Vue3 实现消息无限滚动的新思路 —— 林三心不学挖掘机 vue3代码 <template><div class"scroll-container" ref"scrollRef"><div v-for"(item, index) in list" :key"index" style"hei…

网络协议安全:TCP/IP协议栈的安全问题和解决方案

「作者简介」:北京冬奥会网络安全中国代表队,CSDN Top100,就职奇安信多年,以实战工作为基础对安全知识体系进行总结与归纳,著作适用于快速入门的 《网络安全自学教程》,内容涵盖Web安全、系统安全等12个知识域的一百多个知识点,持续更新。 这一章节我们需要知道TCP/IP每…

【Git】--Part3--远程操作 配置 标签管理

1. 远程仓库 Git 是分布式版本控制系统&#xff0c;同⼀个 Git 仓库&#xff0c;可以分布到不同的机器上。怎么分布呢&#xff1f; 最早&#xff0c;肯定只有⼀台机器有⼀个原始版本库&#xff0c;此后&#xff0c;别的机器可以 “克隆” 这个原始版本库&#xff0c;⽽且每台机…

JavaSE 面向对象程序设计初级 静态static 包package 常量final 代码块 代码实操理论内存原理详解

目录 static(静态) 静态的特点 应用示例 静态变量 静态方法 注意事项 内存图 重新认识main方法 包 什么是包 使用导包在什么时候 final关键字 常量 命名规范 细节&#xff08;重点&#xff09; 权限修饰符 代码块 局部代码块 构造代码块 静态代码块 个人号…

vue中实现百度地图全国与省市地图切换

前言 本文主要是用于示例全国地图&#xff0c;点击省市地图直接跳转到该省市地图并展示&#xff0c;可以拓展在地图上显示标记点&#xff08;本文未做示例&#xff09;&#xff0c;后续有完整代码&#xff0c;但是由于需要与本来项目业务代码进项分割&#xff0c;可能会有些问题…

多模态大模型面对误导性问题:看懂图片也会答错,一骗就中招

多模态大语言模型&#xff08;MLLMs&#xff09;因其在视觉理解和推理方面的突出表现&#xff0c;例如生成详细的图像描述和回答复杂的问题等&#xff0c;逐渐成为近期AI研究的热点。 然而&#xff0c;Bunny 团队的最新研究发现&#xff0c;尽管许多MLLMs对视觉内容能够正确理…

RocketMQ快速入门:集成spring, springboot实现各类消息消费(七)附带源码

0. 引言 rocketmq支持两种消费模式&#xff1a;pull和push&#xff0c;在实际开发中这两种模式分别是如何实现的呢&#xff0c;在spring框架和springboot框架中集成有什么差异&#xff1f;今天我们一起来探究这两个问题。 1. java client实现消息消费 1、添加依赖 <depen…

方舟云康亏损收窄:三年近10亿销售成本,平均付费及月活仍大幅承压

《港湾商业观察》施子夫 三度递表后&#xff0c;终于通过聆讯&#xff0c;方舟云康控股有限公司(以下简称&#xff0c;方舟云康)有望近期内挂牌港交所。方舟云康的国内运营主体为广州方舟云康信息科技集团有限公司、广州方舟医药有限公司。 值得关注的是&#xff0c;亏损的难…

Python日志管理利器:如何高效管理平台日志

一、为什么需要日志管理&#xff1f; 日志是应用程序的重要组成部分&#xff0c;它记录了应用程序的运行状态、错误信息以及用户交互等关键信息。良好的日志管理可以帮助开发人员及时发现和解决问题&#xff0c;提高应用程序的稳定性和可靠性。 项目在本地开发调试时&#xf…

vscode字符多行自动增长插件。

多行字符自动增长插件CharAutoIncre 当你使用shiftalt选中了多行,并输入了’1’,这时这几行都变成了’1’. 这时你可以选中&#xff08;shift左键&#xff09;为’1’的这几行, 接下来按下shiftaltq此时’1’变为了’12345’自增长的样式。 同时本插件支持字符’a-z,A-Z’。 目…

【知识图谱】基于neo4j开发的信息化文档分析系统(源码)

一、项目介绍 一款全源码&#xff0c;可二开&#xff0c;可基于云部署、私有部署的企业级知识库云平台&#xff0c;一款让企业知识变为实打实的数字财富的系统&#xff0c;应用在需要进行文档整理、分类、归集、检索、分析的场景。 为什么建立知识库平台&#xff1f; 助力企业…

IDEA中 pom.xml 设置自动提示

IDEA中 pom.xml 自动提示 IDEA中 pom.xml 自动提示设置如下&#xff1a; file–>Settings–>Build,Execution…–>Build Tools–>Maven–>Repositories 会看到类似表格的画面&#xff0c;内容是你的maven地址&#xff0c;选中后&#xff0c;右边有个Update的按…

Python酷库之旅-第三方库openpyxl(01)

目录 一、 openpyxl库的由来 1、背景 2、起源 3、发展 4、特点 4-1、支持.xlsx格式 4-2、读写Excel文件 4-3、操作单元格 4-4、创建和修改工作表 4-5、样式设置 4-6、图表和公式 4-7、支持数字和日期格式 二、openpyxl库的优缺点 1、优点 1-1、支持现代Excel格式…

鄂州职业大学2024年成人高等继续教育招生简章

鄂州职业大学&#xff0c;作为一所享有盛誉的高等学府&#xff0c;一直以来都致力于为社会培养具备专业技能和良好素养的优秀人才。在成人高等继续教育领域&#xff0c;该校同样表现出色&#xff0c;为广大渴望继续深造、提升自身能力的成年人提供了宝贵的学习机会。 随着社会…

椭圆的矩阵表示法

椭圆的矩阵表示法 flyfish 1. 标准几何表示法 标准几何表示法是通过椭圆的几何定义来表示的&#xff1a; x 2 a 2 y 2 b 2 1 \frac{x^2}{a^2} \frac{y^2}{b^2} 1 a2x2​b2y2​1其中&#xff0c; a a a 是椭圆的长半轴长度&#xff0c; b b b 是椭圆的短半轴长度。 2.…

一文带你全面详细了解安全运维

一、安全运维-网络 1、IP地址相关 IP地址属于网络层地址&#xff0c;用于标识网络中的节点设备。 IP地址由32bit构成&#xff0c;每8bit一组&#xff0c;共占用4个字节。 IP地址由两部分组成&#xff0c;网络位和主机位。 IP地址分类&#xff1a; 类别网络位子网掩码私有地…

云原生Kubernetes系列项目实战-k8s集群+高可用负载均衡层+防火墙

一、Kubernetes 区域可采用 Kubeadm 方式进行安装&#xff1a; 名称主机部署服务master192.168.91.10docker、kubeadm、kubelet、kubectl、flannelnode01192.168.91.11docker、kubeadm、kubelet、kubectl、flannelnode02192.168.91.20docker、kubeadm、kubelet、kubectl、flan…

Linux 一键部署 Nginx1.26.1 + ModSecurity3

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