XML 早已不是新技術,它一點一點滲透進了 .NET Framework 的骨架。本文想說清楚兩件事:.NET 用來處理 XML 的這組 API 各自扮演什麼角色,以及它們內部是按什麼思路運作的。
在 .NET 出現之前,Windows 上的 XML 開發幾乎等同於 MSXML——一個基於 COM 的類庫。它的一部分代碼埋得比 API 更深,直接嵌進了操作系統底層。MSXML 確實能和你的應用程序對話,但很難與外部環境真正融為一體。
MSXML 既可以在 Win32 中引入,也能在 CLR 裡使用,但它始終只是一個外部的伺服器組件。相比之下,基於 .NET Framework 的應用可以直接調用 XML 類,與其他命名空間無縫整合,寫出來的代碼也更好讀。
作為獨立組件,MSXML 解析器提供了一些高級特性,例如異步分析,而這恰恰是 .NET 的 XML 類沒有直接提供的。不過 .NET 的優勢在於組合:把 XML 類與其他類搭配起來,同樣的功能很容易實現,而且還能在此基礎上長出更多變化。
.NET Framework 中的 XML 類覆蓋了分析、查詢、轉換三類基本能力,包括支持 XPath 查詢和 XSLT 轉換的類,以及讀寫文檔的類。此外還有服務於其他場景的 XML 相關類,例如序列化用的 XmlSerializer 與 SoapFormatter、讀配置的 AppSettingsReader、承載數據的 DataSet。本文只聚焦最基礎的 XML I/O。
XML 本質上是標記語言,要理解文檔裡的信息,就需要一個按語法解析的工具,也就是 XML 解析器(分析器)。不論平台,解析器基本分兩大流派:
兩者並不互斥——DOM 文檔完全可以由一個 SAX 流裝填而成。
差別也很明顯。DOM 的功能集合定義得非常完整,但你無法擴展它;處理大型文檔時,這套龐大的功能集合會佔去可觀的記憶體。SAX 則把控制權交給客戶端應用,解析器只負責把數據「推」出去,好處是記憶體開銷極小。
.NET Framework 完整支持 DOM 風格,卻沒有提供 SAX。這並不代表能力缺失,而是換了一種實現方式:用 XmlReader 就能輕鬆覆蓋 SAX 的全部功能,而且效率更高。
關鍵差異在控制權的位置。SAX 解析器掌控整個流程,把對應用有用和無用的信息一律推給你;而 .NET 的閱讀器整個跑在客戶端應用之下,應用可以只「拉取」真正需要的數據,然後隨時從流中跳出。對於大文檔的局部掃描,這個設計明顯更省。
閱讀器的工作方式類似數據庫游標。XmlReader 與 XmlWriter 兩個抽象類是所有 .NET XML 類的基石,XML DOM 類、ADO.NET 相關類乃至配置類都建立在它們之上。所以 .NET 給了你兩條路:直接用 XmlReader/XmlWriter 流式處理,或者用 DOM 樹式處理。
可以這樣類比:數據庫服務返回一個游標對象,它持有整個結果集並指向起始位置;同樣地,XML 閱讀器的客戶端拿到的是一個指向閱讀器實例的引用,這個實例從底層數據流中提取內容,並把結果呈現為一連串節點。
在閱讀器眼裡,XML 文檔不是一個標籤文本文件,而是一個序列化的節點集合。這是 .NET Framework 中相當獨特的一種游標式 API,你找不到第二個同類。
與 DOM 相比,閱讀器有三個顯著特徵:只進不退、沒有父子兄弟祖的層級概念、只能讀不能寫。在 .NET 中,讀與寫是徹底分開的兩件事,分別由 XmlReader 和 XmlWriter 承擔。要修改文檔,你要麼回到 DOM,要麼自己在流式基礎上疊一層。
XmlReader 是抽象類,可以繼承擴展。實際開發中,你用到的大多是下面三個:
XmlTextReader:只進只讀地快速掃描 XML 數據流。它會先確認文檔是否格式良好,不是就拋異常;它檢查 DTD 的格式,但不拿 DTD 去做文檔校驗。XmlValidatingReader:需要按 DTD 或 Schema 做驗證時用它。XmlNodeReader:把已有的 DOM 節點樹當成流來讀。要注意,部分屬性和方法的實際行為隨具體類而異。例如 CanResolveEntity 在 XmlValidatingReader 中只返回 true,在其他閱讀器中卻可以設為 false;再如所有與屬性相關的方法,遇到非元素節點時返回 void。
創建 XmlTextReader 有多種方式:從硬盤文件、從 URL、從流,或者直接從字符串讀入。
XmlTextReader reader = new XmlTextReader(file);
所有 public 構造函數都要求你明確指定數據源(流、文件或其他),預設的無參構造函數是受保護的,不能直接使用。和 SqlDataReader 一樣,打開之後就可以用 Read() 開始讀:第一次調用把指針移到第一個節點,之後可以搭配 Skip、MoveToContent、ReadInnerXml 等方法移動。因為 Read() 返回布爾值,讀到尾部時返回 false,所以用一個 while 循環就能遍歷全文。
string GetXmlFileNodeLayout(string file)
{
XmlTextReader reader = new XmlTextReader(file);
StringWriter writer = new StringWriter();
string tabPrefix = "";
while (reader.Read())
{
if (reader.NodeType == XmlNodeType.Element)
{
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}</{1}>", tabPrefix, reader.Name);
}
}
string buf = writer.ToString();
writer.Close();
reader.Close();
return buf;
}
這個函數每次調用 Read(),指針就向下走一個節點,只挑出元素節點的名字,並用 Depth 屬性決定縮進——Depth 返回當前節點的嵌套層次。所有輸出先累積到 StringWriter(一個基於流、封裝了 StringBuilder 的便利類),最後一次性返回。
給定這樣的輸入:
<mags> <mag name="MSDN Magazine">MSDN Magazine</mag> <mag name="MSDN Voices">MSDN Voices</mag> </mags>
輸出只保留結構骨架:
<mags> <mag> </mag> <mag> </mag> </mags>
屬性和文本內容都被有意忽略了,這正是示例想說明的:閱讀器給你的是逐個節點的原始視角,取什麼由你決定。
Read() 不會自動走進屬性節點。要讀當前元素的全部屬性,得用 MoveToNextAttribute() 驅動一個循環:
if (reader.HasAttributes)
while (reader.MoveToNextAttribute())
buf += reader.Name + "=\"" + reader.Value + "\",";
reader.MoveToElement();
處理完屬性後,調用 MoveToElement() 把位置收回所屬元素。嚴格說這不算真正的移動——遍歷屬性時指針從未離開元素節點,MoveToElement() 只是把內部游標重新指向元素並取回其值。如果你不打算繼續處理其他節點,這一步也可以省下。
總結一句:XmlReader 的思維是「流式、只讀、向前」,把 XML 當成一條可以按需拉取的節點序列。理解這一點,比記住每個方法的簽名更有價值。