Spring 自定义标签

在项目中使用dubbo服务时，第一步需要引入dubbo.jar，第二部需要配置dubbo相关配置，以前我们都是通过xml配置文件进行配置，在配置文件中我们会用到dubbo的xsd文件，它就是通过Spring 自定义标签进行实现的。

使用Spring 自定义标签需要以下几个步骤：

• 定义Bean标签解析生成接收配置的POJO类
• 定义schemas文件（spring.schemas），定义自定义标签的attr属性
• 定义标签协议类parser，获取配置文件属性
• 定义命名空间处理类，继承NamespaceHandlerSupport类
• 声明schema，写入spring.schema文件中
• 声明自定义标签的命名处理类namespaceHandler,写入spring.handlers文件中

User.java

package com.ska.spring.core.namespace.handler;

import java.io.Serializable;

public class User implements Serializable {

    private String id;

    private String userName;

    private String email;

    public String getId() {
        return id;
    }

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

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

定义shema文件，配置属性

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            xmlns="http://schemas.ska.com/schema/user" targetNamespace="http://schemas.ska.com/schema/user"
            elementFormDefault="qualified">
    <xsd:element name="user">
        <xsd:complexType>
            <xsd:attribute name="id" type="xsd:string" />
            <xsd:attribute name="userName" type="xsd:string" />
            <xsd:attribute name="email" type="xsd:string" />
        </xsd:complexType>
    </xsd:element>
</xsd:schema>

定义标签解析类

package com.ska.spring.core.namespace.handler;

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

public class UserBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {

    @Override
    protected Class<?> getBeanClass(Element element) {
        return User.class;
    }

    @Override
    protected void doParse(Element element, BeanDefinitionBuilder builder) {
        String userName=element.getAttribute("userName");
        String email=element.getAttribute("email");
        if(StringUtils.hasText(userName)){
            builder.addPropertyValue("userName", userName);
        }
        if(StringUtils.hasText(email)){
            builder.addPropertyValue("email", email);
        }
    }

}

定义命名空闲处理类型

package com.ska.spring.core.namespace.handler;

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

public class UserNamespaceHandler extends NamespaceHandlerSupport {

    @Override
    public void init() {
        registerBeanDefinitionParser("user", new UserBeanDefinitionParser());
    }

}

声明schema(spring.schemas)，需要注意转译符号，不能缺少

http\://schemas.ska.com/schema/user.xsd=META-INF/user.xsd

声明namespace命名空间处理类

http\://schemas.ska.com/schema/user=com.ska.spring.core.namespace.handler.UserNamespaceHandler

使用：

<?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:springtag="http://schemas.ska.com/schema/user"
       xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://schemas.ska.com/schema/user
        http://schemas.ska.com/schema/user.xsd">
        <!--  声明一个user对象-->

    <springtag:user id="ska" userName="减肥要努力" email="ska@26.com"/>

</beans>

main方法测试：

package com.ska.spring.core.namespace.handler.test;

import com.ska.spring.core.namespace.handler.User;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Main {

    public static void main(String[] args) {
        ApplicationContext beans=new ClassPathXmlApplicationContext("classpath:applicationContent.xml");
        User user=(User)beans.getBean("ska");
        System.out.println("username:"+user.getUserName()+":"+"email:"+user.getEmail());
    }

}

测试结果：

username:减肥要努力:email:ska@26.com