前言
在 上一節 spring解密 - 默認標簽的解析 中，重點分析了 spring 對默認標簽是如何解析的，那么本章繼續講解標簽解析，著重講述如何對自定義標簽進行解析。話不多說了，來一起看看詳細的介紹吧。
自定義標簽
在講解 自定義標簽解析 之前，先看下如何自定義標簽
定義 xsd 文件
定義一個 xsd 文件描述組件內容
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
<?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 文件中的定義和組件定義
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
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 抽象類
|
1
2
3
4
5
6
|
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
|
1
|
http\://www.battcn.com/schema/battcn=com.battcn.handler.battcnnamespacehandler |
spring.schemas
|
1
|
http\://www.battcn.com/schema/battcn.xsd=battcn.xsd |
4.使用自定義標簽
申明 bean.xml 文件，定義如下
|
1
2
3
4
5
6
7
|
<?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 字眼，說明自定義標簽一切正常
|
1
2
3
4
5
6
7
|
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.如圖所示
源碼分析
自定義標簽解析入口
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
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) 校驗的時候在將緩存的內容提取出來做對比
|
1
2
3
4
5
6
7
8
|
public class xmlbeandefinitionreader { public namespacehandlerresolver getnamespacehandlerresolver() { if (this.namespacehandlerresolver == null) { this.namespacehandlerresolver = createdefaultnamespacehandlerresolver(); } return this.namespacehandlerresolver; }} |
resolve
1.加載指定的 namespacehandler 映射，并且提取的 namespacehandler 緩存起來，然后返回
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
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)); 具體標簽解。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
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
原文鏈接：http://blog.battcn.com/2018/01/12/spring/spring-3/
