DOM 是 Document Object Model 的縮寫,提供了與 XML 互動的標準程式設計模型:
因此 DOM API 成為應用程式與 XML 文件之間溝通的橋樑。
W3C 的 DOM Level 1 規範定義了兩組程式介面:
所有 XML 處理程式都必須支援 Unicode 的兩種編碼形式:UTF-8 與 UTF-16。XML Parser 可以讀取使用 ISO-8859-1、Big-5 或 Shift-JIS 編碼的文件,並在載入時自動轉換為 Unicode。
如果文件使用的編碼不是 UTF-8(8 位元 ASCII 文字也可視為可接受的 UTF-8)或 UTF-16,就必須在 XML 宣告中提供編碼宣告,否則 Parser 可能出錯。即使宣告了,Parser 也可能不支援該編碼,但至少能正確給出提示訊息——因為 XML 宣告本身是用基本 ASCII 文字寫的,Parser 讀得出來。
MSXML(Microsoft XML Core Services)是 Microsoft 提供的 XML 文件處理 COM 庫。MSXML DOM 不只實作了 W3C DOM Level 1 的基本與擴展介面,還額外提供方法支援 XSLT、XPath、名稱空間與資料型別。它支援的編碼格式比規範要求更多,內部則一律使用 Unicode UCS-2 處理文件中的所有文字。
本文以 Visual C++ 6.0 為開發環境,介紹 MSXML 4.0 SDK 中 DOM 的用法。(MSXML 中的 SAX 也相當常用。)
MSXML DOM 是本文重點。它在記憶體中提供 XML 文件的完整表示,允許對整個文件內容做隨機存取,讓應用程式得以依賴 Parser 提供的邏輯結構來處理 XML 資訊。
當 MSXML Parser 把一個 XML 文件載入 DOM 時,它從頭到尾讀完整份文件,並建構內在的邏輯樹結構。文件本身被視為包含其他所有節點的單一節點,例如它包含根元素,而根元素則包含文件中所有的元素、屬性與文字節點。
DOM 樹中每個節點都有特定型別(元素、屬性、文字等),也有指向父節點與子節點的成員。其中屬性節點是特殊節點——它不是子節點,而是屬於某個元素的屬性。
有些情況下,用 SAX(Simple API for XML)反而會是更好的選擇。DOM 的好處是开发者可以借用 MSXML 維護的 DOM 樹,不必自己管理;但當你追求更高效率、只需要讀進文件而後在程式內部自建資料結構來管理資訊時,就該考慮 SAX。
早期的 MSXML 版本,特別是 2.5 與 3.0,可以透過 xmlinst.exe 以替換模式安裝。替換模式下,新版本會取代舊版本成為預設的 XML Parser;當你在程式中使用「版本無關」的 CLSID 與 ProgID 時,被呼叫的就是這個預設 Parser。這常常導致舊程式的相容性問題。
正是基於這個原因,MSXML 4.0 只能以 Side-by-side 模式安裝。xmlinst.exe 在 4.0 中已不再提供,也不適用。
Side-by-side 模式的意義是:它會保護那些使用 msxml.dll、msxml2.dll 或 msxml3.dll 的應用程式不受干擾,仍可照常運作;同時讓你自己決定要用哪個版本的 Parser,這是在程式碼裡指定的。
從 Microsoft 下載中心取得安裝程式後,它會在機器上裝三個檔案並註冊 msxml4.dll:msxml4.dll、msxml4a.dll、msxml4r.dll。
也可以手動安裝:把三個 DLL 複製到系統目錄(%systemroot%\system32,一般是 C:\Windows\system32),然後開命令提示字元執行:
cd C:\Windows\system32
regsvr32 msxml4.dll
安裝完成後,應用程式必須使用版本相關的 CLSID 與 ProgID 來顯式地實例化 Parser,這樣才能確保程式的穩定性。
下面的範例會動態產生一份 XML 文件,接著對它進行查詢。
有兩種方式把 MSXML 的標頭檔與庫檔帶進 VC6.0 專案。
自動方式——在原始碼加兩行即可:
#import <msxml4.dll>
using namespace MSXML2;
手動方式:
inc 與 lib 兩個子目錄。<msxml2.h>。msxml2.lib 加入要連結的庫。採自動方式時,會在專案目錄(或 Debug/Release 目錄)下產生兩個檔案:msxml4.tlh(標頭宣告)與 msxml4.tli(inline 函式定義)。
後面的程式會動態產生下面這份文件,再對它做查詢。
<?XML version="1.0" encoding="utf-8"?>
<!-- Sample XML file created using XML DOM object. -->
<request>
<identification>
<userName>tyc</userName>
<password>pwd</passWord>
</identification>
<commandLines count="2" reply="no" immediate="yes">
<command num="1">
<type>backup</type>
<dbName>db1359</dbName>
</command>
<command num="2">
<type>save</type>
<data><![CDATA[這裡是 XML 文件的 CDATA 資料段...]]></data>
</command>
</commandLines>
</request>
與其他 COM 技術一樣,MSXML 使用參考計數來管理 DOM 物件的生命週期。當你使用 MSXML 的 COM 裸介面指標時,必須自己負責處理參考計數:呼叫 AddRef 增加,呼叫 Release 減少。
例如呼叫 IXMLDOMDocument::createNode、IXMLDOMNode::appendChild 或 CoCreateInstance 建立或取得物件時,物件的參考計數已經在函式返回前增加了,而你有責任在用完這些指標後呼叫 Release 釋放。如果你複製一個既有物件的參考,就必須呼叫 AddRef 相對地增加計數。
MSXML 的成員函式有兩類:
你可以在產生的 msxml4.tli 檔中看到這種封裝關係。
#include <iostream>
#include <string>
#include <cassert>
using namespace std;
#import <msxml4.dll>
using namespace MSXML2;
bool generateXMLSampleFile(const string& path);
bool queryXMLSampleFile(const string& path);
int main()
{
// 初始化 COM 庫
CoInitialize(NULL);
// 建立 XML 檔及其內容
if (!generateXMLSampleFile("sample.XML"))
cout << "Failed" << endl;
// 載入剛產生的 XML 檔,輸出到標準輸出
IXMLDOMDocument2Ptr pXMLDom;
HRESULT hr = pXMLDom.CreateInstance(__uuidof(DOMDocument40));
if (FAILED(hr)) {
cout << "Failed to instantiate DOMDocument40 class!" << endl;
return -1;
}
if (pXMLDom->load("sample.XML") != VARIANT_TRUE) {
cout << "Failed load XML data from file: "
<< static_cast<char*>(pXMLDom->parseError->Getreason())
<< endl;
return -1;
}
// 輸出 XML 內容(奇怪的是檔案頭中沒有編碼宣告)
cout << static_cast<char*>(pXMLDom->XML) << endl;
pXMLDom.Release(); // 注意:不能用 pXMLDom->Release() 這種形式!
// 對剛產生的 XML 檔進行查詢
cout << "---------------------------------------" << endl;
cout << "Start query..." << endl;
queryXMLSampleFile("sample.XML");
CoUninitialize();
return 0;
}
最後那行註解值得留意:對 _Ptr 智慧指標呼叫 Release 要寫 pXMLDom.Release(),而不是 pXMLDom->Release()。兩者行為不同,寫錯會造成參考計數處理不當。
如果是遍歷一份結構事先未知的 XML 文件,做法是:
IXMLDOMDocumentPtr::documentElement 取得根元素。IXMLDOMNodePtr 的 firstChild 與 nextSibling 逐一走訪所有子節點。nodeType 判斷節點型別(元素、屬性、文字等)。text 取得文字值,用 nodeName 取得節點名稱。IXMLDOMDocumentPtr、IXMLDOMNodePtr 的 xml 成員取得對應的 XML 字串。更詳細的說明請參考 MSXML 4.0 SDK 文件。
動態建立文字節點有大小上限。在我的機器上以預設 VC 設定測試,動態建立的 text 節點寫入 256K 資料正常,寫 512K 就 Stack Overflow 了。但載入 XML 文件時沒有這個問題,不受此限制。也就是說,大量資料該走「從檔案載入」而不是「在程式中逐節點塞進去」。
輸出時編碼宣告可能消失。如上例所示,把載入的 XML 重新取出來印,XML 宣告中的 encoding 部分不見了。這是 DOM 物件的行為特性,若你的下游程式依賴編碼宣告,要記得自己補上。
最後,使用 MSXML DOM 時請時刻記住:它內部就是一棵樹,任何資料都是以節點形式存在的。理解這一點,API 的行為就都能推導出來了。