Spring中自定义Schema扩展机制

一、前言

 Spring 为基于 XML 构建的应用提供了一种扩展机制，用于定义和配置 Bean。 它允许使用者编写自定义的 XML bean 解析器，并将解析器本身以及最终定义的 Bean 集成到 Spring IOC 容器中。

二、自定义 XML Schema 扩展

 为了搞懂 Spring 的 XML 扩展机制，最直接的方式便是实现一个自定义的扩展。实现的步骤也为四步：

1. 编写一个 XML schema 文件描述的你节点元素。
2. 编写一个 NamespaceHandler 的实现类
3. 编写一个或者多个 BeanDefinitionParser 的实现 (关键步骤).
4. 注册上述的 schema 和 handler

1. 编写 resources/META-INF/Car.xsd

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns="http://www.mycompany.com/schema/my"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:beans="http://www.springframework.org/schema/beans"
        targetNamespace="http://www.mycompany.com/schema/my1"
        elementFormDefault="qualified"
        attributeFormDefault="unqualified">

    <xsd:import namespace="http://www.springframework.org/schema/beans"/>

    <xsd:element name="car">
        <xsd:complexType>
            <xsd:complexContent>
                <xsd:extension base="beans:identifiedType">
                    <xsd:attribute name="brand" type="xsd:string" use="required"/>
                    <xsd:attribute name="engine" type="xsd:float"/>
                    <xsd:attribute name="horsePower" type="xsd:int"/>
                </xsd:extension>
            </xsd:complexContent>
        </xsd:complexType>
    </xsd:element>
</xsd:schema>

 这里，targetNamespace对Car标签很重要，比如说注册一个bean

<my1:car id="magic" brand="Magic" engine="4.5" horsePower="605" />

2. 编写 CarNamespaceHandler

public class CarNamespaceHandler extends NamespaceHandlerSupport {

    @Override
    public void init() {
        //遇到car元素的时候交给CarBeanDefinitionParser来解析
        registerBeanDefinitionParser("car", new CarBeanDefinitionParser());

    }

}

 编写的NamespaceHandler 来帮助 Spring 解析 XML 中不同命名空间的各类元素。不同的命名空间需要不同的 NamespaceHandler 来处理。使用 CarNamespaceHandler 来解析 car 的命名空间。

public interface NamespaceHandler {
   void init();
   BeanDefinition parse(Element element, ParserContext parserContext);
   BeanDefinitionHolder decorate(Node source, BeanDefinitionHolder definition, ParserContext parserContext);
}

 CarNamespaceHandler 继承 NamespaceHandlerSupport 抽象类，NamespaceHandlerSupport 抽象类实现了 NamespaceHandler 接口，并实现了parse()和decorate()方法，在CarNamespaceHandler 类中实现 NamespaceHandler 接口的init()方法，注册 BeanDefinitionParser 来完成解析节点以及注册 Bean 的工作。

3. 编写 CarBeanDefinitionParser 

 BeanDefinitionParser 是最为关键的一环。每一个 BeanDefinitionParser 实现类都负责一个映射，将一个 XML 节点解析成 IOC 容器中的一个实体类。

public class CarBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {

    @Override
    protected Class<?> getBeanClass(Element element) {
        //car元素对应Car对象类型
        return Car.class;
    }

    @Override
    protected void doParse(Element element, BeanDefinitionBuilder builder) {
        
        String brand = element.getAttribute("brand");
        String engine = element.getAttribute("engine");
        String hp = element.getAttribute("horsePower");
        
        //把对应的属性设置到bean中
        if(StringUtils.hasText(brand))
            builder.addPropertyValue("brand", brand);
        
        if(StringUtils.hasText(engine))
            builder.addPropertyValue("engine", engine);

        if(StringUtils.hasText(hp))
            builder.addPropertyValue("horsePower", hp);
        
    }
}

 parse() 方法会解析一个个 XML 中的元素，使用 RootBeanDefinition 组装成对象，并最终通过 parserContext 注册到 IOC 容器中。

 至此，我们便完成了 XML 文件中定义的对象到 IOC 容器的映射。

4. 注册 schema 和 handler

 最后一步还需要通知 Spring，告知其自定义 schema 的所在之处以及对应的处理器。

 resources/META-INF/spring.handlers

http://www.mycompany.com/schema/my1=spring.xml.ext.schema.CarNamespaceHandler

 resources/META-INF/spring.schemas

http://www.mycompany.com/schema/my1.xsd=META-INF/car.xsd

 一个自定义的 XML schema 便扩展完成了，接下来验证一下自定义Schema扩展。

三、验证扩展

 定义好Spring的bean配置文件

<?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:my1="http://www.mycompany.com/schema/my1"
        xsi:schemaLocation="
            http://www.springframework.org/schema/beans 
            http://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.mycompany.com/schema/my1
            http://www.mycompany.com/schema/my1.xsd">

    <my1:car id="magic" brand="Magic" engine="4.5" horsePower="605" />

</beans>

 编写测试方法

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = { "classpath:app.xml" })
public class SchemaTest {

    @Autowired
    @Qualifier("magic")
    private Car car;

    @Test
    public void propertyTest() {
        assertNotNull(car);

        String brand = car.getBrand();
        float engine = car.getEngine();
        int horsePower = car.getHorsePower();

        System.out.println("==============================");
        assertEquals("Brand incorrect.Should be Magic.", "Magic", brand);
        assertEquals("Engine incorrect.Should be 4.5L.", 4.5, engine, 0.000001);
        assertEquals("HorsePower incorrect.Should be 605hp.", 605, horsePower);

    }
}

 控制台输出无异常，断言成功。