Spring自定义标签和spring.handlers的加载过程

转载地址：https://blog.youkuaiyun.com/wabiaozia/article/details/78631259

 

版权声明：------------转载请标明链接.博客内容仅供参考,一切以官方文档为准!------------    https://blog.youkuaiyun.com/wabiaozia/article/details/78631259
此篇博客分为三部分：1 schema配置 2 自定义标签和handler的加载过程 3 spring启动容器到handlers加载过程中间每一步怎么走的

1 schema配置

2 Spring自定义标签：

Spring自定义标签的原理

XML通常通过DTD、XSD定义，但DTD的表达能力较弱，XSD定义则能力比较强，能够定义类型，出现次数等。自定义标签需要XSD支持，在实现时使用Namespace扩展来支持自定义标签。

当你在苦逼的写下面的代码时：

Xml代码  
<bean id="beanId" class="com.xxx.xxxx.Xxxxx">  
        <property name="property1">  
            <value>XXXX</value>  
        </property>  
        <property name="property2">  
            <value>XXXX</value>  
        </property>  
    </bean>  
 是不是会羡慕这样写代码呢？

Xml代码  
<xxx:xxxx id="beanId"/>  
 

 

Spring通过XML解析程序将其解析为DOM树，通过NamespaceHandler指定对应的Namespace的BeanDefinitionParser将其转换成BeanDefinition。再通过Spring自身的功能对BeanDefinition实例化对象。

在期间，Spring还会加载两项资料：

META-INF/spring.handlers 
指定NamespaceHandler(实现org.springframework.beans.factory.xml.NamespaceHandler)接口，或使用org.springframework.beans.factory.xml.NamespaceHandlerSupport的子类。
META-INF/spring.schemas 
在解析XML文件时将XSD重定向到本地文件，避免在解析XML文件时需要上网下载XSD文件。通过现实org.xml.sax.EntityResolver接口来实现该功能。
制作自定义的标签

spring.handlers:

 

Xml代码  
http\://test.hatter.me/schema/test=me.hatter.test.TestNamespaceHandler  
 spring.schemas:

 

Xml代码  
http\://test.hatter.me/schema/test/test.xsd=META-INF/test.xsd  
 test.xsd:

 

Xml代码  
<?xml version="1.0" encoding="UTF-8" standalone="no"?>  
<xsd:schema xmlns="http://test.hatter.me/schema/test"  
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"   
        targetNamespace="http://test.hatter.me/schema/test">  
  
        <xsd:element name="custom" type="customType">  
        </xsd:element>  
          
        <xsd:complexType name="customType">  
                <xsd:attribute name="id" type="xsd:ID">  
                </xsd:attribute>  
                <xsd:attribute name="name" type="xsd:string">  
                </xsd:attribute>  
        </xsd:complexType>  
  
</xsd:schema>  
 me.hatter.test.TestNamespaceHandler:

 

Java代码  
package me.hatter.test;  
  
import org.springframework.beans.factory.xml.NamespaceHandlerSupport;  
  
public class TestNamespaceHandler extends NamespaceHandlerSupport {  
  
    public void init() {  
        registerBeanDefinitionParser("custom", new TestCustomBeanDefinitionParser());  
    }  
}  
 me.hatter.test.TestCustomBeanDefinitionParser:

 

Java代码  
package me.hatter.test;  
  
import me.hatter.test.bean.TestBean;  
  
import org.springframework.beans.factory.config.BeanDefinition;  
import org.springframework.beans.factory.support.RootBeanDefinition;  
import org.springframework.beans.factory.xml.BeanDefinitionParser;  
import org.springframework.beans.factory.xml.ParserContext;  
import org.w3c.dom.Element;  
  
public class TestCustomBeanDefinitionParser implements BeanDefinitionParser {  
  
    public BeanDefinition parse(Element element, ParserContext parserContext) {  
  
        String id = element.getAttribute("id");  
        String name = element.getAttribute("name");  
  
        RootBeanDefinition beanDefinition = new RootBeanDefinition();  
        beanDefinition.setBeanClass(TestBean.class);  
        beanDefinition.getPropertyValues().addPropertyValue("name", name);  
        parserContext.getRegistry().registerBeanDefinition(id, beanDefinition);  
  
        return beanDefinition;  
    }  
}  
 

测试代码

test.xml:

 

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:test="http://test.hatter.me/schema/test"  
    xsi:schemaLocation="  
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd  
        http://test.hatter.me/schema/test http://test.hatter.me/schema/test/test.xsd">  
          
        <test:custom id="testCustom" name="this is a test custom tag" />  
</beans>  
 me.hatter.test.main.Main:

Java代码  
package me.hatter.test.main;  
  
import org.springframework.context.ApplicationContext;  
import org.springframework.context.support.ClassPathXmlApplicationContext;  
  
public class Main {  
  
    public static void main(String[] args) {  
        String xml = "classpath:me/hatter/test/main/test.xml";  
        ApplicationContext context = new ClassPathXmlApplicationContext(new String[] { xml });  
        System.out.println(context.getBean("testCustom"));  
    }  
}  
 上例输出为：

TestBean[name=thisis a test custom tag]

参考链接：

Spring自定义标签：http://zhangxing119.iteye.com/blog/1796906

spring.handlers的加载过程:

要实现自定义的xml配置，需要有两个默认spring配置文件来支持。一个是spring.schemas,一个是spring.handlers，前者是为了验证你自定义的xml配置文件是否符合你的格式要求，后者是告诉spring该如何来解析你自定义的配置文件。

1.在步骤4createReaderContext的时候，会做如下检查，如果没有resolver会创建一个默认的DefaultNamespaceHandlerResolver,

if (this.namespaceHandlerResolver == null) {
    this.namespaceHandlerResolver = createDefaultNamespaceHandlerResolver();
}
Spring.handlers这个文件名和路径就定义在这个类中。定义如下：

public static final String DEFAULT_HANDLER_MAPPINGS_LOCATION = "META-INF/spring.handlers";
所以务必记住默认的文件路径是在META-INF文件夹下。

3 spring启动容器到handlers加载过程中间每一步怎么走的

在步骤10中根据会根据传入的namespaceUri找到对应的NamespaceHandler，这个映射是在spring.handlers中配置的。

在步骤13中会根据element的名字找到对应的BeanDefinitionParser，这个是在NamespaceHandler的init()方法里面来配置的。

---------------------