如何在Spring中使用自定义标签

　　最近学习了一下如何在spring的xml文件中使用自定义的标签，把自己操作的过程记录下来。开始之前，最好先对spring的xml文件的格式有所了解，已经有文章写得很好了，这里不再赘述，详见：https://www.cnblogs.com/gonjan-blog/p/6637106.html。

　　接下来我们开始：

1、首先，pom文件中导入spring相关依赖：

pom.xml

<dependencies>

        <!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.1.3.RELEASE</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.springframework/spring-core -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>5.1.3.RELEASE</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.springframework/spring-beans -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>5.1.3.RELEASE</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.springframework/spring-web -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>5.1.3.RELEASE</version>
        </dependency>

    </dependencies>

2、定义一个User类，我们的目的就是通过自定义的标签将这个类注册到spring容器中，使其成为spring中的一个Bean。

package com.example

public class User {

    private String id;

    private String name;

    private String email;

    public String getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

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

3、定义一个User类的解析器UserBeanDefinitionParser，这个类继承了spring中的AbstractSingleBeanDefinitionParser，并重写了其中的getBeanClass和doParse方法。之所以这么做是因为我们待会将user类注册到spring容器的时候，spring会调用我们重写的doParse方法对xml文件进行解析，然后将xml文件中的属性值按我们在doParse中定义的方式注入到Bean中。

package com.example;

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 id=element.getAttribute("id");
        String name=element.getAttribute("name");
        String email=element.getAttribute("email");
        if(StringUtils.hasText(id)){
            builder.addPropertyValue("id", id);
        }
        if(StringUtils.hasText(name)){
            builder.addPropertyValue("name", name);
        }
        if(StringUtils.hasText(email)){
            builder.addPropertyValue("email", email);
        }
    }
}

4、定义UserNamespaceHandler类，这个类继承了spring中的NamespaceHandlerSupport类，并重写了其中的init方法，这个类的作用就是将标签中自定义的user标签和我们上一步定义的UserBeanDefinitionParser类绑定起来，表示解析到xml中的user标签的时候，要调用UserBeanDefinitionParser这个解析器来解析。

package com.example;

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

public class UserNamespaceHandler extends NamespaceHandlerSupport {

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

5、在resources目录下新建一个xsd文件：spring-user.xsd，xsd文件是用来描述xml文档结构的，我们在这个文件里定义了xml文件中的user标签应该有哪些属性。关于xsd文件的详细语法，参考：http://www.w3school.com.cn/schema/index.asp。

spring-user.xsd

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

6、在resources目录下新建一个目录：META-INF，在META-INF目录下新建两个文件：spring.handlers和spring.schemas文件，这两个文件的文件名是不能更改的，因为spring会自动去META-INF下寻找这两个文件，然后读取文件中定义的内容。下面是这两个文件的内容：

spring.handlers

http\://www.example.com/schema/user=com.example.UserNamespaceHandler

spring.schemas

http\://www.example.com/schema/spring-user.xsd=spring-user.xsd

注意反斜杠转义字符，是为了转义冒号。可以看到spring.handlers文件其实就是为了将"http://www.example.com/schema/user"这个命名空间与我们之前定义的UserNamespaceHandler类绑定起来，而spring.schemas文件则指明了"http://www.example.com/schema/spring-user.xsd"这个文件的本地位置，即resources目录下的spring-user.xsd文件。毕竟"http://www.example.com/schema/spring-user.xsd"这个网址是不存在的嘛，如果不指明一个本地文件与其对应，spring就真的会去这个网址上找xsd文件。

7、接下来就可以在resources目录下的application.xml文件中使用自己的标签了：

application.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:myTag="http://www.example.com/schema/user"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
            http://www.example.com/schema/user
            http://www.example.com/schema/spring-user.xsd">
    <myTag:user id="testUser" name="jeysin" email="jeysin@qq.com"/>
</beans>

在MyApplication的main函数中试着获取这个Bean

package com.example;

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

public class MyApplication {

    public static void main(String[] args){
        ApplicationContext context=new ClassPathXmlApplicationContext("application.xml");
        User user=(User)context.getBean("testUser");
        System.out.println(user.getId());
        System.out.println(user.getName());
        System.out.println(user.getEmail());
    }
}

 

整个的目录结构应该是这个样子：

-java

　　-com

　　　　-example

　　　　　　User

　　　　　　UserBeanDefinitionParser

　　　　　　UserNamespaceHandler

　　　　　　MyApplication

-resources

　　-META-INF

　　　　spring.handlers

　　　　spring.schemas

　　application.xml

　　spring-user.xsd