如何自定义Spring标签

完整的demo地址:https://github.com/runningRookie/spring-learn main方法位于CustomerDemo类,运行可查看demo结果

Spring自定义标签步骤如下:

  1. 定义XSD文件
  2. 定义spring.handlers文件
  3. 定义spring.schemas文件
  1. Spring通过解析XML配置文件来创建bean,所以要自定义Spring元素,需要先定义一个描述自定义元素的XSD文档,下面定义了一份简单的XSD文档,该文档自定义了一个reference元素,同时定义了元素类型referenceType,元素类型是可以共享。schema元素的属性定义xmlns="http://zhangyuyao.com/schema/customer"指出默认的命名空间是http://zhangyuyao.com/schema/customerschema元素的属性定义targetNamespace="http://zhangyuyao.com/schema/customer"表示被此schema定义的元素来自命名空间http://zhangyuyao.com/schema/customerxmlnstargetNamespace属性的值应该保持一致,且其值便是该XSD文档定义的XML元素的命名空间,当以xml方式配置bean的时候会用到该命名空间。
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xsd:schema xmlns="http://zhangyuyao.com/schema/customer"
            xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            targetNamespace="http://zhangyuyao.com/schema/customer">

    <!--定义一个元素-->
    <xsd:element name="reference" type="referenceType">
        <xsd:annotation>
            <xsd:documentation>
                <![CDATA[ 自定义标签]]>
            </xsd:documentation>
        </xsd:annotation>
    </xsd:element>

    <!--定义一个类型-->
    <xsd:complexType name="referenceType">
        <!--定义类型属性-->
        <xsd:attribute name="id" type="xsd:ID"/>
        <!--定义类型属性-->
        <xsd:attribute name="description" type="xsd:string"/>
    </xsd:complexType>
</xsd:schema>
  1. 定义spring.schemas文件。在类路径下创建META-INF文件夹,并在该文件夹下创建spring.schemas文件,该文件用于保存xsd的uri(http://zhangyuyao.com/schema/customer/customer.xsd)和本地XSD文件位置的映射关系,之所以这样配置是为了让xml优先从本地获取xsd文件,而不是从uri指定的路径下载,其中http\://zhangyuyao.com/schema/customer/customer.xsd是自定义的,在Spring bean配置文件中会用到,customer/customer.xsd则是类路径下XSD文件的真实位置。(从文件名可以看出该文件可以配置多条映射关系)
http\://zhangyuyao.com/schema/customer/customer.xsd=customer/customer.xsd
  1. 定义spring.handlers文件。该文件和spring.schemas文件位于同一目录,该文件用于保存命名空间和命名空间处理器之间的映射关系,其中http\://zhangyuyao.com/schema/customer即命名空间,该值是在XSD文件中自定义的,zhangyuyao.ioc.customer.CustomerNamespaceHandler是该命名空间对应的处理器类的类全限定名,spring会根据该文件的配置找到对应的命名空间处理器。(从文件名可以看出该文件可以配置多条配置关系)
http\://zhangyuyao.com/schema/customer=zhangyuyao.ioc.customer.CustomerNamespaceHandler
  1. 定义命名空间处理器,即继承NamespaceHandlerSupport类的扩展类,该扩展类需要实现init方法,在该方法中需要向容器注册BeanDefinitionParser解析器,registerBeanDefinitionParser方法需要两个参数,第一个参数传递的是元素名称(其实就是在XSD中定义的元素的名称),第二个参数是该元素对应的解析器。
/**
 * LY.com Inc.
 * Copyright (c) 2004-2018 All Rights Reserved.
 */
package zhangyuyao.ioc.customer;

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

import zhangyuyao.ioc.customer.bean.Reference;
import zhangyuyao.ioc.customer.parse.ReferenceBeanDefinitionParse;

/**
 * 命名空间处理器
 * 
 * 一个NamespaceHandlerSupport对应一个schema
 *
 * @author zyy43688
 * @version $Id: CustomerNamespaceHandler.java, v 0.1 2018年7月11日 上午10:27:27 zyy43688 Exp $
 */
public class CustomerNamespaceHandler extends NamespaceHandlerSupport {
    @Override
    public void init() {
        // 元素解析器
        registerBeanDefinitionParser("reference", new ReferenceBeanDefinitionParse(Reference.class));
    }
}
  1. 定义reference元素解析器,即实现BeanDefinitionParser接口的类,实现类需要实现parse方法,该方法接受两个参数Element elementParseContext parseContext,它返回一个BeanDefinition的实例,对元素的所有解析逻辑都在这个方法中实现。
/**
 * LY.com Inc.
 * Copyright (c) 2004-2018 All Rights Reserved.
 */
package zhangyuyao.ioc.customer.parse;

import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.beans.factory.xml.BeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.lang.Nullable;
import org.springframework.util.StringUtils;
import org.w3c.dom.Element;

/**
 * reference元素解析器
 *
 * @author zyy43688
 * @version $Id: ReferenceBeanDefinitionParse.java, v 0.1 2018年7月11日 上午10:31:36 zyy43688 Exp $
 */
public class ReferenceBeanDefinitionParse implements BeanDefinitionParser {

    /*bean类型*/
    private final Class<?> beanClass;

    public ReferenceBeanDefinitionParse(Class<?> beanClass) {
        this.beanClass = beanClass;
    }

    @Nullable
    @Override
    public BeanDefinition parse(Element element, ParserContext parserContext) {
        // 创建BeanDefinition的实例
        RootBeanDefinition beanDefinition = new RootBeanDefinition();

        beanDefinition.setBeanClass(this.beanClass);
        beanDefinition.setLazyInit(false);

        String id = element.getAttribute("id");

        if (!StringUtils.isEmpty(id)) {
            parserContext.getRegistry().registerBeanDefinition(id, beanDefinition);
            beanDefinition.getPropertyValues().add("id", id);
        }

        String description = element.getAttribute("description");

        if (!StringUtils.isEmpty(description)) {
            beanDefinition.getPropertyValues().add("description", description);
        }

        return beanDefinition;
    }
}
/**
 * LY.com Inc.
 * Copyright (c) 2004-2018 All Rights Reserved.
 */
package zhangyuyao.ioc.customer.bean;

/**
 * 引用
 *
 * @author zyy43688
 * @version $Id: Reference.java, v 0.1 2018年7月11日 上午10:47:05 zyy43688 Exp $
 */
public class Reference {

    /**
     * id
     */
    private String id;

    /**
     * 描述
     */
    private String description;

    @Override
    public String toString() {
        final StringBuffer sb = new StringBuffer("Reference{");
        sb.append("id='").append(id).append('\'');
        sb.append(", description='").append(description).append('\'');
        sb.append('}');
        return sb.toString();
    }

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}
  1. 在类路径下定义spring bean配置文件CustomerMain.xml,xmlns:customer="http://zhangyuyao.com/schema/customer"指定了http://zhangyuyao.com/schema/customer命名空间前缀,文档中所有出现的以前缀customer:开始的元素都是该命名空间下定义的元素,xsi:schemaLocation属性定义了命名空间与实际的xsd文件的映射关系http://zhangyuyao.com/schema/customer http://zhangyuyao.com/schema/customer/customer.xsd配置表明,http://zhangyuyao.com/schema/customer命名空间对应的xsd文件路径为http://zhangyuyao.com/schema/customer/customer.xsd,实际使用时Spring会根据这里配置的映射关系到META-INF/spring.schemas文件中找到实际的XSD文件。
<?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:customer="http://zhangyuyao.com/schema/customer"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
       http://zhangyuyao.com/schema/customer http://zhangyuyao.com/schema/customer/customer.xsd">
    <customer:reference id="matrix" description="哎哟,卧槽!" />
</beans>
  1. 编写测试类CustomerMain验证自定义元素reference是否能够正常使用
/**
 * LY.com Inc.
 * Copyright (c) 2004-2018 All Rights Reserved.
 */
package zhangyuyao.ioc.customer;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import lombok.extern.slf4j.Slf4j;
import zhangyuyao.ioc.customer.bean.Reference;

/**
 * @author zyy43688
 * @version $Id: CustomerMain.java, v 0.1 2018年7月11日 上午10:50:26 zyy43688 Exp $
 */
@Slf4j
public class CustomerMain {

    public static void main(String[] args) {
        ApplicationContext context = new ClassPathXmlApplicationContext("classpath:CustomerMain.xml");

        Reference reference = (Reference) context.getBean("matrix");

        log.info(reference.toString());
    }
}
  1. spring何时,怎样载入spring.schemas和spring.handlers文件
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,874评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,102评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,676评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,911评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,937评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,935评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,860评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,660评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,113评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,363评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,506评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,238评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,861评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,486评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,674评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,513评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,426评论 2 352

推荐阅读更多精彩内容