此例子参考了《Spring源码深度解析一书》。
在日常开发中，我们使用较多的是Spring的常规标签，如bean，事务，Aop等等。随着业务需求的增多，同时降低程序员的工作量，我们有时需要自定义一些标签，以满足需要。如：dubbo就用了一些自定义的标签来实现与spring整合的功能。
一、如何使用自定义标签？
自定义标签的步骤如下：
1.创建需要扩展的组件；
2.定义XSD文件描述组件内容；
3.创建一个类，实现BeanDefinitionParser接口，用来解析XSD文件中的定义和组件定义；
4.创建Handler文件，扩展自NamespaceHandlerSupport,目的是将组件注册到Spring容器；
5.编写Spring.handlers和Spring.schemas文件。
1、创建POJO，接收配置文件
public class User {
private String userName;
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
private String email;
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="user">
<complexType>
<attribute name ="id" type = "string"/>
<attribute name ="userName" type = "string"/>
<attribute name ="email" type = "string"/>
</complexType>
</element>
</schema>
上述配置描述了一个targetNamespace，并且创建了一个element user。里面有三个attribute。主要是为了验证Spring配置文件中的自定义格式。再进一步解释，就是，Spring位置文件中使用的user自定义标签中，属性只能是上面的三种，有其他的属性的话，就会报错。
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 {
publicvoid init() {
registerBeanDefinitionParser("user",new UserBeanDefinitionParser());
}
}
5、编写Spring.handlers和Spring.schemas文件
路径：src/main/resources/META-INF/Spring.handlers
http\://www.example.org/schema/user=test.customtag.MyNamespaceHandler
路径：src/main/resources/META-INF/Spring.schemas
http\://www.example.org/schema/user.xsd=META-INF/user.xsd
6、创建测试配置文件
路径：src/main/resources/test.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:myname="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">
<myname:user id = "testbean" userName = "lee" email = "bbb"/>
</beans>
引入了myname对应的命名空间，它会到（http://www.example.org/schema/user.xsd）找到对应XSD文件进行check。
7、编写测试类
public class Test {
public static void main(String[] args) {
ApplicationContext beans=newClassPathXmlApplicationContext("classpath:test.xml");
User user=(User)beans.getBean("testbean");
System.out.println("username:"+user.getUserName()+" "+"email:"+user.getEmail());
}
}
输出结果：
username:lee email:bbb。
网友评论