長久以來,開發者多半靠拼接字串再輸出到檔案的方式來建立 XML 文件,但這種做法只有在確保字串毫無差錯時才有效。.NET Framework 提供了更好的方法:XmlWriter。
XmlWriter 以只往前(forward-only)的方式把 XML 資料輸出到資料流或檔案,並在設計上保證輸出的資料符合 W3C XML 1.0 推薦標準,甚至連閉合標籤都會幫你補上。XmlWriter 是所有 XML writer 的抽象基底類別,而 .NET 只提供唯一的實作——XmlTextWriter。
傳統做法是透過 StringBuilder 迴圈拼接標籤字串:
StringBuilder sb = new StringBuilder("");sb.Append("<array>");foreach(string s in theArray) { sb.Append("<element value=\""); sb.Append(s); sb.Append("\"/>");}sb.Append("</array>");
當文件結構簡單時這還行得通,但一旦要處理處理指令、命名空間、縮排、格式化與實體,程式碼量與出錯機率就會急遽上升。改用 XmlTextWriter 後:
XmlTextWriter xmlw = new XmlTextWriter(filename, null);xmlw.Formatting = Formatting.Indented;xmlw.WriteStartDocument();xmlw.WriteStartElement("array");foreach(string s in theArray) { xmlw.WriteStartElement("element"); xmlw.WriteAttributeString("value", s); xmlw.WriteEndElement();}xmlw.WriteEndDocument();xmlw.Close();
程式碼更簡潔、可讀性更高、結構更清楚。
XmlWriter 並非萬能:它不會檢查元素名與屬性名是否合法,也不保證所用的 Unicode 字元集符合目前的編碼;不會驗證屬性名是否與既有元素重名;而且它不是帶驗證的 writer,不保證輸出符合 schema 或 DTD。.NET Framework 目前尚未內建帶驗證的 writer。
Writer 的狀態源自 WriteState 列舉:建立時為 Start;呼叫 WriteStartDocument 後轉為 Prolog;寫入第一個(根)節點後轉為 Element;呼叫 WriteStartAttribute 時轉為 Attribute;寫入閉合標籤後轉為 Content;呼叫 WriteEndDocument 後回到 Start,直到開始寫下一份文件或關閉 Writer。
Writer 會把輸出存在內部緩衝區,任何時候都能用 Flush 方法清空緩衝區、把內容寫進資料流並釋放部分記憶體,Writer 仍保持開啟。寫屬性有兩種方式:一是用 WriteStartAttribute 建立節點、WriteString 設值、WriteEndElement 收尾;二是用 WriteAttributeString 一步完成。要避免把敏感標記字元(如小於號)傳給寫入方法,若要原樣寫入則用 WriteRaw,它不會被解析。
Reader 與 Writer 都提供以 Base64 與 BinHex 編碼讀寫資料流的方法。WriteBase64 與 WriteBinHex 以 byte 陣列而非字串為輸入,例如:
writer.WriteBase64(Encoding.Unicode.GetBytes(buf), 0, buf.Length*2);
下圖把字串陣列轉為 Base64 編碼的 XML 流,示範了 WriteStartDocument、WriteComment、WriteAttributeString(含命名空間)、WriteBase64 與 WriteEndDocument 的搭配使用;讀回時則用 XmlTextReader 的 ReadBase64 解析。

從 byte 轉回 string 是透過 Encoding 類別的 GetString 方法完成。只要把方法名換成 ReadBinHex,就能改讀 BinHex 編碼的內容;這招也適用於讀取任何以 byte 形式表示的二進位資料,尤其是 image 類型。