自己构建一个Spring自定义标签以及原理讲解

提示：扫一扫查出行
【扫一扫了解最新限行尾号】
复制提示

平时不论是在Spring配置文件中引入其他中间件（比如dubbo），还是使用切面时，都会用到自定义标签。那么配置文件中的自定义标签是如何发挥作用的，或者说程序是如何通过你添加的自定义标签实现相应的功能的呢？且看下文。

通过对本文的阅读，你会在阅读涉及到自定义标签的源码功能时事半功倍，而且还可以自己动手做出一个自己的自定义标签。

先呈上我自己在本地实现自定义标签的代码及对应讲解：

1、先无脑输出一个测试要用到的Bean类

public class User { private String userName;
private String emailAddress; public String getUserName() {
return userName;
} public void setUserName(String userName) {
this.userName = userName;
} public String getEmailAddress() {
return emailAddress;
} public void setEmailAddress(String emailAddress) {
this.emailAddress = emailAddress;
}
}

2、spring的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:context="http://www.springframework.org/schema/context"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:myname="http://www.zzq.com/schema/user"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.0.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd
http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd
http://www.zzq.com/schema/user http://www.zzq.com/schema/user.xsd"> <aop:aspectj-autoproxy proxy-target-class="true"/>
<mvc:annotation-driven/>
<context:component-scan base-package="myDemoHome"/>
<context:property-placeholder location="classpath:properties/config.properties" ignore-unresolvable="true"/> <myname:myPw id="testUserBean" userName="zzq" emailAddress="zzqing@110.com"/> </beans>

3、从2中可以看到，命名空间中我添加了自定义的xmlns:myname="http://www.zzq.com/schema/user"，以及http://www.zzq.com/schema/user跟http://www.zzq.com/schema/user.xsd。

其中紧跟xmlns冒号后面的部分，就是我们自定义标签引号前的部分，比如此处定义了myname，那么自定义标签中我就可以<myname:XXX/>这样引用了，其中的XXX则是在命名空间中定义的myPw。

中间http://www.zzq.com/schema/user对应此自定义标签的handler，放在Spring.handlers中。

最后的http://www.zzq.com/schema/user.xsd则定义了此自定义标签的XXX，即自定义标签冒号后面有什么，由此xsd定义，放在Spring.schemas中。

Spring.handlers跟Spring.schemas文件都放在META-INF目录下，因为spring会默认去此目录下读。

Spring.handlers如下所示:

http\://www.zzq.com/schema/user=myDemoHome.springElement.bdParser.UserNamespaceHandler

Spring.schemas如下所示：

http\://www.zzq.com/schema/user.xsd=META-INF/spring-test.xsd

3.1 自定义标签的解析类UserNamespaceHandler构建

package myDemoHome.springElement.bdParser; import myDemoHome.springElement.User;
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 name = element.getAttribute("userName");
String address = element.getAttribute("emailAddress"); if (StringUtils.hasText(name)) {
builder.addPropertyValue("userName", name);
}
if (StringUtils.hasText(address)) {
builder.addPropertyValue("emailAddress", address);
}
} }

就是对element中的标签进行解析处理，完成从xml中的标签属性向对象值的转化

3.2 自定义标签解析类的注册 UserNamespaceHandler

package myDemoHome.springElement.bdParser; import org.springframework.beans.factory.xml.NamespaceHandlerSupport; public class UserNamespaceHandler extends NamespaceHandlerSupport {
@Override
public void init() {
registerBeanDefinitionParser("myPw", new UserBeanDefinitionParser());
}
}

此处的意思就是当遇到myPw这个标签的时候，往spring容器中注入这个标签的解析类，以完成后续对标签属性的解析。看到此处，各位道友有没有想起AOP的自定义注解aspectj-autoproxy 的解析呢？其实套路都是一样的。

3.3 xsd文件spring-test.xsd的定义

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

此文件规定了自定义注解的标签，以及对应的属性

4、测试类ElementTest

package myDemoHome.springElement; import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext; public class ElementTest {
public static void main(String[] args) {
ApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath*:spring/spring-config.xml");
User user = (User)applicationContext.getBean("testUserBean");
System.out.println(user.getEmailAddress());
}
}

再附上一张所用类的位置关系图