自定义spirng schema

spring已经为我们提供了很丰富的xml元素,但是有时候我们需要自己扩展spring schema来定制标签,spring已经为我们提供了扩展的api,使用起来非常方便。本片文章来自于spring官网的教程。

如果要定义自己的schema,通常有如下几步:

1、自定义xml schema,在这里是编写自己的xsd文件,xsd文件可以理解为描述xml文件的元文件,定义了一个xml文件中可以有哪些元素等等一些规则。

2、编写自己的NamespaceHandler。

3、编写自定义BeanDefinationParser类,完成对xml元素的解析工作。

4、注册上面的这些东西,也就是按照spring的规则将上面的功能整合。

这里定义一个SimpleDateFormat类的专用标签,该标签根据xml的配置元素初始化生成一个SimpleDateFormat类。完成后配置大概如下:

<myns:dateformat id="dateFormat"
    pattern="yyyy-MM-dd HH:mm"
    lenient="true"/>

可以像使用spring中其他的bean一样使用dateformat。

xsd文件定义如下:

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

    <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="lenient" type="xsd:boolean"/>
                    <xsd:attribute name="pattern" type="xsd:string" use="required"/>
                </xsd:extension>
            </xsd:complexContent>
        </xsd:complexType>
    </xsd:element>
</xsd:schema

上面的文件定义了一个xsd文件,由于要使用spring的identifiedType,因此头上import了benas的命令空间。dateformat是一个符合类型,有两个基本的属性lenient和pattern其中的pattern是必选的,相信熟悉soap的同学对上面的文件并不陌生。

package org.springframework.samples.xml;

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

public class MyNamespaceHandler extends NamespaceHandlerSupport {

    public void init() {
        registerBeanDefinitionParser("dateformat", new SimpleDateFormatBeanDefinitionParser());
    }

}

上面的类定义了我们自己的Handler,可见该类非常简单,主要做了一个映射的工作,当遇到dateformat标签的时候,将会使用SimpleDateFormatBeanDefinitionParser类进行解析。

parser类如下:

package org.springframework.samples.xml;

import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
import org.springframework.util.StringUtils;
import org.w3c.dom.Element;

import java.text.SimpleDateFormat;

public class SimpleDateFormatBeanDefinitionParser extends AbstractSingleBeanDefinitionParser { 1

    protected Class getBeanClass(Element element) {
        return SimpleDateFormat.class; 2
    }

    protected void doParse(Element element, BeanDefinitionBuilder bean) {
        // this will never be null since the schema explicitly requires that a value be supplied
        String pattern = element.getAttribute("pattern");
        bean.addConstructorArg(pattern);

        // this however is an optional property
        String lenient = element.getAttribute("lenient");
        if (StringUtils.hasText(lenient)) {
            bean.addPropertyValue("lenient", Boolean.valueOf(lenient));
        }
    }

}

parser类也很简单,getBeanClass返回SimpleDateFormat.class对象,也就是当遇到dateformat标签的时候spring为我们构造一个SimpleDateFormat类,其中类的具体属性由doParse方法完成,逻辑同样不难理解。

接下来注册handler和schema,在META-INF目录下新建spring.handlers,内容如下:

<pre class="literallayout" style="line-height: 1; background-color: rgb(255, 255, 255);"><pre name="code" class="html">http\://www.mycompany.com/schema/myns=org.springframework.samples.xml.MyNamespaceHandler


需要注意的是冒号前面需要加转义符,接下来定义自己的命名空间,指定该命名空间的Handler类

然后定义spring.schema文件,内容如下:

http\://www.mycompany.com/schema/myns/myns.xsd=org/springframework/samples/xml/myns.xsd

该文件指定前面xsd的locat路径,不指定的话spring会联网获取xsd文件。

以上就是自定义schema的步骤,可见还是挺简单的,下面就用一个小例子来应用起来。

<?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:myns="http://www.mycompany.com/schema/myns"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.mycompany.com/schema/myns http://www.mycompany.com/schema/myns/myns.xsd">

    <!-- as a top-level bean -->
    <myns:dateformat id="defaultDateFormat" pattern="yyyy-MM-dd HH:mm" lenient="true"/>

</beans>

上面的文件定义了一个id为defaultDateFormat的bean,可以像应用spring自身的bean一样应用该bean。

整个的项目目录如下:

版权声明:本文为博主原创文章,未经博主允许不得转载。

时间: 2024-11-08 19:18:18

自定义spirng schema的相关文章

自定义spring schema简化与canal集成

canal是阿里巴巴团队基于数据库日志增量订阅&消费的框架,项目中我们经常使用Spring来集成管理其它框架,本文讲述自定义spring xsd schema的方式配置集成canal到Spring容器. 项目地址:http://git.oschina.net/damivip/spring-xsd-canal 使用canal可以清楚的知道数据库记录的IUD的具体内容. 新增:可解析出新增数据的字段和内容 删除:可解析出删除数据的行所有内容 更新:可解析出更新记录前后的字段内容,和更新的字段是哪些

iOS开发中APP之间传递信息1--URL Schema(应用程序间互相启动)

原文:http://blog.sina.com.cn/s/blog_8a6c97b5010162f0.html 受限与iOS系统的运行机制,绝大多数情况下一个应用在进入后台后会马上进入suspend或terminate状态,也就是说不能执行代码,iOS中也没有类似WIndows中Service的概念,但存在某些例外: 1:有某些重要的任务,例如保存用户数据,网络下载等,可以申请一段时间的background运行时间,但时间段内能进行的操作比较有限,且有时间限制,长度为600秒左右. 2:某些特定

xml中的DTD和schema

XML的文档声明<?xml version="1.0" encoding="UTF-8" ?> xml转义字符 <![CDATA[内容]]> 实例: <![CDATA[ <student stuno='s01'> <name>张三</name> <age>23</age> <sex>男<</sex> </student> ]]>

Spring Schema扩展机制

1:概述 Spring2.0开始,Spring提供XML Schema可扩展机制,用户可以自定义XML Schema文件,并自定义 XML Bean解析器,集成到Spring IOC容器中. 2:步骤: 创建一个XML Schema文件,描述自定义的合法构建模块,也就是xsd文件. 自定义处理器类,并实现NamespaceHandler接口. 自定义一个或者多个解析器,实现BeanDefinitionParser接口(关键部分). 注册上面的组建到Spring IOC容器. 3:示例如下: (1

webx roadmap

SpringExt 自定义Spring Schema的例子 基于Spring可扩展Schema提供自定义配置支持 使用SpringExt扩展Webx的示例 扩展点和捐献 一个namespace下可以声明多个element. 扩展点:将namespace和接口关联起来.捐献:将element和实现关联起来. webx archetype tutorial1 tutorial11.PNG mvn archetype:generate -DgroupId=com.alibaba.webx -Darti

8. Dubbo原理解析-代理之服务发布

服务发布是服务提供方向注册中注册服务过程,以便服务消费者从注册中心查阅并调用服务. 服务发布方在spring的配置文件中配置如下: <bean id="demoService"class="com.alibaba.dubbo.demo.provider.DemoServiceImpl" /> 上面是在spring中配置的服务的具体实现,是spring中的一个普通的bean <dubbo:serviceinterface="com.alib

9. Dubbo原理解析-代理之服务引用

服务引用是服务的消费方向注册中心订阅服务提供方提供的服务地址后向服务提供方引用服务的过程. 服务的应用方在spring的配置实例如下: <dubbo:reference id="demoService" interface="com.alibaba.dubbo.demo. DemoService"/> 如上配置spring在容器启动的时候会解析自定义的schema元素<dubbo: reference/>转换成dubbo内部数据结构Refer

深入理解HDFS:Hadoop分布式文件系统

文本详细介绍了HDFS中的许多概念,对于理解Hadoop分布式文件系统很有帮助. 1. 介绍 在现代的企业环境中,单机容量往往无法存储大量数据,需要跨机器存储.统一管理分布在集群上的文件系统称为分布式文件系统.而一旦在系统中,引入网络,就不可避免地引入了所有网络编程的复杂性,例如挑战之一是如果保证在节点不可用的时候数据不丢失. 传统的网络文件系统(NFS)虽然也称为分布式文件系统,但是其存在一些限制.由于NFS中,文件是存储在单机上,因此无法提供可靠性保证,当很多客户端同时访问NFS Serve

【开源】浅谈Hybrid技术的设计与实现第二弹

前言 接上文:浅谈Hybrid技术的设计与实现(阅读本文前,建议阅读这个先) PS:据说加个开源在前面阅读量高点,于是就试试咯...... 上文说了很多关于Hybrid的概要设计,可以算得上大而全,有说明有demo有代码,对于想接触Hybrid的朋友来说应该有一定帮助,但是对于进阶的朋友可能就不太满足了,他们会想了解其中的每一个细节,甚至是一些Native的实现,小钗这里继续抛砖引玉,希望接下来的内容对各位有一定帮助. 进入今天的内容之前我们首先谈谈两个相关技术Ionic与React Nativ