XML 正一步步滲透進每一個技術棧,.NET Framework 自然也不例外。本文說明 .NET Framework 中負責處理 XML 文檔的那些 API 各自扮演什麼角色、內部有何特性,並示範幾個最常見的用法。
在 .NET Framework 出現之前,你多半用過 MSXML 服務——一個基於 COM 的類庫——來寫 Windows 上的 XML 驅動程式。與 .NET Framework 中的類不同,MSXML 的部分代碼比 API 更深,深深嵌在作業系統底層。MSXML 確實能與你的應用程式溝通,卻無法真正與外部環境融合。
MSXML 類庫既能在 Win32 中引入,也能在 CLR 中運用,但它始終只能作為一個外部伺服器組件。而基於 .NET Framework 的應用程式可以直接使用 XML 類,與其他命名空間整合,寫出來的代碼也更易讀。
作為獨立組件,MSXML 解析器提供了諸如異步解析之類的高級特性,而這些在 .NET 的 XML 類中並未直接提供。不過,.NET 的 XML 類與其他類整合後能輕易達到相同效果,並在此基礎上擴充更多功能。
.NET Framework 中的 XML 類提供了 XML 數據的基本分析、查詢與轉換能力:支持 XPath 查詢與 XSLT 轉換的類、讀寫 XML 文檔的類,此外還有序列化(XmlSerializer、SoapFormatter)、應用程式配置(AppSettingsReader)、數據存儲(DataSet)等。本文只聚焦於實現基本 XML I/O 的那幾個類。
既然 XML 是一種標記語言,就需要一個工具依既定語法解析並理解文檔中的資訊——這就是 XML 解析器:讀取標記文本,回傳特定平台上的物件。
不論哪個平台的解析器,大致都分兩類:基於樹與基於事件。它們通常以 XMLDOM(Microsoft XML Document Object Model)與 SAX(Simple API for XML)的形式出現。XMLDOM 把文檔視為記憶體中的樹結構呈現;SAX 則把 XML 數據當成串流,逐元素觸發事件。一般來說,DOM 可以由 SAX 流載入後再執行,所以兩者並非互斥。
整體而言,SAX 與 XMLDOM 幾乎是相反的兩個極端。XMLDOM 的功能集合被完整定義,你無法擴展它;處理大型文檔時,它需要大量記憶體來承載這個龐大的集合。SAX 則把解析事件交給客戶端應用程式的物件實例去處理,由解析器控制整個流程、把數據「推」給處理器,處理器再決定接受或拒絕。這種模式的優點是記憶體佔用極少。
.NET Framework 完全支持 XMLDOM 模式,但不支持 SAX。為什麼?因為它提供了兩種不同的分析模式:XMLDOM 分析器與 XML 閱讀器(reader)。它顯然沒有 SAX 分析器,但這不表示它不具備類似 SAX 的能力——透過 XML 閱讀器,SAX 的所有功能都能實現,而且用得更有效率。不像 SAX 分析器,.NET 的閱讀器整個運行在客戶端應用程式之下,因此應用程式本身可以只把真正需要的數據「拉」出來,然後直接跳出資料流;而 SAX 模式必須把對應用程式有用、沒用的資訊全處理一遍。
閱讀器基於 .NET 的串流模式工作,運作方式類似資料庫的游標。有趣的是,這種游標式解析模式的類,同時也為 .NET 中的 XMLDOM 分析器提供了底層支持。XmlReader 與 XmlWriter 兩個抽象類是所有 .NET XML 類的基礎,包括 XMLDOM 類、ADO.NET 驅動類與配置類。所以你有兩種選擇:直接用 XmlReader/XmlWriter 處理 XML,或者採用 XMLDOM 模式。
XML 閱讀器提供一個編程介面,用於連接 XML 文檔並「推出」你要的數據。深入了解後你會發現,閱讀器的原理類似桌面應用程式從資料庫取數:資料庫服務回傳一個游標物件,它包含整個查詢結果集並指向目標數據集的起始位址;XML 閱讀器的客戶端則收到一個指向閱讀器實例的引用,該實例抽取底層資料流並把數據呈現為一棵 XML 樹。閱讀器類提供只讀、只能向前的游標,你可以用它提供的方法滾動游標,遍歷結果集中的每一筆數據。
從閱讀器的角度看,XML 文檔不是一個標籤文本檔,而是一組序列化的節點集合。這是 .NET 中一種獨特的游標模式,你找不到第二個類似的 API。
閱讀器與 XMLDOM 分析器有幾點差異:閱讀器是只進的,沒有父、子、祖輩、兄弟節點的概念,而且只讀。在 .NET 中,讀與寫是兩種完全不同的功能,分別由 XmlReader 與 XmlWriter 承擔。要編輯 XML,得用 XMLDOM 分析器,或自己設計一個類把兩種能力都實作出來。
XmlReader 是抽象類,你可以繼承並擴展它。實際開發中一般基於三個子類:XmlTextReader、XmlValidatingReader 與 XmlNodeReader。要注意的是,某些屬性的值實際上取決於具體的閱讀器類別。例如 CanResolveEntity 在 XmlValidatingReader 中只回傳 true,在其他閱讀器類中卻可設為 false;某些方法的回傳值也依類別而異,比如當節點型別不是元素節點時,所有含 Attributes 的方法都回傳 void。
XmlTextReader 以只進、只讀的方式快速訪問 XML 資料流。它會先驗證文檔是否格式良好,若否則拋出異常;它檢查 DTD 的格式是否正確,但不使用 DTD 驗證文檔內容。文檔可以從檔名、URL 或串流載入。若你需要驗證數據,請改用 XmlValidatingReader。
建立 XmlTextReader 實例有多種途徑:從硬碟載入檔案、從 URL 載入、從串流載入,或直接把文字讀入:
XmlTextReader reader = new XmlTextReader(file);
所有 XmlTextReader 的公開建構子都要求你指定數據來源(串流、檔案或其他);預設的無參數建構子受保護(protected),不能直接使用。與 .NET 中其他閱讀器類(如 SqlDataReader)一樣,一旦物件連接並打開,就能用 Read 方法訪問數據。開始時先用 Read 把指針移到第一個元素,之後可再用 Read 或其他方法(Skip、MoveToContent、ReadInnerXml)把指針移到下一個節點。要處理整份文檔,用迴圈配合 Read 的回傳值即可:讀到文檔尾端時回傳 false,否則回傳 true。
string GetXmlFileNodeLayout(string file)
{
// 建立 XmlTextReader 並指向目標 XML 文檔
XmlTextReader reader = new XmlTextReader(file);
// 迴圈取出節點文本,寫入 StringWriter
StringWriter writer = new StringWriter();
string tabPrefix = "";
while (reader.Read())
{
// 節點型別為元素時,寫入開始標記
if (reader.NodeType == XmlNodeType.Element)
{
// 依元素所在深度加入對應數量的 tab,再寫入元素名
tabPrefix = new string('\t', reader.Depth);
writer.WriteLine("{0}<{1}>", tabPrefix, reader.Name);
}
else
{
// 節點型別為結束元素時,寫入結束標記
if (reader.NodeType == XmlNodeType.EndElement)
{
tabPrefix = new string('\t', reader.Depth);
writer.WriteLine("{0}", tabPrefix, reader.Name);
}
}
}
string buf = writer.ToString();
writer.Close(); // 關閉串流
reader.Close();
return buf;
}
這個函數會打開一份 XML,迴圈處理全部內容,每次呼叫 Read 指針就下移一個節點。大多數情況下 Read 停在元素節點上,但有時你會在兩種不同型別的節點之間跳動;另外 Read 不會在屬性節點之間移動。MoveToContent 可以讓指針從文檔頭部直接跳到第一個內容節點,而在 ProcessingInstruction、DocumentType、Comment、Whitespace 與 SignificantWhitespace 型別的節點上,也可以用 Skip 跳過。
節點型別是 XmlNodeType 列舉中的一種。上面範例只用了 Element 與 EndElement 兩種。這段輸出重新定制了原始文檔結構——它丟棄(忽略)了元素的屬性與節點內容,只印出元素名。假設輸入是:
<mags> <mag name="MSDN Magazine">MSDN Magazine</mag> <mag name="MSDN Voices">MSDN Voices</mag> </mags>
輸出結果便是:
<mags> <mag> </mag> <mag> </mag> </mags>
子節點的縮排量由閱讀器的 Depth 屬性決定,它回傳一個整數,表示當前節點的嵌套層次。所有文字先累積在 StringWriter 物件中(一個基於串流、封裝了 StringBuilder 的便利類別)。
如前所述,Read 不會自動進入屬性節點。要訪問當前元素的屬性集合,得用一個由 MoveToNextAttribute 回傳值控制的迴圈來遍歷。下面的代碼把當前節點的所有屬性組合成「名稱="值",」形式的字串:
if (reader.HasAttributes)
while (reader.MoveToNextAttribute())
buf += reader.Name + "=\"" + reader.Value + "\",";
reader.MoveToElement();
屬性處理完畢後,呼叫 MoveToElement 讓指針回到屬性所屬的元素節點。嚴格說這不算「移動」,因為處理屬性時指針從未離開元素節點;MoveToElement 只是把內部成員指標指回去並依序取值。例如用 Name 取得屬性名,再呼叫 MoveToElement 回到元素。若你不再需要處理其他節點,也就不必多這一筆。