應用程式常需持久化使用者設定(視窗位置、連線字串、偏好選項等)。早期採用 INI 檔 (64KB 限制) 或登錄表 (難備份、易殘留)。XML 序列化提供「物件導向、樹狀結構、無容量限制、純文字可讀」的現代化替代方案。本文示範如何將設定類別與 XML 檔案雙向轉換。
using System;
using System.Xml.Serialization;
using System.Configuration;
[XmlRoot("AppSettings")]
public class AppSettings {
// 基本型別屬性 → XML 屬性
[XmlAttribute("Version")]
public string Version { get; set; } = "1.0.0";
[XmlAttribute("LastUpdate")]
public DateTime LastUpdate { get; set; } = DateTime.Now;
// 複雜型別屬性 → 子元素
[XmlElement("Database")]
public DbConfig Database { get; set; } = new DbConfig();
[XmlElement("UI")]
public UIConfig UI { get; set; } = new UIConfig();
// 集合 → 陣列元素
[XmlArray("RecentFiles")]
[XmlArrayItem("File")]
public string[] RecentFiles { get; set; } = new string[0];
// 序列化靜態方法
public static AppSettings Load(string filePath) {
if (!System.IO.File.Exists(filePath)) return new AppSettings();
var serializer = new XmlSerializer(typeof(AppSettings));
using (var reader = new System.IO.StreamReader(filePath, System.Text.Encoding.UTF8)) {
return (AppSettings)serializer.Deserialize(reader);
}
}
public void Save(string filePath) {
var serializer = new XmlSerializer(typeof(AppSettings));
var ns = new XmlSerializerNamespaces();
ns.Add("", ""); // 移除預設命名空間前綴
using (var writer = new System.IO.StreamWriter(filePath, false, System.Text.Encoding.UTF8)) {
serializer.Serialize(writer, this, ns);
}
LastUpdate = DateTime.Now;
}
}
public class DbConfig {
[XmlAttribute("Provider")]
public string Provider { get; set; } = "System.Data.SqlClient";
[XmlElement("ConnectionString")]
public string ConnectionString { get; set; } = "";
[XmlElement("CommandTimeout")]
public int CommandTimeout { get; set; } = 30;
}
public class UIConfig {
[XmlAttribute("Theme")]
public string Theme { get; set; } = "Light";
[XmlElement("WindowState")]
public WindowState WindowState { get; set; } = new WindowState();
}
public class WindowState {
[XmlAttribute("Left")] public int Left { get; set; }
[XmlAttribute("Top")] public int Top { get; set; }
[XmlAttribute("Width")] public int Width { get; set; } = 800;
[XmlAttribute("Height")] public int Height { get; set; } = 600;
[XmlAttribute("Maximized")] public bool Maximized { get; set; }
}
<?xml version="1.0" encoding="utf-8"?>
<AppSettings Version="1.0.0" LastUpdate="2024-01-15T14:30:00">
<Database Provider="System.Data.SqlClient">
<ConnectionString>Server=.;Database=MyDB;Integrated Security=true</ConnectionString>
<CommandTimeout>60</CommandTimeout>
</Database>
<UI Theme="Dark">
<WindowState Left="100" Top="50" Width="1024" Height="768" Maximized="false" />
</UI>
<RecentFiles>
<File>C:\Projects\Doc1.docx</File>
<File>C:\Data\Report.pdf</File>
</RecentFiles>
</AppSettings>
| 屬性 | 作用對象 | 效果 | 備註 |
|---|---|---|---|
[XmlRoot("Name")] | 類別 | 指定根元素名稱 | 每個 XML 僅能有一個根元素 |
[XmlElement("Name")] | 屬性/欄位 | 序列化為子元素,標籤名為 Name | 預設為屬性名 |
[XmlAttribute("Name")] | 屬性/欄位 | 序列化為父元素的屬性 | 值型別需為基本型別 |
[XmlText] | 單一屬性 | 序列化為元素的文字內容 | 類別中僅能有一個,且不能有子元素 |
[XmlIgnore] | 屬性/欄位 | 排除序列化 | 用於敏感資料、運算屬性 |
[XmlArray("Name")] | 集合屬性 | 集合容器元素名稱 | 子元素預設為型別名 |
[XmlArrayItem("Name")] | 集合屬性 | 集合內每個項目的元素名稱 | 常與 XmlArray 搭配 |
[XmlElement("Name")] | 集合屬性 | 平行序列化:每個項目同層級,標籤為 Name | 無容器元素,直接平鋪 |
// 假設 public List Items = new List { "A", "B", "C" };
// 1. XmlArray + XmlArrayItem (巢狀容器)
[XmlArray("Items")]
[XmlArrayItem("Item")]
// 輸出:
/*
- A
- B
- C
*/
// 2. 僅 XmlArrayItem (無容器,以屬性名為容器)
[XmlArrayItem("Item")]
/*
- A
- B
- C
*/
// 3. 僅 XmlElement (平行扁平化)
[XmlElement("Item")]
/*
- A
- B
- C
*/
[XmlIgnore] 或保留屬性標記 [Obsolete]。[XmlIgnore],改用 DPAPI/Key Vault 加密儲存於獨立檔案。XmlSerializer 建構函數有快取機制,靜態 `serializer` 實例可重用,避免記憶體洩漏 (動態型別除外)。XML 序列化讓 .NET 設定管理回歸物件導向:強型別、IntelliSense 支援、版本演進友善、人眼可讀。配合屬性精確控制 XML 結構,是桌面應用、Windows Service、ASP.NET 應用程式設定的首選方案。