如何自定义Spring标签

2018-10-19 本文已影响0人张晓鱼

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

Spring自定义标签步骤如下：

定义XSD文件
定义spring.handlers文件
定义spring.schemas文件

Spring通过解析XML配置文件来创建bean，所以要自定义Spring元素，需要先定义一个描述自定义元素的XSD文档，下面定义了一份简单的XSD文档，该文档自定义了一个reference元素，同时定义了元素类型referenceType，元素类型是可以共享。schema元素的属性定义xmlns="http://zhangyuyao.com/schema/customer"指出默认的命名空间是http://zhangyuyao.com/schema/customer，schema元素的属性定义targetNamespace="http://zhangyuyao.com/schema/customer"表示被此schema定义的元素来自命名空间http://zhangyuyao.com/schema/customer。xmlns和targetNamespace属性的值应该保持一致，且其值便是该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>

定义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

定义spring.handlers文件。该文件和spring.schemas文件位于同一目录，该文件用于保存命名空间和命名空间处理器之间的映射关系，其中http\://zhangyuyao.com/schema/customer即命名空间，该值是在XSD文件中自定义的，zhangyuyao.ioc.customer.CustomerNamespaceHandler是该命名空间对应的处理器类的类全限定名，spring会根据该文件的配置找到对应的命名空间处理器。（从文件名可以看出该文件可以配置多条配置关系）

http\://zhangyuyao.com/schema/customer=zhangyuyao.ioc.customer.CustomerNamespaceHandler

定义命名空间处理器，即继承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));
    }
}

定义reference元素解析器，即实现BeanDefinitionParser接口的类，实现类需要实现parse方法，该方法接受两个参数Element element和ParseContext 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;
    }
}

在类路径下定义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>

编写测试类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());
    }
}

spring何时，怎样载入spring.schemas和spring.handlers文件

如何自定义Spring标签

猜你喜欢

热点阅读