本文涵蓋:XmlLite 與其他 XML 解析方案的比較、優勢與限制、XML 的讀取與寫入,以及 XML 安全設計。
涉及技術:XML、C++
即使 .NET Framework 一路成功,Microsoft 仍舊認真看待本機 C++ 開發,XmlLite 就是最好的證明——一個專為本機 C++ 應用設計的高效能、低負擔 XML 讀取器與寫入器。
受控程式碼透過 System.Xml 命名空間廣泛支援 XML,而傳統的 Visual Basic 與 C++ 應用則依賴 COM,使用 MSXML 的對等能力。但對需要「快而精簡」的本機 C++ 開發者來說,這兩條路都不太對味。XmlLite 就是為這個缺口而來。
先談它不提供什麼,好把預期設定在正確的位置。這個初始版本沒有 DOM 實作,沒有 XML 結構描述或 DTD 驗證,也不支援 XPath 這類以游標為基礎的導航、樣式表與序列化。不過這些空白都能靠在其之上自行補上——正如 .NET Framework 裡幾乎所有 XML 功能,其實也都建立在 XmlReader 與 XmlWriter 這兩個類別之上。
那麼它提供了什麼?一句話:非快取的只進(forward-only)解析器,加上非快取的只進 XML 產生器。這兩個看似樸素的能力,實務上被證明極有價值。
先看看現有的選項。
如果你的應用已經在用 .NET Framework,答案很單純:直接用 System.Xml 就好。事實上 XmlLite 的設計正是以 XmlReader 與 XmlWriter 為藍本,主要型別幾乎一一對應(IXMLReader 對應 XmlReader、IXMLWriter 對應 XmlWriter、XMLReaderProperty 對應 XmlReaderSettings、XMLWriterProperty 對應 XmlWriterSettings,編碼則對應 Encoding 類別)。反過來說,以 C++ 寫成的受控應用改用 XmlLite 通常拿不到好處,畢竟 XmlReader 與 XmlWriter 能做的事多得多。
若應用純粹是本機碼,就 Microsoft 技術而言,傳統上的答案是 MSXML。它其實提供了兩個差異很大的解析器:
SAX2 存在的理由很明確:與 DOM 不同,它以資料流方式讀文件,逐節點通知你,因此記憶體用量不隨文件大小線性成長。
問題也出在這個模型的內在複雜度。它逼你實作介面、註冊事件,採用一種更間接的程式風格,還得自己管理一堆狀態——而這些狀態正是讓應用膨脹的原因。相對地,.NET 的 XmlReader/XmlWriter 與 XmlLite 的 IXmlReader/IXmlWriter 把解析器做成可以直接在函式裡使用的樣子,不必管理任何外部狀態或註冊通知。
也因為設計簡潔,XmlLite 的效能相當好,即使與 MSXML 的 SAX2 實作相比也不落下風;而 SAX2 雖然比 DOM 更能處理大文件,與 XmlLite 相比仍遜一籌。
結論:XmlLite 優於 MSXML,而且更好用。MSXML 仍將是 Visual Basic 與 COM 腳本語言的最佳解,但本機 Visual C++ 終於有了為自己設計的解析器。XmlLite 隨 Windows Vista 與後續版本一起出貨,Windows XP 與 Windows Server 2003 的 32 位元與 64 位元版本也有可下載的更新。由於不涉及 COM 註冊,這個更新套件不會帶來 MSXML 常見的安裝與版本控管夢魘。
XmlLite 不只是個好記的名字,它真的是個輕量級解析器。它取用了 COM 的精華——程式設計規範與慣例——並丟掉複雜且往往不必要的部分:COM 註冊、執行期服務、proxy、執行緒模型、封送處理等等。
讀取器與寫入器由 XmlLite.dll 直接匯出的函式建立。你只要連結 XmlLite.lib、包含 Windows SDK 中的 XmlLite.h 就能使用。產生的 COM 風格介面沿用熟悉的 IUnknown 方法做生命週期管理,並以 COM 的 IStream 介面表示儲存體。除此之外再無 COM 依賴:不必註冊任何 COM 類別,也不必呼叫 CoInitialize。剩下那一點 COM 由 ATL 的 CComPtr 類別模板接手。
唯一要留心的是執行緒安全:為了在單執行緒情境下換取效能,XmlLite 並非執行緒安全。
以下範例用一個 COM_VERIFY 巨集標出需要檢查 HRESULT 的方法呼叫,你可以換成自己慣用的錯誤處理方式,不論是丟例外還是回傳 HRESULT。
XmlLite 提供 CreateXmlReader 函式,回傳 IXmlReader 介面的實作:
CComPtr<IXMLReader> reader;
COM_VERIFY(::CreateXmlReader(__uuidof(IXMLReader),
reinterpret_cast<void**>(&reader),
0));
CComPtr 雖為可選,但它能確保介面指標被迅速釋放。
CreateXmlReader 接受介面識別碼(IID)與一個 void 指標的指標。這是 COM 常見的模式,讓呼叫方指定要取回的介面指標型別;範例中的 __uuidof 是 Microsoft 特有的關鍵字,用來取出型別對應的 GUID,這裡取的是介面的 IID。最後一個參數可接受選擇性的 IMalloc 實作,讓呼叫方接管記憶體配置。
建立讀取器後,要指定輸入的儲存體。IStream 代表儲存體,因此 XmlLite 能與你自行設計的任何流搭配:
CComPtr<IStream> stream; // 在此建立 stream 物件... COM_VERIFY(reader->SetInput(stream));
設定好輸入,就能重複呼叫 Read 逐節點讀取。Read 有一個選擇性參數會在每次成功呼叫時回傳節點型別;回傳 S_OK 表示成功讀到下一個節點,S_FALSE 表示已達流末端:
HRESULT result = S_OK;
XmlNodeType nodeType = XmlNodeType_None;
while (S_OK == (result = reader->Read(&nodeType)))
{
// 取得該節點的專屬資訊
}
要列舉目前節點的屬性,用 MoveToFirstAttribute 與 MoveToNextAttribute。成功移動回 S_OK,沒有更多屬性則回 S_FALSE:
for (HRESULT result = reader->MoveToFirstAttribute();
S_OK == result;
result = reader->MoveToNextAttribute())
{
// 取得該屬性的專屬資訊
}
呼叫 Read 時,XmlLite 會把該節點的所有屬性快取在內部集合中,因此你也可以用 MoveToAttributeByName 依名稱跳到特定屬性。不過實務上,逐一列舉屬性並存進自己的資料結構通常更有效率。另外,GetAttributeCount 可以告訴你目前節點有幾個屬性。
定位好節點或屬性之後,取資訊就很直接。以下示範取得命名空間 URI 與區域名稱:
PCWSTR namespaceUri = 0;
UINT namespaceUriLength = 0;
COM_VERIFY(reader->GetNamespaceUri(&namespaceUri,
&namespaceUriLength));
PCWSTR localName = 0;
UINT localNameLength = 0;
COM_VERIFY(reader->GetLocalName(&localName,
&localNameLength));
所有回傳字串的 IXmlReader 方法都遵循這個模式:第一個參數接受「寬字元指標常數的指標」,第二個參數可選,不為零時會回傳以字元計量的長度(不含 null 結束字元)。
這裡有個與效能高度相關的細節:由 IXmlReader 方法取回的字串指標,只在讀取器尚未移到別的節點之前有效——也就是說,在你呼叫 Read、設定新的輸入流、或釋放 IXmlReader 介面前。換句話說,IXmlReader 不會把資料流的複本交給呼叫方。
與 .NET 的對應物不同,IXmlReader 沒有任何讀取「具型別內容」的方法。若某個元素或屬性裡是數字或日期,你得先取得字串形式再自行轉換。XmlReader 上許多便利的 helper 方法在 IXmlReader 裡也不存在,但它們都能寫成 helper 函式補上。XmlLite 確實忠實遵循了 C++ 「最小介面」的設計哲學。
圖 2 讀取器:使用 IXmlReader 讀取 XML 文件時牽涉的物件與抽象。IStream 可以包裝任何儲存體,圖中的檔案只是一個常見例子。
對應的 CreateXmlWriter 函式回傳 IXmlWriter 介面的實作:
CComPtr<IXMLWriter> writer;
COM_VERIFY(::CreateXmlWriter(__uuidof(IXMLWriter),
reinterpret_cast<void**>(&writer),
0));
接著指定輸出的儲存體:
CComPtr<IStream> stream; // 在此建立 stream 物件 COM_VERIFY(writer->SetOutput(stream));
開始寫入前可以調整寫入器屬性,可用的項目定義在 XmlWriterProperty 列舉中。例如要讓輸出的 XML 加上縮排以便閱讀:
COM_VERIFY(writer->SetProperty(XMLWriterProperty_Indent, TRUE));
接著就能用 IXmlWriter 的各個方法往基礎流寫入。XmlLite 支援 XML 片段;若要寫出完整文件,應從 WriteStartDocument 開始,由它負責寫出 XML 宣告。宣告內容取決於使用的編碼,預設是 UTF-8,在大多數情況下都合適。此外還有一整套 WriteXxx 方法,用於寫入各類節點、屬性與值。
COM_VERIFY(writer->WriteStartDocument(XmlStandalone_Omit));
COM_VERIFY(writer->WriteStartElement(0, L"Html",
L"https://www.w3.org/1999/xhtml"));
COM_VERIFY(writer->WriteStartElement(0, L"head", 0));
COM_VERIFY(writer->WriteElementString(0, L"title", 0, L"My Web Page"));
COM_VERIFY(writer->WriteEndElement()); // </head>
COM_VERIFY(writer->WriteStartElement(0, L"body", 0));
COM_VERIFY(writer->WriteElementString(0, L"p", 0, L"Hello world!"));
COM_VERIFY(writer->WriteEndDocument());
WriteStartDocument 把 XML 宣告寫進流,唯一參數取自 XmlStandalone 列舉,用來指示是否出現 standalone 宣告、以及它的值為何。寫片段時通常就省略這一步。
WriteStartElement 有三個參數:元素的前綴(可選)、區域名稱、命名空間 URI(可選)。
WriteElementString 是 XmlLite 很方便的一個方法。以下寫出 XHTML 標題的寫法,與上一段範例中那一行完全等價:
COM_VERIFY(writer->WriteStartElement(0, L"title", 0)); COM_VERIFY(writer->WriteString(L"My Web Page")); COM_VERIFY(writer->WriteEndElement());
顯然 WriteElementString 不是必要的,但它確實好用。
最後,WriteEndDocument 負責收尾。你應該注意到,範例裡並沒有明確關閉 body 與 Html 元素——WriteEndDocument 會自動關掉所有還開著的元素;釋放寫入器也會關掉剩餘的元素。但要小心:這種「不顯式關閉」的習慣可能出問題,因為流的存活期與寫入器的存活期往往不同。若你確定要把所有內容都落進基礎流,呼叫 IXmlWriter 的 Flush 即可。
圖 3 寫入器:使用 IXmlWriter 寫入 XML 文件時牽涉的物件與抽象流。
前面對流著墨不多。與功能更完整的 XML 資料庫相比,XmlLite 不提供任何「從檔案或網路協定讀寫」的能力;正因為如此,不論要讀或要寫哪種儲存體,都得由你提供 IStream 實作。
實作 IStream 並不難,但很多時候不必自己來,因為現成的已經有了。
CreateStreamOnHGlobal 提供由虛擬記憶體支援的 IStream 實作。第一個參數是可選的記憶體控制碼(以 GlobalAlloc 建立),但直接傳零,它就會幫你配置記憶體物件。以下建立一個由系統記憶體支援、並會隨需要動態成長的 IStream:
CComPtr<IStream> stream; COM_VERIFY(::CreateStreamOnHGlobal(0, TRUE, &stream));
釋放這個流,記憶體一併釋放。
另一個實用選擇是 SHCreateStreamOnFile,它建立由檔案支援的 IStream:
CComPtr<IStream> stream;
COM_VERIFY(::SHCreateStreamOnFile(L"D:\\Sample.XML",
STGM_WRITE | STGM_SHARE_DENY_WRITE,
&stream));
XmlLite 寫入時預設使用 UTF-8,讀取時則會主動偵測編碼。它會先看 XML 前導位元組的位元組順序標記(BOM)來抓編碼提示,也接受 XML 宣告中指定的編碼——這兩點是任何 XML 解析器都該具備的基本功。
如果輸入流完全沒有編碼資訊,而 XmlLite 也無法探測,你可以明確指定編碼(以 code page 或編碼名稱表示)。做法是在把流交給 IXmlReader 之前,先包上一層 IXmlReaderInput 物件。兩個建立函式分別是 CreateXmlReaderInputWithEncodingCodePage(接受 code page 編號)與 CreateXmlReaderInputWithEncodingName(接受正規名稱),簽名除此之外完全相同。
一般情況下,讀取器的輸入這樣設定即可:
CComPtr<IStream> stream; // 在此建立 stream 物件 COM_VERIFY(reader->SetInput(stream));
要覆寫編碼,改成:
CComPtr<IStream> stream;
// 在此建立 stream 物件
CComPtr<IXMLReaderInput> input;
COM_VERIFY(::CreateXmlReaderInputWithEncodingName(stream,
0, // 預設配置器
L"ISO-8859-8",
TRUE, // 視為提示
0, // base URI
&input));
COM_VERIFY(reader->SetInput(input));
參數依序是:要讀取的流;選擇性的 IMalloc 實作(提供時會覆寫讀取器自己的實作);編碼名稱(MSDN 文件列出了原生支援的清單,若要其他編碼則需提供 IMultiLanguage2 介面實作);以及「是否強制使用該編碼」的旗標。傳 TRUE 代表這只是建議——分析器會先試這個編碼,失敗時仍可自行探測實際編碼;傳 FALSE 則代表強制,若與輸入流不符就回傳錯誤。倒數第二個參數是可選的基底 URI,用於解析外部實體;最後一個參數回傳要交給 SetInput 的輸入物件介面指標。
寫入器會依傳給 SetOutput 的物件決定編碼。若該物件實作了 IStream(或甚至只實作有限的 ISequentialStream),寫入器就使用 UTF-8。要改寫這個行為,同樣是包一層輸出物件:CreateXmlWriterOutputWithEncodingCodePage 接受 code page 編號,CreateXmlWriterOutputWithEncodingName 接受正規名稱,兩者簽名相同。
預設寫法:
CComPtr<IStream> stream; // 在此建立 stream 物件 COM_VERIFY(writer->SetOutput(stream));
覆寫預設編碼:
CComPtr<IStream> stream;
// 在此建立 stream 物件
CComPtr<IXMLWriterOutput> output;
COM_VERIFY(::CreateXmlWriterOutputWithEncodingName(stream,
0,
L"ISO-8859-8",
&output));
COM_VERIFY(writer->SetOutput(output));
參數依序是:要寫入的流;選擇性的 IMalloc 實作;編碼名稱;最後回傳要交給 SetOutput 的輸出物件介面指標。
為了在讀取大值時壓住記憶體用量,讀取器提供了分塊讀取的機制。ReadValueChunk 一次最多讀取指定數量的字元,並在預期後續呼叫的前提下向前推進讀取器:
CString value;
WCHAR chunk[256] = { 0 };
HRESULT result = S_OK;
UINT charsRead = 0;
while (S_OK == (result = reader->ReadValueChunk(chunk,
countof(chunk),
&charsRead)))
{
value.Append(chunk, charsRead);
}
沒有資料可讀時,ReadValueChunk 回傳 S_FALSE。範例中把區塊寫進 CString 只是為了示範如何掌握區塊長度——實務上這樣做會抵銷分塊本身的意義。
以 XML 為核心的應用必須時時刻刻處理來自不可信來源的 XML。XmlLite 內建了多項防護,用來抵禦已知與未來的攻擊手法。
外部實體。有些解析器會自動解析外部實體,這很方便,但若解析器沒有仔細防護,就可能成為漏洞。XmlLite 既不自動解析外部實體,也不自帶解析器;若有需要,實作 IXmlResolver 介面,並搭配 IXmlReader 的 SetProperty 設定 XmlReaderProperty_XmlResolver 屬性,即可讓讀取器改用你的解析器。
DTD。XML 文件可能含有 DTD 處理指示。XmlLite 雖不支援以 XML 結構描述或 DTD 驗證文件,但支援 DTD 實體展開與預設屬性;由於 DTD 可能引用外部實體,這也構成攻擊面。因此 XmlLite 預設停用 DTD 處理,需將 XmlReaderProperty_DtdProcessing 設為 DtdProcessing_Parse 才會啟用。此外還有一項針對 DTD 實體展開攻擊(俗稱 billion laughs)的內建緩解:XmlReaderProperty_MaxEntityExpansion,預設值為 100,000。
超長名稱。攻擊者可以刻意送出名稱極長的文件,若不加限制,可能吃掉大量記憶體並造成阻斷服務攻擊。明顯的解法就是前面提過的分塊讀取大值;另一個有效做法是提供限制記憶體配置的自訂 IMalloc 實作。若輸入流支援隨機存取,還可以用 XMLReaderProperty_RandomAccess 屬性讓讀取器不額外快取屬性——這會減少讀取起始標記時的記憶體用量,但可能拖慢解析速度,因為分析器得來回搜尋才能取出各屬性值。
階層過深。XML 階層太深同樣會迅速耗盡系統資源。用 XMLReaderProperty_MaxElementDepth 限制分析器允許的深度即可,預設為 256。
XmlLite 為本機 C++ 應用提供了功能完整的 XML 解析能力。它以效能為導向,清楚自己耗用了多少系統資源,並在這些特徵上給了開發者很大的控制彈性。它支援所有常見文字編碼,是簡化本機 C++ 應用 XML 處理的實用工具。更多細節可參考 MSDN 上的 XmlLite 文件(ms752872)。
本文作者 Kenny Kerr 是專注於 Windows 軟體開發的軟體專家,熱衷於撰寫程式設計與軟體設計文章,並樂於把知識傳授給開發者社群。