(1)首先我们创建一个普通的POJO,这个POJO没有任何特别之处,只是用来接收配置文件。
(4)创建一个Handler文件,扩展自NamespaceHandlerSupport,目的是将组件注册到容器。
(7)测试
package test.customtag;
public class User {
private String userName;
private String email;
// getter and setter
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文件描述组件内容。
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.example.org/user"
xmlns:tns="http://www.example.org/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>
在上面的XSD文件中描述了一个新的targetNamespace,并在这个空间中定义了一个name为user的element,user有id、userName和email三个属性,这三个属性主要用于验证Spring配置文件中的自定义格式。
(3)创建一个文件,实现BeanDefinitionParser接口,用来解释XSD文件中的定义和组件定义。
package test.customtag;
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 {
// element对应的类
protected Class getBeanClass(Element element){
return User.class;
}
// 从element中解析并提取对应的元素
protected void doParse(Element element, BeanDefinitionBuilder bean){
String userName = element.getAttribute("userName");
String email = element.getAttribute("email");
// 将提取的数据放入到BeanDefinitoonBuilder中,待到完成所有bean的解析后统一注册到beanFactory中
if(StringUtils.hasText(userName)){
bean.addPropertyValue("uaerName", userName);
bean.addPropertyValue("email", email);
}
}
}
(4)创建一个Handler文件,扩展自NamespaceHandlerSupport,目的是将组件注册到容器。
package test.customtag;
import org.springframework.beans.factory.xml.NamespaceHandlerSupport;
public class MyNamespaceHandler extends NamespaceHandlerSupport {
@Override
public void init() {
// TODO Auto-generated method stub
registerBeanDefinitionParser("user", new UserBeanDefinitionParser());
}
}
以上代码的意思是当遇到自定义标签<user:aaa这样类似于以user开头的元素,就会把这个元素扔给对应的UserBeanDefinitionParser去解析。
(5)编写Spring.handlers文件,文件内容如下:
http\://www.example.org/user=test.customtag.MyNamespaceHandler
编写Spring.schemas文件,文件内容如下:
http\://www.example.org/user.xsd=META_INF/Spring-test.xsd
这两个文件默认需要放置在工程的/META-INF/文件夹下,否则Spring无法正确加载自定义的XSD和Handler文件。当然你也可以通过Spring的扩展或者修改源码来改变路径。
到这里,自定义配置就结束了,而Spring加载自定义标签的大致流程是遇到自定义标签后去Spring.handlers和Spring.schemas中查找对应的handler和XSD,进而找到对应的handler以及解析元素的Parser,从而完成整个自定义元素的解析。
(6)创建测试配置文件,在配置文件中引入对应的命名空间以及XSD后,便可以直接使用自定义标签了。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">
<beans xmlns="http://www.Springframework.org/schema/beans"
xmlns:xi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:myname="http://www.example.org/user"
xsi:schemaLocation="http://www.Springframework.org/schema/beans http://www.Springframework.org/schema/beans/Spring-beans-3.1.3.xsd
http://www.example.org/user http://www.example.org/user.xsd">
<myname:user id="testbean" username="aaa" email="bbb"/>
</beans>
(7)测试
package test.customtag;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class CustomTagTest {
public static void main(String[] args) {
ApplicationContext context = new ClassPathXmlApplicationContext("test/customtag/CustomBeanTest.xml");
User user = (User) context.getBean("testbean");
System.out.println(user.getUserName() + "," + user.getEmail());
}
}
整理自《Spring源码深度解析》