SPRING 自定义标签解析

当 Spring 从 xml 解析一个元素时，首先会获取并解析该元素的命名空间，然后根据命名空间指定对应解析方法。

自定义标签使用

下面我们就自己实现一个简单的自定义标签解析。

屏幕快照 2020-05-03 上午11.20.06.png

各文件源代码内容如下 ：
1.定义需要拓展的 POJO 对象 User.java

public class User implements Serializable {
    private static final long serialVersionUID = 8284819768161317253L;

    private String            userName;

    private String            email;

    private String            phoneNum;

    // 忽略get set方法
}

定义对 User对象验证文件 userTest.xsd
用于验证 xml 配置中对 User 赋值的正确性。从下面内容我们可以看到，所有字段必须为 String 类型。

<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema"
                targetNamespace="http://www.why.com/schema/user_test"
                elementFormDefault="qualified">
    <element name="user">
        <complexType>
            <attribute name="id" type="string"/>
            <attribute name="userNmae" type="string"/>
            <attribute name="email" type="string"/>
            <attribute name="phoneNum" type="string"/>
        </complexType>
    </element>
</schema>

定义对应拓展对象解析器 UserBeanDefinitionParser.java
从下面代码中我们看到，该类继承了 AbstractSingleBeanDefinitionParser 同时复写了其中 getBeanClass() 和 doParse() 方法。
这里既然实现了对应 xml 元素的解析，那就一定有地方将读到对象 user 元素时关联当前定义 Parser，将配置解析成 bean 定义；马上我们在后面就能看到对应的关联了。

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("userNmae");
        String email = element.getAttribute("email");
        String phoneNum = element.getAttribute("phoneNum");
        if(StringUtils.hasText(userName)) {
            bean.addPropertyValue("userName", userName);
        }
        if(StringUtils.hasText(email)) {
            bean.addPropertyValue("email", email);
        }
        if(StringUtils.hasText(phoneNum)) {
            bean.addPropertyValue("phoneNum", phoneNum);
        }
    }
}

定义对应命名空间处理类 UserNameSpaceHandler.java
该类复写了父类中 init() 方法，主要是将对应命名空间中元素 user 关联到对应解析器 Parser 中。
这里我们可以在一个命名空间下定义多个不同元素，同时将不同元素指定对应不同的解析器来解析。

public class UserNameSpaceHandler extends NamespaceHandlerSupport {
    @Override
    public void init() {
        registerBeanDefinitionParser("user", new UserBeanDefinitionParser());
    }
}

编写对应 handlers 和 schemas 文件
handlers 中的 key值（等号前值）为我们定义的命名空间，是在 xsd 文件中指明的 targetNameSpace；同时也是我们在 bean 定义配置文件( 6.中会提及) 中需要通过命名空间标识来指明的。
这里映射了对应命名空间和对应处理处理器的映射关系。也就是说这里指定了命名空间和我们实现的 Handler的映射关系。

文件默认放置在对应 resources/META-INF 文件夹下。

spring.handlers

http\://www.why.com/schema/user_test=org.springframework.whyTest.UserNameSpaceHandler

spring.schemas

http\://www.why.com/schema/user_test.xsd=beanxsd/userTest.xsd

Spring 对应 Bean 定义配置文件 beandefinition.xml
我们可以看到我们定义的命名空间

http://www.why.com/schema/user_test

同时我们给了这个命名空间一个"标识“ sofa, 那么我们后面定义该命名空间下声明的元素时都要用到 sofa 这个”标识“。
整体spring应用启动时我们会加载对应 handlers 和 schemas, 并以键值对的形式存储对应映射关系；
在我们从beandefinition中读到 sofa:user 时，会根据sofa查找到我们上面定义的命名空间，从而找到对应 Handler 实现类，然后根据对应 user 来映射对应该元素的自定义解析器 UserBeanDefinitionParser 。

<?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:sofa="http://www.why.com/schema/user_test"
       xsi:schemaLocation=
               "http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
                  http://www.why.com/schema/user_test http://www.why.com/schema/user_test.xsd">
    <sofa:user id="testBean" email="www.alibaba.com" phoneNum="1234" userNmae="why"/>
</beans>

自定义标签解析

image.png

从实现上我们能够看出，整体分三步来进行对应自定义 bean 的解析的：

根据元素获取对应的命名空间；
这里也就是我们上面的 sofa 标签，查找上面对应的 xmlns:sofa 对应的命名空间；
根据对应的命名空间映射去找到对应注册的命名空间Handler;
映射关系在 spring.handlers 中维度，在resolve()时会加载 resources/META-INF 下的所有文件生成映射关系；
根据对应元素找到 Parser 并解析。

这里代码比较简单，就不展开来说了；感兴趣的话可以从入口跟一下代码具体实现。