DOM 模型在 MSXML 類別庫中,主要體現為把 XML 文件導入記憶體,形成一個 IXMLDOMDocument,再把其中每個部件都用一個介面對應起來(至於用 MSXML 進行 XSLT 格式化,這裡暫且不談)。先看一段包含 XML 基本部件的文字:
(1) <?xml version='1.0' encoding='GB2312'?>
(2) <?xml-stylesheet type='text/xsl' href='/expert/Xsl/2.xsl'?>
(3) <body>
(4) <code1 id="text">文本</code1>
(5) <code2 id="cdata">
(6) <![CDATA[
(7) 這裡是 CDATA 的內容,可以放類似 '<' 等可能與 XML 控制資訊衝突的內容
(8) ]]>
(9) </code2>
(10) </body>
方便起見,我在最左側標上了行號。第 (1)~(10) 行共同構成一個 Document,對應 MSXML 中的 IXMLDOMDocument 介面;第 (1)、(2) 行對應 IXMLDOMProcessingInstruction;第 (3) 到 (10) 行則是一個 Root Element,對應 IXMLDOMElement,其中 (3) 內還包含多個同為 element 的子元素,只是層級在 body 之下。要注意的是 Root 只能有一個,其下無論多深,理論上允許無限多層,也允許名稱重複。
(4) 與 (5) 裡各有一個 id="?",這是一個 attribute(屬性),對應 MSXML 裡的 IXMLDOMAttribute(其實 (1)、(2) 行的 version、encoding、type、href 等也是)。(4) 裡的「文本」乍看之下和 (7) 行差不多,都是文字資訊,很多人以為都能用 get_text() 直接取得——其實不然。「文本」可以透過 (4) 這個 element 直接 get_text() 取得,對應 IXMLDOMText;但若對 (5) 這個 element 直接 get_text() 就會出錯,因為 CDATA 是不同於「文本」的另一種類型,對應 IXMLDOMCDATASection,取得方式後述。
於是整個 XML 的基本框架大致成形:
<IXMLDOMDocument>
<IXMLDOMProcessingInstruction />
<IXMLDOMProcessingInstruction />
<IXMLDOMElement (根,只能有一個)>
<IXMLDOMElement IXMLDOMAttribute>IXMLDOMText</IXMLDOMElement>
<IXMLDOMElement IXMLDOMAttribute>IXMLDOMCDATASection</IXMLDOMElement>
</IXMLDOMElement>
</IXMLDOMDocument>
但不少 MSXML 教學還會用到另一個介面 IXMLDOMNode,這是怎麼回事?它和 IXMLDOMElement 又有什麼關係?長久以來我常在這裡搞混,以致進展停滯。最近要在 C++Builder 5 下使用 XML 解析,卻沒有 TXMLDocument 控制項,想自行封裝 MSXML 的部分用法時,才發現其中奧妙。
在 DOM 模型中,Document、ProcessingInstruction、Attribute、Element、TextNode、CDATASection 等都被視為一個個 Node;在 MSXML 的實作中,這些物件都從 Node 派生而來。要理解 Node 與這些介面的關係,關鍵在於看清各介面之間的派生關係。之所以要加上 Node 這個介面,是為了把 XML 各要素彼此連結起來,不至於鬆散。
再加上另外兩個介面 IXMLDOMNodeList 與 IXMLDOMNamedNodeMap。其中 NamedNodeMap 主要用於連結同一個 Element 的各 Attribute(因為同一 Element 的屬性必須兩兩不衝突),而 NodeList 則用於連結 ProcessingInstruction、Element、TextNode、CDATASection 等其他要素(這些要素在同一層允許相同名稱重複出現)。這裡沒把 Document 包括在內,因為它是整個 XML 的第一個 Node,不可能也不允許出現在 NodeList 或 NamedNodeMap 之下。
把 MSXML 的 Document 作為第一個 Node,然後透過 NamedNodeMap 遍歷該層的所有 Attribute,再透過 NodeList 遞迴循環下一層的所有 Node,就會看到這樣的樹狀結構(屬性在該行括號列出,縮排代表所在層):
#document
xml (version; encoding)
xml-stylesheet (type; href)
body
code1 (id)
#text
code2 (id)
#cdata-section
從上面可以看出,TextNode 與 CDATASection 是被當作 Element 的下一層 Node 來處理的。get_text() 只是為了方便使用 TextNode 的捷徑;對 CDATASection 用 get_text() 存取會出錯,此時可考慮透過下一層 Node 的第一個 Node 來取得:
MSXML::IXMLDOMNodePtr child;
child = parent->childNodes->get_item(0);
if (child != NULL)
text = child->get_nodeValue();
在遞迴循環時,通常無法預先知道某個 Node 究竟是什麼型別。要知道它是 Element、TextNode 還是其他類型,可以透過 IXMLDOMNode::nodeType 取得,這是一個列舉型別,取值如下(從中也可看出上面的 XML 並未涵蓋所有要素):
NODE_ELEMENT (1)
NODE_ATTRIBUTE (2)
NODE_TEXT (3)
NODE_CDATA_SECTION (4)
NODE_ENTITY_REFERENCE (5)
NODE_ENTITY (6)
NODE_PROCESSING_INSTRUCTION (7)
NODE_COMMENT (8)
NODE_DOCUMENT (9)
NODE_DOCUMENT_TYPE (10)
NODE_DOCUMENT_FRAGMENT (11)
NODE_NOTATION (12)
最棘手的問題是如何用路徑定位到較深的節點。用遞迴函數來實現完全沒必要,算是多此一舉。DOM 模型本身提供的 IXMLDOMNode::SelectSingleNode 與 IXMLDOMNode::SelectNodes(XPath)已能实现比遞迴更完善的功能。以下簡述 SelectSingleNode 的用法(msdom 為 IXMLDOMDocument 實例):
MSXML::IXMLDOMNodePtr parent, child;
parent = msdom->documentElement;
// child 為 code1 型別的 Element
child = parent->selectSingleNode("/code1");
// child 為 code1 的 id 屬性
child = parent->selectSingleNode("/code1/@id");
// child 為名為 code1 且 id='text' 的那個 Element
child = parent->selectSingleNode("/code1[@id='text']");
更高深的用法屬於 XPath 範疇,這裡先擱置。
為了在 C++Builder 5 下封裝出類似控制項,我查了一些資料,發現 MSXML、OpenXML 等 DOM 解析器其實是同一套介面,只是內部實作不同。TXMLDocument 可透過設定 Vendor 選用不同解析器,但使用方法完全相同。預設似乎使用 MSXML 解析。比較而言:MSXML 需在用戶端註冊較新的 msxml.dll;SAX 需附帶較大的 dll;OpenXML 因為直接用一個 .pas 檔編譯,直接生成進可執行檔。
用 IEnum 遍歷有點殺雞用牛刀,現在可以這樣寫:
for (int i = 0; i < nodelist->get_length(); i++)
{
child = nodelist->get_item((long)i);
name = child->get_nodeName();
}
當初不知道 Node 與 Element 的關係,胡亂執行下面的轉換,結果轉出的 element 為 NULL,就以為此路不通:
IXMLDOMElementPtr element = (IXMLDOMNodePtr)node;
而後來補的 appendChild 操作,把 createElement 出來的 Element 直接轉成 Node 再 appendChild——其實這是基礎的 C++ 知識,關鍵在於看清 MSXML 的 COM 實作也用了同樣的技巧。
最初想到用 import 語句:
#import "C:\Windows\System32\MSXML.DLL" named_guids
但 import 進來能生成 tlb 與 tlh 檔,編譯卻過不了,總提示缺少些什麼或有函數無法導出(對了,可以在 VC++ 裡 import,再把生成的 tlb、tlh 複製到 C++Builder 專案)。於是改用 C++Builder 自帶的 TVariant 類進行 COM 實例化,呼叫函數與屬性(OleFunction、OlePropertyGet、OlePropertySet):
TVariant varMSDOM = CreateOleObject("MSXML.DOMDocument");
varMSDOM.OleFunction(L"load", L"c:\tmp.xml");
TVariant varDoc = varMSDOM.OlePropertyGet("documentElement");
直覺上,這種呼叫方式會比 import 慢:import 直接透過虛函數表查找函數指標進行呼叫,而 OleFunction 則透過 IDispatch 介面的 invoke 函數間接呼叫,且無法呼叫 import 進來那些帶 name_guids 的函數,如 get_nodeName(BSTR *)。無論如何,透過 TVariant 基本能滿足函數呼叫的需求。
接著我發現 C++Builder 的 Project 選單有「Import From Type Library」,也試了一下。tlb 與 tlh 都生成了,加入專案也能編譯通過,但 tlh 裡的定義與呼叫方式和 VC 的 import 略有不同:
1. VC 裡的實例化直接用智慧指標:
MSXML::IXMLDOMDocumentPtr msdom;
msdom.CreateInstance(__uuidof(MSXML::DOMDocument));
C++Builder 則透過另一個封裝物件來實現:
TComIXMLDOMDocument i_XMLdocument = CoDOMDocument::Create();
IXMLDOMDocumentPtr msdom = (IXMLDOMDocumentPtr) i_XMLdocument;
其中 TComIXMLDOMDocument 的定義可在 MSXML2_TLB.h 找到:
typedef TComInterface<IXMLDOMDocument> TComIXMLDOMDocument;
2. C++Builder 裡雖也有 IXMLDOMDocumentPtr msdom,但這個指標不能直接用來判斷是否等於 NULL,否則編譯器會報錯,應改為:
if ((IXMLDOMDocument *)msdom == NULL)
以上在 C++Builder 下使用 MSXML 的經驗,延伸到其他型別的 COM 自動化,應該也不會有太大問題。