Spring自定義標籤的使用

爲什麼自定義標籤

自定義標籤是spring爲了給開發人員擴展組件使用的，因爲它提供了一個標準的公共可插拔的接口；目前我們都知道spring非常強大，不過實際上除了spring-core和spring-beans外，其他都是通過自定義標籤擴展實現的，其次還有一些開源組件也是，如dubbo等。所以，對於想擴展spring組件的小夥伴來說，瞭解如何自定義標籤和相應的原理是必須走的第一步。

自定義標籤

按照spring加載、解析的順序有以下五個基本文件：

• spring.schemas
• *.xsd
• spring.handlers
• Handler
• Parser
• 最後引入到配置文件中使用。
• 基本自定義標籤需要實現兩個關鍵接口：
  NamespaceHandlerSupport
BeanDefinitionParser

工程機構：

pom依賴：

 <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>5.2.5.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.2.5.RELEASE</version>
        </dependency>
    </dependencies>

spring.schemas

spring.schemas是告訴spring容器我們的自定義的xsd文件在哪個地方。

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

類似與key=value的形式，如果找不到會去網絡上下載。

*.xsd

DTD與XSD是spring中最常見的基礎配置文件，打個比方DTD類似於Java的關鍵字，而XSD則類似於Java的語法。
而我們自定義XSD文件則是對於我們定義bean對象時可以使用的屬性限制或者說支持的那些屬性配置，自定義的user.xsd如下。

<?xml version="1.0" encoding="utf-8" ?>
<schema xmlns="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.leehao.com/schema/user"
xmlns:tns="http://www.leehao.com/schema/user"
elementFormDefault="qualified">
    <element name="user">
        <complexType>
            <attribute name="id" type="string"/>
            <attribute name="userName" type="string"/>
            <attribute name="age" type="int"/>
        </complexType>
    </element>

</schema>

指定namespace時，請勿使用spring默認前綴。
這裏我們定義了一個element屬性可以設置id,userName,age.

Handlers

Handlers作爲自定義標籤解析的入口需要在默認文件名稱spring.handlers指定，文件內容如下:
這裏是我們自定義的MyNamespaceHandler.目的是爲了註冊我們對應標籤的解析類；

package com.leehao.handler;

import com.leehao.parser.UserBeanDefinitionParser;
import org.springframework.beans.factory.xml.NamespaceHandlerSupport;

/**
 * @ClassName MyNamespaceHandler
 * @Description MyNamespaceHandler
 * @Author lihao
 * @Date 2020/4/23 11:13
 * @Version 1.0
 **/
public class MyNamespaceHandler extends NamespaceHandlerSupport {
    public void init() {
        registerBeanDefinitionParser("user", new UserBeanDefinitionParser());
    }
}

Parser

這裏我們不直接實現這個接口BeanDefinitionParser，我們直接使用他的抽象實現類AbstractSingleBeanDefinitionParser。這裏我們獲取屬性並設置到bean中。

package com.leehao.parser;

import com.leehao.model.User;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
import org.springframework.util.StringUtils;
import org.w3c.dom.Element;

/**
 * @ClassName UserBeanDefinitionParser
 * @Description UserBeanDefinitionParser
 * @Author lihao
 * @Date 2020/4/23 11:08
 * @Version 1.0
 **/
public class UserBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {
    @Override
    protected Class<?> getBeanClass(Element element) {
        return User.class;
    }

    @Override
    protected void doParse(Element element, BeanDefinitionBuilder builder) {
        String userName = element.getAttribute("userName");
        String age = element.getAttribute("age");
        if (StringUtils.hasText(userName)) {
            builder.addPropertyValue("userName", userName);
        }
        if (StringUtils.hasText(age)) {
            builder.addPropertyValue("age", Integer.valueOf(age));
        }
    }
}

自定義標籤

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

    <leehao:user id = "userBean" userName = "leehao" age="27"/>
</beans>

使用自定義標籤

package com.leehao;

import com.leehao.model.User;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

/**
 * @ClassName App
 * @Description App
 * @Author lihao
 * @Date 2020/4/14 09:39
 * @Version 1.0
 **/
public class App {
    public static void main(String[] args) {
        ApplicationContext beans=new ClassPathXmlApplicationContext("classpath:test.xml");
        User user=(User)beans.getBean("userBean");
        System.out.println("username:"+user.getUserName()+"  "+"age:"+user.getAge());
    }
}

執行上述程序後，輸出：

username:leehao  age:27

Process finished with exit code 0

致謝

https://blog.csdn.net/zzg1229059735/article/details/82669955
https://mp.weixin.qq.com/s/B7KynNoEZRIsIjTDRYw1mQ