首頁>網絡編程教程>Java教程

Spring源碼解密之自定義標籤與解析

作者：Eve Cole 更新時間：2025-07-21 22:00:02

前言

在上一節Spring解密- 默認標籤的解析中，重點分析了Spring 對默認標籤是如何解析的，那麼本章繼續講解標籤解析，著重講述如何對自定義標籤進行解析。話不多說了，來一起看看詳細的介紹吧。

自定義標籤

在講解自定義標籤解析之前，先看下如何自定義標籤

定義XSD 文件

定義一個XSD 文件描述組件內容

<?xml version="1.0" encoding="UTF-8"?><xsd:schema xmlns="http://www.battcn.com/schema/battcn" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:beans="http://www.springframework.org/schema/beans" targetNamespace="http://www.battcn.com/schema/battcn" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xsd:import namespace="http://www.springframework.org/schema/beans" /> <xsd:element name="application"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="beans:identifiedType"> <xsd:attribute name="name" type="xsd:string" use="required"/> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element></xsd:schema>
  • 聲明命名空間： 值得注意的是xmlns 與targetNamespace 可以是不存在，只要映射到指定XSD 就行了。
  • 定義復合元素： 這裡的application 就是元素的名稱，使用時<battcn:application id="battcn"/>
  • 定義元素屬性： 元素屬性就是attribute 標籤，我們聲明了一個必填的name 的屬性，使用時<battcn:application id="battcn" name="Levin"/>

定義解析規則

1.創建一個類實現BeanDefinitionParser 接口（也可繼承Spring 提供的類），用來解析XSD 文件中的定義和組件定義

public class ApplicationBeanDefinitionParser extends AbstractSingleBeanDefinitionParser { @Override protected Class getBeanClass(Element element) { // 接收對象的類型如：String name = (String) context.getBean("battcn"); return String.class; } @Override protected void doParse(Element element, BeanDefinitionBuilder bean) { // 在xsd 中定義的name 屬性String name = element.getAttribute("name"); bean.addConstructorArgValue(name); }}

這裡創建了一個ApplicationBeanDefinitionParser 繼承AbstractSingleBeanDefinitionParser（是：BeanDefinitionParser 的子類）， 重點就是重寫的doParse，在這個里面解析XML 標籤的，然後將解析出的value（Levin） 通過構造器方式註入進去

2.創建一個類繼承NamespaceHandlerSupport 抽像類

public class BattcnNamespaceHandler extends NamespaceHandlerSupport { @Override public void init() { registerBeanDefinitionParser("application", new ApplicationBeanDefinitionParser()); }}

BattcnNamespaceHandler 的作用特別簡單，就是告訴Spring 容器，標籤<battcn:application />應該由那個解析器解析（這裡是我們自定義的：ApplicationBeanDefinitionParser），負責將組件註冊到Spring 容器

3.編寫spring.handlers 和spring.schemas 文件

文件存放的目錄位於resources/META-INF/文件名

spring.handlers

 http/://www.battcn.com/schema/battcn=com.battcn.handler.BattcnNamespaceHandler

spring.schemas

 http/://www.battcn.com/schema/battcn.xsd=battcn.xsd

4.使用自定義標籤

申明bean.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:battcn="http://www.battcn.com/schema/battcn" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.battcn.com/schema/battcn http://www.battcn.com/schema/battcn.xsd"> <battcn:application id="battcn" name="Levin"/></beans>

創建一個測試類，如果看到控制台輸出了Levin 字眼，說明自定義標籤一切正常

public class Application { public static void main(String[] args) { ApplicationContext context = new ClassPathXmlApplicationContext("bean.xml"); String name = (String) context.getBean("battcn"); System.out.println(name); }}

5.如圖所示

源碼分析

自定義標籤解析入口

public class BeanDefinitionParserDelegate { @Nullable public BeanDefinition parseCustomElement(Element ele, @Nullable BeanDefinition containingBd) { // 獲取命名空間地址http://www.battcn.com/schema/battcn String namespaceUri = getNamespaceURI(ele); if (namespaceUri == null) { return null; } // NamespaceHandler 就是自定義的BattcnNamespaceHandler 中註冊的application NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri); if (handler == null) { error("Unable to locate Spring NamespaceHandler for XML schema namespace [" + namespaceUri + "]", ele); return null; } return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd)); }}

與默認標籤解析規則一樣的是，都是通過getNamespaceURI(Node node)來獲取命名空間，那麼this.readerContext.getNamespaceHandlerResolver()是從哪裡獲取的呢？我們跟踪下代碼，可以發現在項目啟動的時候，會在XmlBeanDefinitionReader 將所有的META-INF/spring.handles 文件內容解析，存儲在handlerMappers（一個ConcurrentHashMap） 中，在調用resolve(namespaceUri)校驗的時候在將緩存的內容提取出來做對比

public class XmlBeanDefinitionReader { public NamespaceHandlerResolver getNamespaceHandlerResolver() { if (this.namespaceHandlerResolver == null) { this.namespaceHandlerResolver = createDefaultNamespaceHandlerResolver(); } return this.namespaceHandlerResolver; }}

resolve

1.加載指定的NamespaceHandler 映射，並且提取的NamespaceHandler 緩存起來，然後返回

public class DefaultNamespaceHandlerResolver { @Override @Nullable public NamespaceHandler resolve(String namespaceUri) { Map<String, Object> handlerMappings = getHandlerMappings(); // 從handlerMappings 提取handlerOrClassName Object handlerOrClassName = handlerMappings.get(namespaceUri); if (handlerOrClassName == null) { return null; } else if (handlerOrClassName instanceof NamespaceHandler) { return (NamespaceHandler) handlerOrClassName; } else { String className = (String) handlerOrClassName; try { Class<?> handlerClass = ClassUtils.forName(className, this.classLoader); if (!NamespaceHandler.class.isAssignableFrom(handlerClass)) { throw new FatalBeanException("Class [" + className + "] for namespace [" + namespaceUri + "] does not implement the [" + NamespaceHandler.class.getName() + "] interface"); } // 根據命名空間尋找對應的信息NamespaceHandler namespaceHandler = (NamespaceHandler) BeanUtils.instantiateClass(handlerClass); // Handler 初始化namespaceHandler.init(); handlerMappings.put(namespaceUri, namespaceHandler); return namespaceHandler; } catch (ClassNotFoundException ex) { throw new FatalBeanException("NamespaceHandler class [" + className + "] for namespace [" + namespaceUri + "] not found", ex); } catch (LinkageError err) { throw new FatalBeanException("Invalid NamespaceHandler class [" + className + "] for namespace [" + namespaceUri + "]: problem with handler class file or dependent class", err); } } }}

標籤解析

加載完NamespaceHandler 之後，BattcnNamespaceHandler 就已經被初始化為了，而BattcnNamespaceHandler 也調用了init()方法完成了初始化的工作。因此就接著執行這句代碼: handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));具體標籤解。

 public class NamespaceHandlerSupport { @Override @Nullable public BeanDefinition parse(Element element, ParserContext parserContext) { BeanDefinitionParser parser = findParserForElement(element, parserContext); return (parser != null ? parser.parse(element, parserContext) : null); } @Nullable private BeanDefinitionParser findParserForElement(Element element, ParserContext parserContext) { // 解析出<battcn:application /> 中的application String localName = parserContext.getDelegate().getLocalName(element); BeanDefinitionParser parser = this.parsers.get(localName); if (parser == null) { parserContext.getReaderContext().fatal( "Cannot locate BeanDefinitionParser for element [" + localName + "]", element); } return parser; }}

簡單來說就是從parsers 中尋找到ApplicationBeanDefinitionParser 實例，並調用其自身的doParse 方法進行進一步解析。最後就跟解析默認標籤的套路一樣了…

總結

熬過幾個無人知曉的秋冬春夏，撐過去一切都會順著你想要的方向走…

好了，以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，如果有疑問大家可以留言交流，謝謝大家對武林網的支持。

說點什麼

全文代碼：https://gitee.com/battcn/battcn-spring-source/tree/master/Chapter2

相關文章