最近幾個專案都得用 XML 存設定,每次操作 XML 都覺得別扭——明明是很簡單的事,寫起來卻比操作資料庫麻煩得多。後來發現 .NET 的 DataSet 天生就能讀寫 XML,而且靈活性相當好,於是乾脆包一個類別出來,之後所有專案共用。
用 DataSet 操作 XML,本質上就是把 XML 當成表格來看待:讀進 DataSet 之後,對其中的表、行、列進行操作,最後再寫回 XML。如果搭配 .xsd 檔案描述結構,型別與約束還能一併帶入,效果更完整。
這個類別操作的 XML 格式是固定的。在 Internet Explorer 中打開 XML 檔,點右下角的「資料」頁籤就會看到熟悉的表格視圖;在表格任意位置按右鍵選擇「建立結構描述」,系統會產生對應的 .xsd 檔,用來定義各列的型別。
想要自動編號的 ID 欄位怎麼辦?先在 XML 中放一個空的 <ID></ID> 元素,產生 .xsd 之後,選中 ID 那一列,在右側屬性面板把 AutoIncrementSeed 與 AutoIncrementStep 都設為 1,ID 就會從 1 開始、每次遞增 1。這招讓 XML 也能有資料庫式的流水號。
呼叫端有時給相對路徑,有時給完整路徑,這個方法負責統一處理:
#region GetXMLFullPath
/// <summary>回傳完整路徑</summary>
public static string GetXMLFullPath(string strPath)
{
// 含冒號視為完整路徑,直接回傳
if (strPath.IndexOf(":") > 0)
{
return strPath;
}
else
{
return System.Web.HttpContext.Current.Server.MapPath(strPath);
}
}
#endregion
讀取只需一行 ReadXml():
#region GetDataSetByXml
/// <summary>讀取 XML 並回傳 DataSet</summary>
public static DataSet GetDataSetByXml(string strXMLPath)
{
try
{
DataSet ds = new DataSet();
ds.ReadXml(GetXmlFullPath(strXMLPath));
if (ds.Tables.Count > 0)
{
return ds;
}
return null;
}
catch (Exception)
{
return null;
}
}
#endregion
這裡得到的是未經處理的完整資料。實務上多半需要篩選與排序,那時改用 GetDataViewByXml()——它多收兩個參數(條件字串與排序字串),回傳 DataView 而非 DataSet,之後直接綁到 DataGrid 即可。
插入用 WriteXMLByDataSet():傳入 XML 路徑、欄位名稱陣列與對應的值陣列,內部建立 DataRow 逐一賦值後 Rows.Add(),最後 WriteXml() 寫回檔案,成功回傳 true。
修改用 UpdateXMLRow():因為要先定位再改值,參數較多——路徑、要更新的欄位陣列、對應的值陣列,再加上定位用的條件欄位與條件值。
刪除提供了三個版本,方便不同情境:
DeleteXMLRows())。為什麼需要「依 Index 刪除」這種看似危險的做法?因為有些時候 XML 資料讀進 DataSet 後直接綁到 DataGrid,而 DataGrid 裡只有一個樣板欄,樣板欄中又嵌了表格與多個控制項,導致我們拿不到記錄真正的 ID 值。這時先取得記錄的 Index(第一行為 0,第二行為 1,依此類推),把 Index 傳進方法就能刪掉該列。
使用這個方法有一個前提:綁定到 DataGrid 的 DataSet 與刪除時用的 DataSet 必須是同一個物件,也就是 Index 必須對得上。中間若做過排序,Index 就會錯位,結果刪掉的會是別的記錄。
讀取並顯示,有兩種粒度可選:
// 未排序、未篩選
DataGrid1.DataSource = OperateXmlByDataSet.GetDataSetByXml(@"xml/xml_xmlDB.xml");
DataGrid1.DataBind();
// 依條件篩選並排序
DataGrid1.DataSource = OperateXmlByDataSet.GetDataViewByXML(
@"xml/xml_xmlDB.xml", // 檔案路徑
"name = 'Asp.Net'", // 條件
"peopleNum desc"); // 排序方式
DataGrid1.DataBind();
新增一筆記錄,欄位與值以兩個對等陣列傳入:
bool b = OperateXmlByDataSet.WriteXMLByDataSet(
@"xml/xml_xmlDB.xml",
new string[]{"name", "peopleNum", "address", "description",
"require", "deadLine", "IsMarried"},
new string[]{"ASP.Net 工程師", "2", "建國路", "B/S 架構程式",
"ASP.Net、C# 等", DateTime.Now.ToShortDateString(), "false"});
修改時多帶上定位條件:
bool b = OperateXmlByDataSet.UpdateXMLRow(
@"xml/xml_xmlDB.xml",
new string[]{"name", "peopleNum", "description", "IsMarried"},
new string[]{"kgdiwss", "10", "描述", "true"},
"peopleNum", "3");
批次刪除則是傳入條件欄位與一組條件值:
bool b = OperateXmlByDataSet.DeleteXMLRows(
@"xml/xml_xmlDB.xml",
"name",
new string[]{"值1", "值2", "值3"});
邏輯型欄位要填 true / false。不是 0 和 1。這點在 .xsd 定義 boolean 型別時尤其容易出錯,寫成 0/1 會導致驗證失敗或整列被當成 null。
欄位與值的順序必須一一對應。用兩個平行陣列傳參固然精簡,但也把配對關係隱藏了起來。若欄位眾多,建議改用 Dictionary 或明確定義參數物件,日後維護會輕ÿ多。
這套方法足以應付大部分常見的 XML 操作場景,程式碼量比手寫 XML 節點少了不只一半。唯一要留意的是效能:DataSet 是整份載入記憶體的架構,資料量一大就會變得吃重。真到了那個規模,答案通常不是優化 XML 讀寫,而是換用資料庫。