美文网首页
Spring—自定义标签

Spring—自定义标签

作者: 康俊1024 | 来源:发表于2019-09-17 09:53 被阅读0次

前言

我们应该都知道Spring的常规标签,如bean,事务,Aop等等。随着满足业务的需求,同时降低程序员的工作量,我们有时需要自己定制一些标签。

自定义标签

Spring自定义标签需要如下几步:
1.创建需要扩展的组件;
2.定义xsd文件描述组件内容;
3.创建一个文件,实现BeanDefinitionParser接口,用来解析xsd文件中的定义和组件定义;
4.创建Handler文件,扩展字NamespaceHandlerSupport,目的是将组件注册到Spring容器;
5.编写Spring.handlers和Spring.schemas文件;

案例实践

1.创建需要扩展的组件

public class User {
    private String userName;
    private String email;
    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;
    }
}

2.定义一个xsd文件描述组件内容
在目录src/main/resources/META-INF/下创建 user.xsd文件

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

文件schema 便签有一个targetNamespace属性,并且创建了一个element users,里面有三个attribute。
主要是为了验证Spring配置文件中的自定义格式。也就是,Spring位置文件中使用的users自定义标签中,属性只能是上面的三种,有其他的属性的话,就会报错。
3.创建文件,实现BeanDefinitionParser接口,用来解析xsd文件中的定义和组件定义

public class UserBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {

    @SuppressWarnings("rawtypes")
    protected Class getBeanClass(Element element) {
        return User.class;
    }
    
    protected void doParse(Element element, BeanDefinitionBuilder bean) {
        String userName = element.getAttribute("userName");
        String email = element.getAttribute("email");
        if (StringUtils.hasText(userName)) {
            bean.addPropertyValue("userName", userName);
        }
        if (StringUtils.hasText(email)){
            bean.addPropertyValue("email", email);
        } 
        
    }
}

4.创建Handler文件,扩展自NamespaceHandlerSupport,目的是将组件注册到Spring容器中

public class MyNamespaceHandler extends NamespaceHandlerSupport {

    public void init() {
        registerBeanDefinitionParser("users", new UserBeanDefinitionParser());
    }

}

5.编写Spring.handlers和Spring.schemas文件
前提须知:\ 是转义字符的概念。
在目录src/main/resources/META-INF/下创建Spring.handlers文件

http\://www.example.org/schema/user=com.kangjun.springframework.service.MyNamespaceHandler

在目录src/main/resources/META-INF/下创建Spring.schemas文件

http\://www.example.org/schema/user.xsd=META-INF/user.xsd

6.创建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:user="http://www.example.org/schema/user"
       xsi:schemaLocation="http://www.springframework.org/schema/beans       http://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.example.org/schema/user http://www.example.org/schema/user.xsd">

    <user:users id = "user" userName = "kangjun" email = "123456"/>
</beans>

引入xmlns:user对应的命名空间,它会到http://www.example.org/schema/user.xsd找到对应xsd文件进行check。再到Spring.schemas里去参照。
7.测试用例

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

相关文章

  • Spring源码分析-bean的解析(3)

    Spring源码分析-bean的解析(3) 当前版本 Spring 4.3.8 自定义标签的解析 自定义标签使用 ...

  • Spring4 自定义标签解析源码

    介绍 Spring将标签解析分为自定义标签解析和默认标签解析。 自定义标签解析开始位置 BeanDefinitio...

  • Spring的自定义标签

    Spring为自定义xml标签加载提供了扩展。用户可自定义标签并注册到Spring的bean容器中。实现较为复杂的...

  • spring解析自定义标签

    title: spring解析自定义标签tags: spring,源码grammar_cjkRuby: true ...

  • Spring 事务解析过程

    使用Spring的事务需要在xml配置 tx是Spring的自定义标签,该自定义标签的处理类为 从上面的代码可知,...

  • dubbo服务导出

    dubbo版本:2.7.2 一、spring解析自定义扩展标签。 spring分析xml节点的可以看出对于自定义命...

  • FreeMarker自定义标签

    freemarker 自定义标签 有两种方法,一种是Spring注解添加自定义标签 一种的编码添加自定义标签 第...

  • 2.1 dubbo自定义标签

    dubbo的自定义的spring标签通过DubboNamespaceHandler继承NamespaceHandl...

  • Spring源码解析(六)-解析bean标签

    Spring版本 5.2.5.RELEASE 参考 学习Spring源码(二)自定义标签属性 源码解读 在Spri...

  • 【Dubbo】Spring融合

    Dubbo和Spring结合使用了大量的自定义标签。dubbo正是通过这些标签和Spring融合在一起,实现了服务...

网友评论

      本文标题:Spring—自定义标签

      本文链接:https://www.haomeiwen.com/subject/acequctx.html