spring 自定义xml标签

1.自定义标签的用途
    自定义标签可以说是spring提供的最大、最强的Hook(钩子),通俗的讲就是给后续小伙伴开发组件,提供一个标准公共可拔插”接口”,大家可以理解为手机充电器的工业标准口,为了方便各个充电器生产厂家生产,而制定的标准。 
    既然说自定义标签如此强大,我们在哪里应用的呢? 我们知道spring发展越来越强大,但核心的组件只有spring-core和spring-beans,那么有些人会问我们经常用的context,aop,tx不是吗?对的,这些都是在核心上做的扩展,而这些扩展恰恰是通过自定义标签实现扩展的,还有一些公共开源组件amq,redis,dubbo等等,他们都利用了自定义标签来扩展,使得spring容器的功能越发强大。
2.自定义标签使用
    既然自定义标签用途那么广,那么如何使用自定义标签呢?这里我将带领大家感受下自定义标签的使用。需要的文件(按照spring加载、解析的顺序)有以下五个基本文件: 
①spring.schemas 
②XSD文件 
③spring.handlers 
④NamespaceHandler 
⑤BeanDefinitionParser 
⑥最后引入到配置文件中使用。 
基本自定义标签需要实现两个关键接口:NamespaceHandlerSupport,BeanDefinitionParser 
先看下基本工程代码结构:


①spring.schemas是告诉spring容器我们的自定义的xsd文件在哪里,类似与key=value的形式.内容如下 

http\://www.wjs.com/schema/user.xsd=META-INF/spring-user.xsd
②我们知道DTD与XSD是spring中最常见的切基础的配置文件,打个比方DTD类似于Java的关键字,而XSD则类似于Java的语法。 
而我们自定义XSD文件则是对于我们定义bean对象时可以使用的属性限制或者说支持的那些属性配置,自定义的spring-custom.xsd如下: 
<?xml version="1.0" encoding="UTF-8"?>  
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"  
    xmlns="http://www.wjs.com/schema/user" targetNamespace="http://www.wjs.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>

③Handlers作为自定义标签解析的入口需要在默认文件名称spring.handlers指定,文件内容如下:

这里是我们自定义的NamespaceHandlers.目的是为了注册我们对应标签的解析类

http\://www.wjs.com/schema/user=com.spring.tag.MyUserNamespaceHandler
 

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

public class MyUserNamespaceHandler extends NamespaceHandlerSupport {

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

}

5.

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);
        }
    }
}

6.public class User {  
    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;  
    }  
}

7.import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;  
public class CustomerTagTest {  
    public static void main(String[] args) {  
        ApplicationContext beans=new ClassPathXmlApplicationContext("classpath:application-customtag.xml");  
        User user=(User)beans.getBean("testBean");  
        System.out.println("username:"+user.getUserName()+":"+"email:"+user.getEmail());  
    }  

8.application-customtag.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:aop="http://www.springframework.org/schema/aop"  
    xmlns:context="http://www.springframework.org/schema/context"  
    xmlns:mvc="http://www.springframework.org/schema/mvc"  
    xmlns:tx="http://www.springframework.org/schema/tx"  
    xmlns:myTag="http://www.wjs.com/schema/user"  
    xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd  
        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.xsd  
        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd  
        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd  
        http://www.wjs.com/schema/user http://www.wjs.com/schema/user.xsd">  
   
 <myTag:user id="testBean" userName="name" email="wjs@163.com"/>  
</beans>

 

9.工程结构

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值