Spring XML Schema扩展机制的使用示例

更新时间：2021年05月31日 11:33:52 作者：@希望就在前方

所谓整合，即在Spring的框架下进行扩展，让框架能无缝的与Spring工程配合使用。Spring设计了良好的扩展的机制，本文将对Spring的扩展方法及原理进行简单介绍。

前言

在当前Java生态，Spring算的上是最核心的框架，所有的开发组件想要得到大范围更便捷的使用，都要和Spring进行整合，比如我们熟知的Mybatis、Dubbo等，以及内部封装的各类组件包括Redis、MQ、配置中心等。

有了整合这一步，我们只需引入相应的jar，比如mybatis-spring，然后进行简单的配置后即可在Spring工程中使用Mybatis的功能，也正是由于这样的便捷性，导致很多时候我们没有对其进行深究。

XML Schema扩展

打开mybatis-spring、dubbo的源码会发现在META-INF目录下有两个文件（如下图所示），spring.handlers与spring.schemas，这两个文件就是XML Schema扩展的关键入口点。

XSD

XSD，XML Schema Definition，XML定义。

XML Schema定义XML文档的结构，XML Schema语言也称为XML定义，即XSD。

简单的说，XSD用于制定xml文件规范，包括xml中的元素（简单元素、复杂元素）、属性、以及属性类型及约束等。

Spring XML Schema扩展的第一步就是要定义一个xsd文件，比如spring-beans对应xsd文件为http://www.springframework.org/schema/beans/spring-beans.xsd，如下图：

为了简单介绍Spring XML Schema扩展实现，下面将一个简单例子（模拟一个简单的分布式id生成器，不会实现具体功能）进行说明，xsd定义如下（文件命名为DistributedId.xsd，在META-INF目录下）：

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns="http://www.hexup.com/schema/distributed-id"
            xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.hexup.com/schema/distributed-id">


    <xsd:element name="distributed-id">
        <xsd:complexType>
            <xsd:attribute name="id" type="xsd:string"></xsd:attribute>
            <xsd:attribute name="bizCode" type="xsd:string"></xsd:attribute>
            <xsd:attribute name="length" type="xsd:int"></xsd:attribute>
        </xsd:complexType>
    </xsd:element>
            
</xsd:schema>

上述xsd文件里定义了一个复杂元素distributed-id，包含属性id，bizCode，length，形如：

<distributed-id id="xxx" bizCode="xxx" length="xxx"></distributed-id>

注意：xmlns，即为xml namespace，xml命名空间，后面跟的http链接地址可以不存在，因为xsd会放在当前工程的META-INF下。

配置spring.handlers和spring.schemas

如下两张图所示，spring.schemas文件中用于说明xsd的文件路径，spring.schemas文件用于说明解析此类xsd定义的标签的处理类，下面会对处理类进行详细说明。

NameSpaceHandler与BeanDefinitionParser

定义类DistributedIdNamespaceHandler继承NamespaceHandlerSupport，init方法用于注册BeanDefinition解析器，也就是解析xml中对应标签为Spring Bean。

public class DistributedIdNamespaceHandler extends NamespaceHandlerSupport {

    @Override
    public void init() {
        registerBeanDefinitionParser("distributed-id", new DistributedIdParser());
    }
}

同时要创建BeanDefinitionParser

public class DistributedIdParser implements BeanDefinitionParser {


    @Override
    public BeanDefinition parse(Element element, ParserContext parserContext) {
        // 解析xml内的标签
        String bizCode = element.getAttribute("bizCode");
        int length = Integer.valueOf(element.getAttribute("length"));
        String id = element.getAttribute("id");
        
        // 创建DistributedIdFactoryBean bean
        BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition();
        builder.getRawBeanDefinition().setBeanClass(DistributedIdFactoryBean.class);
        builder.setScope(BeanDefinition.SCOPE_SINGLETON);

        builder.addPropertyValue("bizCode", bizCode);
        builder.addPropertyValue("length", length);

        BeanDefinition beanDefinition = builder.getBeanDefinition();

        parserContext.getRegistry().registerBeanDefinition(id, beanDefinition);

        return beanDefinition;
    }
}

其中DistributedIdFactoryBean实现FactoryBean接口用于创建DistributedIdComponent Bean，如下

public class DistributedIdFactoryBean implements InitializingBean, FactoryBean<DistributedIdComponent> {

    private String bizCode;
    private int length;

    private DistributedIdComponent distributedIdComponent;

    @Override
    public DistributedIdComponent getObject() throws Exception {
        return distributedIdComponent;
    }

    @Override
    public Class<?> getObjectType() {
        return DistributedIdComponent.class;
    }

    @Override
    public boolean isSingleton() {
        return false;
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        distributedIdComponent = new DistributedIdComponent(bizCode, length);
    }

    public void setBizCode(String bizCode) {
        this.bizCode = bizCode;
    }

    public void setLength(int length) {
        this.length = length;
    }
}

目标Bean DistributedIdComponent如下：

public class DistributedIdComponent {
    private String bizCode;
    private int length;

    public DistributedIdComponent() {

    }

    public DistributedIdComponent(String bizCode, int length) {
        this.bizCode = bizCode;
        this.length = length;
    }

    public String generateId() {
        System.out.println("mock generate id");
        return String.valueOf(System.currentTimeMillis()).substring(0, length);
    }

    public String getBizCode() {
        return bizCode;
    }

    public void setBizCode(String bizCode) {
        this.bizCode = bizCode;
    }

    public int getLength() {
        return length;
    }

    public void setLength(int length) {
        this.length = length;
    }
}

使用

spring配置文件，spring-service.xml中配置distributed-id标签以及对应的属性值，如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:distributed-id="http://www.hexup.com/schema/distributed-id"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd http://www.hexup.com/schema/distributed-id http://www.hexup.com/schema/distributed-id.xsd">


    <distributed-id:distributed-id id="test" bizCode="test" length="8"></distributed-id:distributed-id>
</beans>

运行容器验证：

public class App {
    public static void main(String[] args) {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("spring-service.xml");
        DistributedIdComponent bean = context.getBean(DistributedIdComponent.class);

        String id = bean.generateId();

        System.out.println("id:" + id);
    }
}

总结

本文主要介绍了Spring XML Schema扩展机制的使用方法，大致步骤为定义XSD文件、配置spring.schemas、编码实现NameSpaceHanlder和BeanDefinitionParser实现类、配置spring.handlers。但未说明具体的实现原理，后续会有一篇文章详细介绍Spring源码是怎么实现扩展的，以及介绍为什么使用FactoryBean来创建具体的Bean等问题。

以上就是Spring XML Schema扩展机制的使用示例的详细内容，更多关于Spring XML Schema扩展机制的使用的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

IOC 容器启动和Bean实例化两个阶段详解
这篇文章主要为大家介绍了IOC 容器启动和Bean实例化两个阶段详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-08-08
springmvc组件中的HandlerMapping解析
这篇文章主要介绍了springmvc九大组件中的HandlerMapping解析,HandlerMapping表示的是一个URL与一个Handler(可以简单的理解为Controller中有@RequestMapping注解的方法)之间的映射关系,需要的朋友可以参考下
2023-09-09
Java HttpClient-Restful工具各种请求高度封装提炼及总结
这篇文章主要介绍了Java HttpClient-Restful工具各种请求高度封装提炼及总结，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-10-10
SpringMVC4.3解析器HandlerMethodArgumentResolver接口源码
这篇文章主要为大家介绍了SpringMVC4.3解析器HandlerMethodArgumentResolver接口源码解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-09-09
Java如何将字符串String转换为整型Int
这篇文章主要介绍了Java如何将字符串String转换为整型Int，文章围绕主题展开详细的内容介绍，具有一定的参考价值，需要的朋友可以参考一下
2022-08-08
解读JDK8踩坑JCE加密限制版本问题
这篇文章主要介绍了JDK8踩坑JCE加密限制版本问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-05-05
浅谈spring boot 1.5.4 异常控制
下面小编就为大家带来一篇浅谈spring boot 1.5.4 异常控制。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-06-06
Spring Security实现基于角色的访问控制框架
Spring Security是一个功能强大的安全框架，提供了基于角色的访问控制、身份验证、授权等安全功能，可轻松保护Web应用程序的安全，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧
2023-04-04
Feign自定义重试策略及超时时间详解
这篇文章主要为大家介绍了Feign自定义重试策略及超时时间详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-07-07
Java String字符串补0或空格的实现代码
这篇文章主要介绍了Java String字符串补0或空格的实现代码，代码简单易懂，非常不错，具有参考借鉴价值，感兴趣的朋友一起看看吧
2016-09-09