Spring自定義標(biāo)簽

在讀elastic-job過(guò)程中,發(fā)現(xiàn)使用了spring的自定義標(biāo)簽,當(dāng)時(shí)沒(méi)有細(xì)看實(shí)現(xiàn)原理,只關(guān)心了elastic-job的調(diào)度原理,現(xiàn)在開(kāi)始研究dubbo源代碼,dubbo服務(wù)啟動(dòng)第一步就是需要將服務(wù)注冊(cè)到注冊(cè)中心,這里讀取了大量的spring自定義標(biāo)簽,比如<dubbo:service>等等,正好先看一下Spring自定義標(biāo)簽的擴(kuò)展功能。

Spring自定義標(biāo)簽總共可以分為以下幾個(gè)步驟

  • 定義Bean 標(biāo)簽解析生成接收配置的POJO。
  • 定義schema文件,定義自定義標(biāo)簽的attr屬性
  • 定義解析類(lèi)parser,遇到自定義標(biāo)簽如何解析
  • 定義命名空間處理類(lèi)namespaceSupport,遇到自定義的命名標(biāo)簽,能夠路由到對(duì)應(yīng)的解析類(lèi)。
  • 聲明schema,寫(xiě)入spring.schema文件中
  • 聲明自定義標(biāo)簽的命名處理類(lèi)namespaceHandler,寫(xiě)入spring.handlers文件中

按照如上步驟,demo如下:

  • 定義bean 標(biāo)簽解析生成接收配置的POJO
public class User {
    private String id;
    private String userName;
    private String email;
   //省略get/set方法。
  • 定義shema文件 user有ID userName,email 三個(gè)屬性
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            xmlns="http://jettyrun.github.com/schema/user" targetNamespace="http://jettyrun.github.com/schema/user"
            elementFormDefault="qualified">
    <xsd:element name="user">
        <xsd:complexType>
            <xsd:attribute name="id" type="xsd:string" />
            <xsd:attribute name="userName" type="xsd:string" />
            <xsd:attribute name="email" type="xsd:string" />
        </xsd:complexType>
    </xsd:element>
</xsd:schema>
  • 定義parser,自定義標(biāo)簽解析類(lèi)
package com.github.jettyrun.springtag.parser;

import com.github.jettyrun.springtag.bean.User;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.util.StringUtils;
import org.w3c.dom.Element;

/**
 * Created by jetty on 18/1/30.
 */
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 email=element.getAttribute("email");
        if(StringUtils.hasText(userName)){
            builder.addPropertyValue("userName", userName);
        }
        if(StringUtils.hasText(email)){
            builder.addPropertyValue("email", email);
        }
    }
}

  • 定義命名空間處理類(lèi) 處理user的標(biāo)簽
package com.github.jettyrun.springtag.namespace;


import com.github.jettyrun.springtag.parser.UserBeanDefinitionParser;
import org.springframework.beans.factory.xml.NamespaceHandlerSupport;

/**
 * Created by jetty on 18/1/30.
 */
public class UserNamespaceHandler extends NamespaceHandlerSupport{
    public void init() {

        registerBeanDefinitionParser("user",new UserBeanDefinitionParser());
    }
}
  • 聲明schema,寫(xiě)spring.schema文件
http\://jettyrun.github.com/schema/user.xsd=META-INF/spring-user.xsd
  • 聲明namespace命名空間處理類(lèi)
http\://jettyrun.github.com/schema/user=com.github.jettyrun.springtag.namespace.UserNamespaceHandler

定義完成,最后,寫(xiě)一個(gè)main方法運(yùn)行一下:

  • 定義spring標(biāo)簽
<?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:aop="http://www.springframework.org/schema/aop"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:tx="http://www.springframework.org/schema/tx"
      <!-- 定義user標(biāo)簽前綴為springtag -->
       xmlns:springtag="http://jettyrun.github.com/schema/user"
       xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd
        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd
        http://jettyrun.github.com/schema/user http://jettyrun.github.com/schema/user.xsd">
  <!--  聲明一個(gè)user對(duì)象-->
    <springtag:user id="testBean" userName="name" email="wjs@163.com"/>
</beans>
  • main方法
package com.github.jettyrun.springtag;

import com.github.jettyrun.springtag.bean.User;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

/**
 * Created by jetty on 18/1/30.
 */
public class Main {

    public static void main(String[] args) {
        ApplicationContext beans=new ClassPathXmlApplicationContext("classpath:application-usertag.xml");
        User user=(User)beans.getBean("testBean");
        System.out.println("username:"+user.getUserName()+":"+"email:"+user.getEmail());
    }
}
  • 運(yùn)行結(jié)果
username:name:email:wjs@163.com

可以看到,user就是自己定義的一個(gè)自定義標(biāo)簽。
代碼來(lái)自博客:http://blog.csdn.net/shinebar/article/details/75675615
代碼地址:https://gitee.com/shxz130/SpringTag/
fyi

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容