Spring 可扩展XML配置机制实践

最新推荐文章于 2024-07-25 16:33:30 发布
最新推荐文章于 2024-07-25 16:33:30 发布
阅读量3.4k 收藏 1
点赞数 1
分类专栏： Spring Framework 文章标签： spring 扩展xml 自定义xml标签
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/top_code/article/details/53289817
版权
本文介绍了如何在Spring框架中实现XML配置的扩展，通过定义XML Schema、解析器和NamespaceHandler，创建自定义的XML标签，使得Spring能够解析并管理这些自定义组件。示例中展示了类似于dubbo的自定义标签过程，包括环境配置、每个步骤的详细操作以及最终在Spring配置文件中的应用。
摘要由CSDN通过智能技术生成

用过dubbo的同学应该很熟悉下面的配置：

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
    http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd">
    <!-- 提供方应用信息，用于计算依赖关系 -->
    <dubbo:application name="hello-world-app"  />

    <!-- 使用zk为注册中心暴露服务地址 -->
    <dubbo:registry address="zookeeper://127.0.0.1:2181" />

    <!-- 用dubbo协议在20880端口暴露服务 -->
    <dubbo:protocol name="dubbo" port="20880" />

    <bean id="demoService" class="com.alibaba.dubbo.demo.provider.DemoServiceImpl" />

    <dubbo:service interface="com.alibaba.dubbo.demo.DemoService" ref="demoService" />

</beans>

我们通过 dubbo:service 对外提供RPC服务，一切都司空见惯。但你有没有想过dubbo:service 到底是什么？Spring是怎么解析它并把它注入到容器中的？

本文着重介绍Spring Framework 基于Schema风格的XML扩展机制，通过Spring提供的xml扩展机制，我们可以在spring.xml中加入自己的标签，之后Spring会帮我们解析并纳入自己的管理范围内。

环境配置

JDK 1.7
Spring 4.3.3.RELEASE
Maven 3.3
IDEA 15

示例

通过学习 Spring Extensible XML ，自己写了一个类似dubbo 自定义标签的demo样例供大家学习，工程结构如下图所示：
这里写图片描述

最后，我们也可以在Spring配置文件引入我们自定义的标签了，如下：

<?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:context="http://www.springframework.org/schema/context"
       xmlns:rpc="http://www.bytebeats.com/schema/rpc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd
        http://www.bytebeats.com/schema/rpc http://www.bytebeats.com/schema/rpc/rpc.xsd">

    <rpc:registry id="zk" protocol="zookeeper" address="127.0.0.1" />
    <rpc:protocol id="hessian" name="hessian" port="9001"/>

    <rpc:service id="rpcService" ref="helloService" interface="com.bytebeats.spring4.extension.service.IHelloService" timeout="5000" retries="1"></rpc:service>

    <rpc:ref id="accountService" interface="com.bytebeats.spring4.extension.service.IAccountService" retries="0" check="false" />

    <bean id="helloService" class="com.bytebeats.spring4.extension.service.impl.HelloServiceImpl" />

</beans>
1、定义XML schema

首先，我们需要定义一个xsd文件来声明XML标签元素，本文中为rpc.xsd，如下：

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns="http://www.bytebeats.com/schema/rpc"
            xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            xmlns:beans="http://www.springframework.org/schema/beans"
            targetNamespace="http://www.bytebeats.com/schema/rpc"
            elementFormDefault="qualified"
            attributeFormDefault="unqualified">

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

    <xsd:complexType name="abstractConfig">
        <xsd:choice minOccurs="0" maxOccurs="unbounded">
            <xsd:element ref="beans:property" minOccurs="0" maxOccurs="unbounded" />
        </xsd:choice>
        <xsd:anyAttribute namespace="##other" processContents="lax" />
    </xsd:complexType>

    <xsd:element name="service">
        <xsd:complexType>
            <xsd:complexContent>
                <xsd:extension base="abstractConfig">
                    <xsd:choice minOccurs="0" maxOccurs="unbounded">
                        <xsd:element ref="beans:property" minOccurs="0" maxOccurs="unbounded" />
                    </xsd:choice>
                    <xsd:attribute name="id" type="xsd:ID" />
                    <xsd:attribute name="ref" type="xsd:string" use="required"/>
                    <xsd:attribute name="interface" type="xsd:string" use="required"/>
                    <xsd:attribute name="group" type="xsd:string" use="optional"/>
                    <xsd:attribute name="registry" type="xsd:string" use="optional"/>
                    <xsd:attribute name="version" type="xsd:string" use="optional"/>
                    <xsd:attribute name="timeout" type="xsd:string" use="optional"/>
                    <xsd:attribute name="retries" type="xsd:string" use="optional"/>
                    <xsd:attribute name="async" type="xsd:boolean" use="optional"/>
                </xsd:extension>
            </xsd:complexContent>
        </xsd:complexType>
    </xsd:element>

    <xsd:element name="ref">
        <xsd:complexType>
            <xsd:complexContent>
                <xsd:extension base="abstractConfig">
                    <xsd:choice minOccurs="0" maxOccurs="unbounded">
                        <xsd:element ref="beans:property" minOccurs="0" maxOccurs="unbounded" />
                    </xsd:choice>
                    <xsd:attribute name="id" type="xsd:ID" />
                    <xsd:attribute name="interface" type="xsd:string" use="required"/>
                    <xsd:attribute name="group" type="xsd:string" use="optional"/>
                    <xsd:attribute name="registry" type="xsd:string" use="optional"/>
                    <xsd:attribute name="version" type="xsd:string" use="optional"/>
                    <xsd:attribute name="timeout" type="xsd:string" use="optional"/>
                    <xsd:attribute name="retries" type="xsd:string" use="optional"/>
                    <xsd:attribute name="async" type="xsd:boolean" use="optional"/>
                    <xsd:attribute name="check" type="xsd:boolean" use="optional"/>
                </xsd:extension>
            </xsd:complexContent>
        </xsd:complexType>
    </xsd:element>

    <xsd:element name="registry">
        <xsd:complexType>
            <xsd:complexContent>
                <xsd:extension base="abstractConfig">
                    <xsd:choice minOccurs="0" maxOccurs="unbounded">
                        <xsd:element ref="beans:property" minOccurs="0" maxOccurs="unbounded" />
                    </xsd:choice>
                    <xsd:attribute name="id" type="xsd:ID" />
                    <xsd:attribute name="protocol" type="xsd:string" use="required"/>
                    <xsd:attribute name="address" type="xsd:string" use="required"/>
                    <xsd:attribute name="username" type="xsd:string" use="optional"/>
                    <xsd:attribute name="password" type="xsd:string" use="optional"/>
                    <xsd:attribute name="check" type="xsd:boolean" use="optional"/>
                </xsd:extension>
            </xsd:complexContent>
        </xsd:complexType>
    </xsd:element>

    <xsd:element name="protocol">
        <xsd:complexType>
            <xsd:complexContent>
                <xsd:extension base="abstractConfig">
                    <xsd:choice minOccurs="0" maxOccurs="unbounded">
                        <xsd:element ref="beans:property" minOccurs="0" maxOccurs="unbounded" />
                    </xsd:choice>
                    <xsd:attribute name="id" type="xsd:ID" />
                    <xsd:attribute name="name" type="xsd:string" use="required"/>
                    <xsd:attribute name="port" type="xsd:string" use="required"/>
                    <xsd:attribute name="host" type="xsd:string" use="optional"/>
                </xsd:extension>
            </xsd:complexContent>
        </xsd:complexType>
    </xsd:element>

</xsd:schema>

关于XML Schema这里不详述了，大家可以参考 w3school XML Schema 简介

2、定义解析器

定义一个BeanDefinitionParser负责解析xml，如下：

package com.bytebeats.spring4.extension.xml;

import com.bytebeats.spring4.extension.domain.RpcServiceBean;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.AbstractBeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.util.StringUtils;
import org.w3c.dom.Element;

/**
 * ${DESCRIPTION}
 *
 * @author Ricky Fung
 * @create 2016-11-23 11:50
 */
public class RpcServiceBeanDefinitionParser extends AbstractBeanDefinitionParser {

    @Override
    protected AbstractBeanDefinition parseInternal(Element element, ParserContext parserContext) {

        return parseComponet(element, parserContext);
    }

    private AbstractBeanDefinition parseComponet(Element element, ParserContext parserContext) {

        BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(RpcServiceBean.class);

        String id = element.getAttribute("id");
        if (StringUtils.hasText(id)) {
            builder.addPropertyValue("id", id);
        }

        String ref = element.getAttribute("ref");
        builder.addPropertyValue("ref", ref);

        String interfaceName = element.getAttribute("interface");
        builder.addPropertyValue("interfaceName", interfaceName);

        String group = element.getAttribute("group");
        if (StringUtils.hasText(group)) {
            builder.addPropertyValue("group", group);
        }

        String registry = element.getAttribute("registry");
        if (StringUtils.hasText(registry)) {
            builder.addPropertyValue("registry", registry);
        }

        String version = element.getAttribute("version");
        if (StringUtils.hasText(version)) {
            builder.addPropertyValue("version", version);
        }

        String timeout = element.getAttribute("timeout");
        if (StringUtils.hasText(timeout)) {
            builder.addPropertyValue("timeout", Integer.parseInt(timeout));
        }

        String retries = element.getAttribute("retries");
        if (StringUtils.hasText(retries)) {
            builder.addPropertyValue("retries", Integer.parseInt(retries));
        }

        String async = element.getAttribute("async");
        if (StringUtils.hasText(async)) {
            builder.addPropertyValue("async", Boolean.valueOf(async));
        }

        return builder.getBeanDefinition();
    }

}
3、定义NamespaceHandler
package com.bytebeats.spring4.extension.xml;

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

/**
 * ${DESCRIPTION}
 *
 * @author Ricky Fung
 * @create 2016-11-23 11:48
 */
public class RpcNamespaceHandler extends NamespaceHandlerSupport {

    @Override
    public void init() {
        registerBeanDefinitionParser("service", new RpcServiceBeanDefinitionParser());
        registerBeanDefinitionParser("ref", new RpcReferenceBeanDefinitionParser());
        registerBeanDefinitionParser("registry", new RpcRegistryBeanDefinitionParser());
        registerBeanDefinitionParser("protocol", new RpcProtocolBeanDefinitionParser());
    }
}
4、配置schema和handler

在META-INF目录下面分别新建spring.handlers和spring.schemas文件。

spring.schemas

http\://www.bytebeats.com/schema/rpc/rpc.xsd=/META-INF/rpc.xsd

spring.handlers

http\://www.bytebeats.com/schema/rpc=com.bytebeats.spring4.extension.xml.RpcNamespaceHandler
5、使用

辛苦这么大半天，接下来该看看成果了，首先是

applicationContext.xml

<?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:context="http://www.springframework.org/schema/context"
       xmlns:rpc="http://www.bytebeats.com/schema/rpc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd
        http://www.bytebeats.com/schema/rpc http://www.bytebeats.com/schema/rpc/rpc.xsd">

    <context:annotation-config/>
    <context:component-scan base-package="com.bytebeats.spring4.extension.xml"/>

    <rpc:registry id="zk" protocol="zookeeper" address="127.0.0.1" />
    <rpc:protocol id="hessian" name="hessian" port="9001"/>

    <rpc:service id="rpcService" ref="helloService" interface="com.bytebeats.spring4.extension.service.IHelloService" timeout="5000" retries="1"></rpc:service>

    <rpc:ref id="accountService" interface="com.bytebeats.spring4.extension.service.IAccountService" retries="0" check="false" />

    <bean id="helloService" class="com.bytebeats.spring4.extension.service.impl.HelloServiceImpl" />

</beans>

只需要加入 我们自定义的命名空间 即可使用了，如下图：
这里写图片描述


从Spring 容器中获取自定义的xml标签元素，如下：

public class App {

    public static void main( String[] args ) {

        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("classpath:applicationContext.xml");

        IHelloService helloService = (IHelloService) context.getBean("helloService");
        System.out.println(helloService.sayHello("ricky"));

        RpcServiceBean rpcServiceBean = (RpcServiceBean) context.getBean("rpcService");
        System.out.println("rpcServiceBean:"+rpcServiceBean.getInterfaceName());

        RpcReferenceBean accountService = (RpcReferenceBean) context.getBean("accountService");
        System.out.println("accountService:"+accountService.getInterfaceName());

        RpcRegistryBean rpcRegistryBean = (RpcRegistryBean) context.getBean("zk");
        System.out.println("rpcRegistryBean:"+rpcRegistryBean.getAddress());

        RpcProtocolBean rpcProtocolBean = (RpcProtocolBean) context.getBean("hessian");
        System.out.println("rpcProtocolBean:"+rpcProtocolBean.getPort());

        context.close();
    }
}

点此下载源码：https://github.com/TiFG/spring4-samples/tree/master/spring-ch3-extensible

参考

Spring Extensible XML：http://docs.spring.io/spring/docs/current/spring-framework-reference/html/xml-custom.html

Ricky_Fung
关注
专栏目录
【微服务】spring读取配置文件多种方式深入详解
congge
04-21 7793
spring读取配置文件多种方式深入详解
SpringCloud Alibaba Nacos 配置中心
程序员光剑
07-29 1161
Nacos 是阿里巴巴开源的一个更易于构建云原生应用的动态服务发现、配置和管理平台。其提供简单易用、高度可扩展的服务注册和配置中心能力。服务之间相互独立，没有统一的配置中心，导致难以管理复杂的业务规则；集群部署环境下，各个节点可能存在不同步的配置信息，造成线上问题排查困难；配置修改后，无法及时更新到所有节点，导致业务不连续，影响用户体验；基于硬盘存储的配置中心效率低，对配置中心依赖的机器资源要求较高。
20190514面试SPRING扩展机制
hhcccchh的专栏
05-15 553
1.SPRING扩展机制 通过基于XML和基于Java的配置扩展，可以使用户通过Spring使用我们研发的组件，提供很好的易用性。 通过Spring容器最常用的两个扩展点：BeanFactoryPostProcessor和BeanPostProcessor，可以使我们的程序逻辑和Spring容器紧密合作，无缝插入到用户bean的生命周期中，发挥更强大的作用。 2.spring的扩展接口 1....
聊聊Spring中的那些扩展机制
lizhao007
09-20 294
前方高能预警：本文将会有大量代码出没。1.背景在看一些框架源码的时候，可以看见他们很多都会和Spring去做结合。举个例子dubbo的配置:很多人其实配置了也就配置了，没...
【Spring Framework】使用 XML 配置文件的使用方法
最新发布
u013675821的博客
07-25 443
Spring Framework 的 XML 配置提供了强大的灵活性和控制能力，尽管现代开发中更多使用注解和 Java 配置，但了解 XML 配置仍然对维护旧项目和理解 Spring 的核心机制非常有帮助。通过 XML 配置，你可以定义和管理 Spring 容器中的 bean、配置依赖注入、设置 AOP、事务管理等。
Spring可扩展的XML Schema机制
weixin_34072458的博客
10-23 71
可扩展的XML Schema机制 从Spring2.0开始，Spring提供了XML Schema可扩展机制，用户可以自定义XML Schema文件，并自定义XML Bean解析器，并集成到Spring Ioc 容器中 完成XML自定义扩展，需要下面几个步骤: 创建一个 XML Schema 文件，描述自定义的合法构建模块，也就是xsd文件 自定义个处理器类，并实现NamespaceHan...
3个月学会Java开发！Spring事务扩展机制
m0_60388216的博客
08-04 169
private static final ThreadLocal<Map<Object, Object>> resources = new NamedThreadLocal<Map<Object, Object>>("Transactional resources"); private static final ThreadLocal<Set<TransactionSynchronization>> synchron.
Spring加载XML机制
weixin_33813128的博客
04-19 80
加载文件顺序 情形一：使用classpath加载且不含通配符 这是最简单的情形，Spring默认会使用当前线程的ClassLoader的getResource方法获取资源的URL，如果无法获得当前线程的ClassLoader，Spring将使用加载类org.springframework.util.ClassUtils的ClassLoader。 1.当工程目录结构如图所示: ...
Spring Boot多模块配置文件读取
03-22
首先，了解Spring Boot的默认配置机制。Spring Boot的核心理念是简化配置，它通过`application.properties`或`application.yml`文件来存储全局配置。当项目变得复杂，包含多个模块时，这种单一配置文件的方式可能会...
SpringCloud实践系列（Nacos注册中心+Ribbon负载均衡+OpenFeign服务调+Nacos配置中心等）
06-21
- 命名服务：为服务和配置提供简洁、可扩展的命名规则。 - 健康检查：自动检测服务实例的健康状态，确保服务调用的可靠性。 1.3 Nacos注册中心工作原理 服务提供者启动时，会向Nacos注册自身的元数据信息，如服务名...
MyBatis中的Mapper文件配置——编写mybatis mapper.xml文件
程序员光剑
07-29 4873
MyBatis 是一款优秀的持久层框架，它可以使得使用 SQL 和 HQL 来操作数据库变得很简单， MyBatis 将原生的jdbc API隐藏在接口中，使开发人员更关注业务逻辑，从而方便地实现数据持久化操作。MyBatis 中最重要的组件之一就是 MyBatis 的 Mapper XML 配置文件。Mapper XML 配置文件用来描述 MyBatis 映射器接口及其对应的 SQL、SQL语句的参数类型、返回值类型等信息。
Spring容器扩展机制的实现原理
08-26
主要介绍了Spring容器扩展机制的实现原理，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
聊一聊 Spring 中的扩展机制（一）
weixin_33778778的博客
08-19 238
之前 Spring 源码系列文章中大多是底层源码的分析，通过源码可以让我们能够清晰的了解 Spring 到底是什么，而不是停留于表面的认知。比如当我们要使用 @Autowired 注解时，可以拿到我们想要的 bean ,但是为什么可以是值得思考的。-- 关于阅读源码 Spring源码的阅读结合日常的使用，可以帮助我们更好的掌握这个庞大的技术体系，实际的开发工作中有很多地方可以借鉴它的一些思想来...
Spring容器扩展机制
weixin_34238633的博客
11-29 108
IoC 容器负责管理容器中所有 bean 的生命周期, 而在 bean 生命周期的不同阶段, Spring 提供了不同的扩展点来改变 bean 的命运. 在容器的启动阶段, BeanFactoryPostProcessor 允许我们在容器实例化相应对象之前, 对注册到容器的 BeanDefinition 所保存的信息做一些额外的操作, 比...
浅谈spring扩展机制
cxhao的博客
04-22 736
1.背景 慎入：本文将会有大量代码出入。 在看一些框架源码的时候，可以看见他们很多都会和Spring去做结合。举个例子dubbo的配置: 很多人其实配置了也就配置了，没有去过多的思考:为什么这么配置spring就能识别，dubbo就能启动？ 如果你也需要做一个框架和Spring结合，或者你想知道Spring其他框架是如何和Spring做结合的，那么你应该了解一下Sprin...
聊聊spring的那些扩展机制
abc_1114的博客
09-21 134
1.背景 慎入：本文将会有大量代码出入。 在看一些框架源码的时候，可以看见他们很多都会和Spring去做结合。举个例子dubbo的配置: 很多人其实配置了也就配置了，没有去过多的思考:为什么这么配置spring就能识别，dubbo就能启动？ 如果你也需要做一个框架和Spring结合，或者你想知道Spring其他框架是如何和Spring做结合的，那么你应该...
Spring可扩展的XML Schema机制（spring实现自定义标签）
lzf的博客
05-22 990
从Spring2.0开始，Spring提供了XML Schema可扩展机制，用户可以自定义XML Schema文件，并自定义XML Bean解析器，并集成到Spring Ioc 容器中完成XML自定义扩展，需要下面几个步骤:可扩展XML Schema机制.png创建一个 XML Schema 文件，描述自定义的合法构建模块，也就是xsd文件自定义个处理器类，并实现NamespaceHandler接...
Spring XMLschema扩展机制详解：自定义标签与Bean解析
总结来说，Spring的XML schema扩展机制为开发者提供了灵活性，让他们能够扩展Spring的配置能力，实现更加个性化的应用构建。这对于理解和使用Spring Boot或者深入研究其他基于Spring的框架如Dubbo有着重要意义。通过...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值