SpringBoot之自定义Schema扩展方式

更新时间：2021年09月26日 11:33:34 作者：G-罗

这篇文章主要介绍了SpringBoot之自定义Schema扩展方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

SpringBoot 自定义Schema扩展

最近在写RPC框架时，用到了自定义的xsd配置。我们平时习惯于使用bean配置实例化对象，因此把xsd这种方式单独拎出来。

1. 配置ServiceConfig属性

@Data
public class ServiceConfig {
    /** 接口 */
    private String interfaceClass;
 
    /** 引用 */
    private String ref;
 
    /** 版本 */
    private String version;
 
    @Override
    public String toString() {
        return "ServiceConfig{" +
                "interfaceClass='" + interfaceClass + '\'' +
                ", ref='" + ref + '\'' +
                ", version='" + version + '\'' +
                '}';
    }
}

2. 编写XSD文件

配置element的name为service，配置的attribute对应ServiceConfig定义的属性

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns="http://gitee.com/schema/link"
                xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                xmlns:beans="http://www.springframework.org/schema/beans"
                targetNamespace="http://gitee.com/schema/link"
                elementFormDefault="qualified">
    <xsd:import namespace="http://www.springframework.org/schema/beans" />
    <xsd:import namespace="http://www.springframework.org/schema/tool" />
 
    <xsd:element name="service">
        <xsd:complexType>
            <xsd:complexContent>
                <xsd:extension base="beans:identifiedType">
                    <xsd:attribute name="ref" type="xsd:string" use="required">
                        <xsd:annotation>
                            <xsd:documentation><![CDATA[ 服务接口实现类]]></xsd:documentation>
                        </xsd:annotation>
                    </xsd:attribute>
                    <xsd:attribute name="interfaceClass" type="xsd:string" use="required">
                        <xsd:annotation>
                            <xsd:documentation><![CDATA[服务接口]]></xsd:documentation>
                        </xsd:annotation>
                    </xsd:attribute>
                    <xsd:attribute name="version" type="xsd:string" />
                </xsd:extension>
            </xsd:complexContent>
        </xsd:complexType>
    </xsd:element>
</xsd:schema>

3. 编写NamespaceHandler

registerBeanDefinitionParser方法的key是xsd配置的element的name，表示service元素由LinkServiceBeanDefinitionParser对象解析

public class LinkNamespaceHandler extends NamespaceHandlerSupport {
    @Override
    public void init() {
        this.registerBeanDefinitionParser("service", new LinkServiceBeanDefinitionParser());
    }
}

4. 编写BeanDefinitionParser

从element中解析出属性，注册到BeanDefinitionBuilder

public class LinkServiceBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {
    @Override
    protected Class getBeanClass(Element element) {
        return ServiceConfig.class;
    } 
    @Override
    protected void doParse(Element element, BeanDefinitionBuilder bean) {
        bean.addPropertyValue("ref", element.getAttribute("ref"));
        bean.addPropertyValue("interfaceClass", element.getAttribute("interfaceClass"));
        bean.addPropertyValue("version", element.getAttribute("version"));
    }
}

5. 配置spring.handlers和spring.schemas

http\://gitee.com/schema/link=com.test.xsd.handler.LinkNamespaceHandler
http\://gitee.com/schema/link/link.xsd=META-INF/link.xsd

6. 配置spring的加载文件

在文件头部需要引入link的schema

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:link="http://gitee.com/schema/link"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://gitee.com/schema/link http://gitee.com/schema/link/link.xsd">
 
    <!-- rpc服务 -->
    <link:service id="serviceConfig"
                  ref="helloService"
                  interfaceClass="com.test.service.HelloService"
                  version="1.0.0"/>
</beans>

7. 测试

public class App {
 public static void main(String[] args) {
  ApplicationContext context = new ClassPathXmlApplicationContext("link-server.xml");
  ServiceConfig config = (ServiceConfig) context.getBean("serviceConfig");
  System.out.println(config.toString());
 }
}

Spring Schema扩展机制

1. 概述

Spring2.0开始,Spring提供XML Schema可扩展机制,用户可以自定义XML Schema文件,并自定义

XML Bean解析器，集成到Spring IOC容器中。

2. 步骤

创建一个XML Schema文件,描述自定义的合法构建模块,也就是xsd文件。

自定义处理器类,并实现NamespaceHandler接口。

自定义一个或者多个解析器,实现BeanDefinitionParser接口(关键部分)。

注册上面的组建到Spring IOC容器。

3. 示例如下

(1) 自定义XML Schema文件

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns="http://www.liuenyuan.com/schema/myns"
            xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            xmlns:beans="http://www.springframework.org/schema/beans"
            targetNamespace="http://www.liuenyuan.com/schema/myns"
            elementFormDefault="qualified">
    <xsd:import namespace="http://www.springframework.org/schema/beans"/>

    <xsd:element name="dateFormat">
        <xsd:complexType>
            <xsd:complexContent>
                <xsd:extension base="beans:identifiedType">
                    <xsd:attribute name="pattern" type="xsd:string" use="required"/>
                </xsd:extension>
            </xsd:complexContent>
        </xsd:complexType>
    </xsd:element>
</xsd:schema>

自定义targetNamespace是http://www.liuenyuan.com/schema/myns,xmlns与命名空间必须一致。

(2) 自定义NamespaceHandler

NamespaceHandler接口只有三个方法

init():在NamespaceHandler被使用之前调用,完成初始化
parse():解析元素
decorate():嵌套元素时候调用

Spring提供一个默认实现类NamespaceHandlerSupport,注入每个元素的解析器即可。

用到了代理委托概念。NamespaceHandlerSupport可以注册任意个BeanDefinitionParser,负责所有自定义元素编排,实际XML解析工作委托给各个BeanDefinitioParser负责。

(3) 自定义BeanDefinitionParser

BeanDefinitionParser 将被调用,如果NamespapceHandler遇到元素类型已经有对应注册的parser(例如上面的handler如果遇到dateformat，DateformatDefinitionParser会被调用，

解析相应的属性设置到Bean中)将会被调用。BeanDefinitionParser负责解析一个顶级元素。

Spring提供AbstractSingleBeanDefinitionParser处理繁重的解析工作。

getBeanClass():返回元素Class类型
doParse():添加元素属性或者构造参数

(4) 注册handler和schema

把实现的NamespaceHandler和xsd文件配置到指定的配置文件中。位于META-INF目录中。

spring.handlers文件包含xml schema uri和Handler类映射关系。

http\://www.liuenyuan.com/schema/myns=\
  com.ley.springboot.schema.xml.MynsNamespaceHandler

遇到http\://www.liuenyuan.com/schema/myns命名空间的时候会交给MynsNamespaceHandler来处理,key部分必须和xsd文件中的targetNamespace值保持一致

spring.schemas文件包含xml schema xsd文件命名空间和文件路径映射关系。

http\://www.liuenyuan.com/schema/myns.xsd=META-INF/myns.xsd

(5) 测试

NamespaceHandler实现类

public class MynsNamespaceHandler extends NamespaceHandlerSupport {
    @Override
    public void init() {
        registerBeanDefinitionParser("dateFormat", new MynsBeanDefinitionParser());
    }
}

BeaDefinitionParser实现类

import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
import org.w3c.dom.Element;
import java.text.SimpleDateFormat;
public class MynsBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {
    @Override
    protected Class<?> getBeanClass(Element element) {
        return SimpleDateFormat.class;
    }

    @Override
    protected void doParse(Element element, BeanDefinitionBuilder builder) {
        String pattern = element.getAttribute("pattern");
        builder.addConstructorArgValue(pattern);
    }
}

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

Java中内存问题之OOM详解
这篇文章主要介绍了Java中内存管理的OOM详解,OOM,全称“Out Of Memory”,翻译成中文就是“内存用完了”,来源于java.lang.OutOfMemoryError,当JVM因为没有足够的内存来为对象分配空间并且垃圾回收器也已经没有空间可回收时,就会抛出这个error,需要的朋友可以参考下
2023-08-08
Java如何优雅替换if-else语句
当逻辑分支非常多的时候，if-else套了一层又一层，那么如何干掉过多的if-else，本文就详细的介绍一下，感兴趣的小伙伴们可以参考一下
2021-08-08
java8 stream 操作map根据key或者value排序的实现
这篇文章主要介绍了java8 stream 操作map根据key或者value排序的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-09-09
SpringBoot中打war包需要注意事项
这篇文章主要介绍了SpringBoot中打war包需要注意事项，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-09-09
java实现银行管理系统
这篇文章主要为大家详细介绍了java实现银行管理系统，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-12-12
基于Java实现简单的邮件群发功能
这篇文章主要为大家详细介绍了如何利用Java语言编写一个简单的工具类，可以实现邮件群发功能。文中的示例代码讲解详细，需要的可以参考一下
2022-05-05
spring boot 注册拦截器过程详解
这篇文章主要介绍了spring boot中注册拦截器过程详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-11-11
Java版坦克大战游戏源码示例
本篇文章主要介绍了Java版坦克大战游戏源码示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-10-10
springboot+mybatis+枚举处理器的实现
在Spring boot项目开发中经常遇到需要使用枚举的场景，本文就介绍了springboot+mybatis+枚举处理器的实现，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-03-03
spring声明式事务 @Transactional 不回滚的多种情况以及解决方案
本文主要介绍了spring声明式事务 @Transactional 不回滚的多种情况以及解决方案，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-11-11