Spring源码学习（3）—— 自定义标签

时间：2021-03-11 06:36:12

上一篇讲了Spring对默认标签的解析，Spring提供了很多属性，可以供开发者根据不同情况使用。绝大多数情况下，这些功能就已经足够了。但是，当用户有更特殊的需求，又或者很多公司自己实现的服务治理框架有一些自定义的需求是spring默认属性无法提供，或者是有更好得实现方式时，一种方式是像Spring一样用原生态的方式去解析定义好的XML文件，然后转化为配置对象，但这样实现起来比较复杂，还有一种方式就是通过Spring提供的可扩展Schema的支持，扩展自定义标签。

扩展自定义标签大致需要以下几个步骤：

1、创建一个需要扩展的组件

2、定义一个.xsd文件描述组件的内容

3、创建一个文件实现BeanDefinitionParser接口，用来解析xsd文件中的定义和组件的含义

4、创建一个handle文件，实现NamespaceHandleSupport，将组件和解析类注册到spring中

5、编写spring.handlers和spring.schemas

首先我们创建一个简单的pojo

package com.wuzhe.spring.test;

public class User {

    private String userName;

    public String getUserName() {

        return userName;

    }

    public void setUserName(String userName) {

        this.userName = userName;

    }

}

第二步，新建一个xsd文件描述自定义的标签

<?xml version="1.0" encoding="UTF-8"?>

<xsd:schema

        xmlns="http://www.test.com/user"

        xmlns:xsd="http://www.w3.org/2001/XMLSchema"

        xmlns:beans="http://www.springframework.org/schema/beans"

        targetNamespace="http://www.test.com/user"

        elementFormDefault="qualified"

        attributeFormDefault="unqualified">

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

    <xsd:element name="user">

        <xsd:complexType>

            <xsd:complexContent>

                <xsd:extension base="beans:identifiedType">

                    <xsd:attribute name="userName" type="xsd:string" />

                </xsd:extension>

            </xsd:complexContent>

        </xsd:complexType>

    </xsd:element>

</xsd:schema>

这里定义了一个新的命名空间targetNamespace:http://www.test.com/user  并定义了自定义标签user的属性等信息。

接下来就需要定义解析自定义标签，将其转化为beanDefinition了。spring通过实现BeanDefinitionParser接口来解析自定义标签。

package com.wuzhe.spring.test;

import org.springframework.beans.factory.support.BeanDefinitionBuilder;

import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;

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 bean){

        String userName = element.getAttribute("userName");

        bean.addPropertyValue("userName", userName);

    }

}

这里只是简单地将自定义标签user中的userName属性，通过set注入到bean中。所以在beanDefinition添加了对应的PropertValue。

定义好了解析标签的过程，接下来就要在spring中注册这个标签和解析器的联系，这样spring在解析对应自定义标签时就知道用哪个解析器去解析它。

spring中通过扩展NamespaceHandlerSupport来实现这一功能。

package com.wuzhe.spring.test;

import org.springframework.beans.factory.xml.NamespaceHandlerSupport;

public class Handler extends NamespaceHandlerSupport {

    public void init() {

        registerBeanDefinitionParser("user", new UserBeanDefinitionParser());

    }

}

最后我们需要编写spring.handlers和spring.schemas这两个文件。这两个文件的功能是在解析xml文件时，一旦遇到自定义标签，就会通过这两个文件找到对应的xsd文件和对应的Handler，然后在handler中注册的对应标签和解析器来解析自定义标签。

这两个文件的默认位置是在resource下的META-INF文件夹下

spring.handlers

http\://www.test.com/user=com.wuzhe.spring.test.Handler

spring.schemas

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

这里http后的\实际上是为了转义冒号的。另外需要特别注意xsd文件和handler类的路径一定不能错。

到这里自定义标签的准备工作就已经完成了。我们可以写一个测试demo

首先容器的配置文件

<beans xmlns="http://www.springframework.org/schema/beans"

       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

       xmlns:cutesource="http://www.test.com/user"

       xsi:schemaLocation="

http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd

http://www.test.com/user http://www.test.com/user.xsd">

    <cutesource:user id="testUser" userName="haha"/>

</beans>

这里使用了自定义的标签user，设置了属性userName的值

写个测试类

public class Main {

    public static void main(String[] args) {

        BeanFactory beanFactory = new XmlBeanFactory(new ClassPathResource("user.xml"));

        User user = (User) beanFactory.getBean("testUser");

        System.out.println(user.getUserName());

    }

}

我们发现通过自定义标签的方式，成功获取了user实例，并且这个实例的userName属性被设置为了haha。说明我们的自定义配置生效了。

相关文章