Spring自定义标签的解析

一：项目demo

Spring提供了可扩展的支持，利用如下的代码来一步步实现spring自定义解析。
项目结构如下，引入spring4.0

1.创建一个user对象

public class User {

    private String userName;
    private String email; 
    ...............省略getset
}

2.创建一个XSD文件，用于校验自定义xml文件

<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema"
        targetNamespace="http://www.lexueba.com/schema/user"
        xmlns:tns="http://www.lexueba.com/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>

3.创建解析类：UserBeanDefinitionParser 继承AbstractSingleBeanDefinitionParser

public class UserBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {

    //element对应的类
    @Override
    protected Class getBeanClass(Element element) {
        return User.class;
    }

    //从element中解析并提取对应的元素
    @Override
    protected void doParse(Element element, BeanDefinitionBuilder bean) {
        String userName = element.getAttribute("userName");
        String email = element.getAttribute("email");
        
        //将提取的数据放入到BeanDefinitionBuilder，待完成所有bean的解析后统一注册到beanfatory中
        if (StringUtils.hasText(userName)) {
            bean.addPropertyValue("userName", userName);
        }
        if (StringUtils.hasText(email)) {
            bean.addPropertyValue("email", email);
        }
    }

}

4.创建handle，用于将bean注入到spring容器

public class UserNamespaceHandler extends NamespaceHandlerSupport{

    @Override
    public void init() {
    //此处用于解析出来的user标签交由UserBeanDefinitionParser去处理
        registerBeanDefinitionParser("user", new UserBeanDefinitionParser());
    }
}

5.创建handle映射文件，Spring.handlers，以及Spring.schemas用于对xml文件进行校验

Spring.handlers

http\://www.lexueba.com/schema/user=spring.tag.handle.UserNamespaceHandler

Spring.schemas

http\://www.lexueba.com/schema/user.xsd=META-INF/user.xsd

6.创建spring配置文件Spring.xml
注意：beans中的参数需同上handle和schemas相匹配

<?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:usertag="http://www.lexueba.com/schema/user**"
       xsi:schemaLocation="http://www.springframework.org/schema/beans 
         http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
         **http://www.lexueba.com/schema/user http://www.lexueba.com/schema/user.xsd**">
    
    <usertag:user id="user" userName="cosmos" email="cosmos@163.com"/>

</beans>

6.至此，自定义解析步骤完成，开始测试。

public class CustomTagApplication {

    /**
     * @param args the command line arguments
     */
    public static void main(String[] args) {
        ApplicationContext bf = new ClassPathXmlApplicationContext("spring/tag/xml/Spring.xml");
        User user = (User) bf.getBean("user");
        System.out.println(user);
    }
}

结果如下：

二：原理详解

在之前bean解析的时候，有两种方式，如下

自定义标签会调用parseCustomElement方法，parseCustomElement代码如下：
命名空间即为spring.xml中的usertag

通过DefalutNamespaceHandleResolver来加载该bean的处理类，进入DefalutNamespaceHandleResolver下的resolve方法：

加载完handle后，则进入具体的解析过程，调用handle的parse方法。此处的parse方法引用的是父类AbstractBeanDefinitionParser的方法，代码如下

此处，parseInternal会对bean进行进一步的处理：

到此，自定义标签的解析就结束了。