XML 由 W3C 制定,作為取代 HTML 的新型標記語言,內部有許多基本標準,透過與這些標準的結合,被廣泛應用於科學計算、電子出版、多媒體製作與電子商務。C# 作為 .NET 框架的重要組成部分,與 XML 關係密切。本文從一個具體角度切入:用 C# 建立與讀取 XML 文件。
這種方式依 XML 的結構一步一步建構,較為靈活,但需要先理解文件結構。相關類別都封裝在 System.Xml 命名空間中。
XmlDocument xmldoc = new XmlDocument();
XmlDocument 類別就是 C# 用來描述 XML 文件的載體。
用 CreateNode 方法建立指定型別的節點,這裡採用其常見的三參數多載:
XmlDocument.CreateNode(XmlNodeType, String, String)
建立後再用 AppendChild 掛進文件:
XmlNode xmlnode = xmldoc.CreateNode(XmlNodeType.XmlDeclaration, "", ""); xmldoc.AppendChild(xmlnode);
XmlDocument 提供了兩個方法:CreateElement 建立元素,CreateTextNode 為元素指定文字內容。
XmlElement xmlelem = xmldoc.CreateElement("", "ROOT", "");
XmlText xmltext = xmldoc.CreateTextNode("RootText");
掌握了建立單一元素的模式,就能依資料的實際結構繼續建構其他節點。
using System;
using System.Xml;
class MainClass
{
XmlDocument xmldoc;
XmlNode xmlnode;
XmlElement xmlelem;
XmlElement xmlelem2;
XmlText xmltext;
static void Main(string[] args)
{
MainClass app = new MainClass();
}
public MainClass()
{
xmldoc = new XmlDocument();
// 加入 XML 宣告
xmlnode = xmldoc.CreateNode(XmlNodeType.XmlDeclaration, "", "");
xmldoc.AppendChild(xmlnode);
// 加入根元素
xmlelem = xmldoc.CreateElement("", "ROOT", "");
xmltext = xmldoc.CreateTextNode("RootText");
xmlelem.AppendChild(xmltext);
xmldoc.AppendChild(xmlelem);
// 加入另一個元素
xmlelem2 = xmldoc.CreateElement("", "SampleElement", "");
xmltext = xmldoc.CreateTextNode("The text of the sample element");
xmlelem2.AppendChild(xmltext);
xmldoc.ChildNodes.Item(1).AppendChild(xmlelem2);
// 儲存文件
try
{
xmldoc.Save("c:\\data.xml");
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
Console.ReadLine();
}
}
寫完第一種方法,你大概會同意:逐節點組裝雖然靈活,但繁瑣。第二種方式更省事——直接把整段 XML 字串塞進文件,存檔即可。
同第一種方法。
這個方法直接接受一段 XML 文字。當然,字串本身必須符合 XML 語法,否則產出的檔案沒有意義。
doc.LoadXml(
"<Employees>" +
"<NO1>" +
" <Name>MaJinHu</Name>" +
" <ZIP>239000</ZIP>" +
" <Address>FengHuangStreet</Address>" +
" <City>ChuZhouCity</City>" +
" <State>ANHUI</State>" +
"</NO1>" +
"<NO2>" +
" <Name>WangTian</Name>" +
" <ZIP>239000</ZIP>" +
" <Address>LangYaStreet</Address>" +
" <City>HeFeiCity</City>" +
" <State>ANHUI</State>" +
"</NO2>" +
"<NO3>" +
" <Name>ZouWenBiao</Name>" +
" <ZIP>100000</ZIP>" +
" <Address>SaiDiStreet</Address>" +
" <City>BeiJinCity</City>" +
" <State>BeiJin</State>" +
"</NO3>" +
"</Employees>");
doc.Save("data.xml");
using System;
using System.IO;
using System.Xml;
public class Sample
{
public static void Main()
{
// 建立 XmlDocument 物件
XmlDocument doc = new XmlDocument();
doc.LoadXml(
"<Employees>" +
"<NO1>" +
" <Name>MaJinHu</Name>" +
" <ZIP>239000</ZIP>" +
" <Address>FengHuangStreet</Address>" +
" <City>ChuZhouCity</City>" +
" <State>ANHUI</State>" +
"</NO1>" +
"<NO2>" +
" <Name>WangTian</Name>" +
" <ZIP>239000</ZIP>" +
" <Address>LangYaStreet</Address>" +
" <City>HeFeiCity</City>" +
" <State>ANHUI</State>" +
"</NO2>" +
"<NO3>" +
" <Name>ZouWenBiao</Name>" +
" <ZIP>100000</ZIP>" +
" <Address>SaiDiStreet</Address>" +
" <City>BeiJinCity</City>" +
" <State>BeiJin</State>" +
"</NO3>" +
"</Employees>");
// 儲存檔案
doc.Save("data.xml");
}
}
以下用 C# 讀取上面產生的 data.xml,並以 ListView 元件依結構呈現。
XmlDocument doc = new XmlDocument();
doc.Load("C:\\data.xml");
XmlNodeReader 負責循序讀取 XML 節點。程式中用到兩個關鍵屬性:NodeType 用來判斷目前節點的型別,Value 則是節點的值。
while (reader.Read())
{
switch (reader.NodeType)
{
case XmlNodeType.Element:
s = reader.Name;
break;
case XmlNodeType.Text:
if (s.Equals("Name"))
myItem = ListView1.Items.Add(reader.Value);
else
myItem.SubItems.Add(reader.Value);
break;
}
}
邏輯很直白:遇到元素節點時記住元素名稱,遇到文字節點時比對名稱——若是 Name 就新增一列,否則當成該列的後續欄位。
using System;
using System.Drawing;
using System.Windows.Forms;
public class Form1 : Form
{
private Button button1;
private ListView ListView1;
private System.ComponentModel.Container components = null;
public Form1()
{
InitializeComponent();
}
protected override void Dispose(bool disposing)
{
if (disposing && components != null)
components.Dispose();
base.Dispose(disposing);
}
private void InitializeComponent()
{
button1 = new Button();
ListView1 = new ListView();
SuspendLayout();
button1.Anchor = (AnchorStyles.Bottom | AnchorStyles.Left | AnchorStyles.Right);
button1.Location = new Point(240, 296);
button1.Name = "button1";
button1.Size = new Size(112, 37);
button1.TabIndex = 0;
button1.Text = "讀取 XML 文件";
button1.Click += new System.EventHandler(button1_Click);
ListView1.Anchor = (AnchorStyles.Top | AnchorStyles.Bottom | AnchorStyles.Left | AnchorStyles.Right);
ListView1.GridLines = true;
ListView1.Location = new Point(10, 9);
ListView1.Name = "ListView1";
ListView1.Size = new Size(623, 269);
ListView1.TabIndex = 1;
ListView1.View = View.Details;
this.AutoScaleBaseSize = new Size(6, 14);
this.ClientSize = new Size(608, 348);
this.Controls.Add(ListView1);
this.Controls.Add(button1);
this.Name = "Form1";
this.StartPosition = FormStartPosition.CenterScreen;
this.Text = "用 C# 讀取 XML 文件";
this.ResumeLayout(false);
}
static void Main()
{
Application.Run(new Form1());
}
private void button1_Click(object sender, System.EventArgs e)
{
ListViewItem myItem = new ListViewItem();
ListView1.Columns.Clear();
ListView1.Items.Clear();
ListView1.Columns.Add("Name", 80, HorizontalAlignment.Left);
ListView1.Columns.Add("Zip", 80, HorizontalAlignment.Left);
ListView1.Columns.Add("Address", 80, HorizontalAlignment.Left);
ListView1.Columns.Add("City", 80, HorizontalAlignment.Left);
ListView1.Columns.Add("State", 80, HorizontalAlignment.Left);
XmlNodeReader reader = null;
try
{
string s = "";
XmlDocument doc = new XmlDocument();
doc.Load("C:\\data.xml");
reader = new XmlNodeReader(doc);
while (reader.Read())
{
switch (reader.NodeType)
{
case XmlNodeType.Element:
s = reader.Name;
break;
case XmlNodeType.Text:
if (s.Equals("Name"))
myItem = ListView1.Items.Add(reader.Value);
else
myItem.SubItems.Add(reader.Value);
break;
}
}
}
finally
{
if (reader != null)
reader.Close();
}
}
}
這裡有兩個值得學的習慣:把讀取邏輯包在 try/finally 中,確保 reader.Close() 一定會執行;以及先把元素名稱暫存起來,再於文字節點時比對——因為 XmlNodeReader 是循序的流式讀取,無法隨機跳轉。
方法一逐節點組裝,適合資料由程式邏輯動態計算得出、結構需要視情況變化的場景;方法二直接餵字串,適合資料來源本身就是 XML 文字、或結構已知固定的場合。兩者最後都呼叫 Save 存檔,可以混用。
C# 與 XML 的淵源很深,本文只從一個側面反映了兩者的關係。.NET Framework SDK 中存在許多可直接操作 XML 的類別——XmlDocument、XmlNodeReader 之外,還有 XmlTextWriter、XPathNavigator、XmlSerializer 等。掌握這些類別的使用時機,對用 C# 開發與 XML 相關的程式十分重要。