通過Spring自定義NamespaceHandler實現命名空間解析(推薦)

Posted on by

spring中在使用xml進行bean配置時，我們經常出現<context:annotation-config/>這樣的配置，或是在使用dubbo時，暴露服務時，使用<dubbo:service interface="xxx" ref="yyy" />，我們知道僅僅通過這些簡單的配置，其實完成瞭很多工作，那麼我們能不能也實現這種功能，僅通過簡單的配置，實現bean定義加載的過程中細節的隱藏，但完成復雜的功能呢？
答案是肯定的，方法是我們使用自定義NamespaceHandler進行處理，具體步驟如下：
說明：下面模擬spring bean定義功能，使用我們自定義的方式來實現CustomBean註入到Spring容器中，具體用法如下：

<custom:bean class="com.lcl.spring.beans.CustomBean"></custom:bean>

1、定義Bean

package com.lcl.spring.beans;

public class CustomBean {
    public void sayHi(){
        System.out.println("Hello Custom NamespaceHandler");
    }
}

我們想把這個類通過xml方式註入到spring容器中

2、編寫自定義NamespaceHandler

NamespaceHandler的功能就是解析我們自定義的custom命名空間的，為瞭方便起見，我們實現NamespaceHandlerSupport，其內部通過BeanDefinitionParser對具體的標簽進行處理，即對我們定義的<custom:bean/>進行具體處理。

NamespaceHandler實現如下：

package com.lcl.spring.ext;

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

/**
 * 自定義命名空間解析器
 */
public class CustomNamespaceHandler extends NamespaceHandlerSupport {

    @Override
    public void init() {
        // 在初始化方法中，註入標簽解析器，此時我們需要解析<custom:bean/>
        registerBeanDefinitionParser("bean", new CustomBeanDefinitionParser());
        // 註入其他解析器...
    }
}

解析器代碼：

package com.lcl.spring.ext;

import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.BeanDefinitionHolder;
import org.springframework.beans.factory.support.BeanDefinitionReaderUtils;
import org.springframework.beans.factory.xml.BeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.w3c.dom.Element;

/**
 * 自定義解析器
 */
public class CustomBeanDefinitionParser implements BeanDefinitionParser {

    @Override
    public BeanDefinition parse(Element element, ParserContext parserContext) {
        // 為瞭演示方便起見，使用BeanDefinitionParserDelegate解析bean definition
        BeanDefinitionHolder beanDefinitionHolder = parserContext.getDelegate().parseBeanDefinitionElement(element);
        // 使用工具類註冊
        BeanDefinitionReaderUtils.registerBeanDefinition(beanDefinitionHolder, parserContext.getRegistry());
        // 或是使用註冊器註冊
        //parserContext.getRegistry().registerBeanDefinition(beanDefinitionHolder.getBeanName(),beanDefinitionHolder.getBeanDefinition());
        return beanDefinitionHolder.getBeanDefinition();
    }
}

特別說明：在解析器中執行parse返回BeanDefinition並不會實現被返回的bean定義被自動註冊到spring容器中，需要自己手工的執行註冊中，如執行上述代碼中的BeanDefinitionReaderUtils.registerBeanDefinition或使用parserContext.getRegistry().registerBeanDefinition

另外為瞭更方便的處理解析過程，解析器可以實現AbstractSingleBeanDefinitionParser

3、編寫spring.handlers文件

這個是核心的配置文件，定義瞭具體handler處理器，其實spring內部對context、aop、task等命名空間，也是通過此方式進行處理的。
具體內容如下：

http\://www.lcl.com/schema/custom=com.lcl.spring.ext.CustomNamespaceHandler

4、編寫XSD文件

為瞭簡單期間，我直接使用spring-beans-4.3.xsd文件修改，命名為custom-beans-4.3.xsd，放置在resources目錄下

在這裡插入圖片描述

註意：需要修改如圖所示部分

5、編寫spring.schemas

http\://www.lcl.com/schema/custom.xsd=custom-beans-4.3.xsd

6、編寫spring配置文件

<?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:custom="http://www.lcl.com/schema/custom"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.lcl.com/schema/custom http://www.lcl.com/schema/custom.xsd">
    <custom:bean class="com.lcl.spring.beans.CustomBean"></custom:bean>
</beans>

使用瞭我們自定義的<custom:bean/>標簽進行定義

7、測試

package com.lcl.spring;

import com.lcl.spring.beans.CustomBean;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class SpringCustomNamespaceHandlerDemo {
    public static void main(String[] args) {
        ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext("context.xml");
        CustomBean bean = applicationContext.getBean(CustomBean.class);
        bean.sayHi();
    }
}

輸入結果如下:

Hello Custom NamespaceHandler

到此這篇關於通過Spring自定義NamespaceHandler實現命名空間解析的文章就介紹到這瞭,更多相關Spring自定義命名空間解析內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：

    None Found