萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> ASP 程式設計

利用 XML 序列化實現 .NET 應用程式配置檔管理

前言

應用程式常需持久化使用者設定(視窗位置、連線字串、偏好選項等)。早期採用 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 結構範例

<?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
*/

實戰最佳實踐

  1. 單一職責:設定類別僅包含可序列化的公開屬性,業務邏輯分離。
  2. 版本相容:新增屬性預設值,舊 XML 反序列化自動使用預設值;移除屬性加 [XmlIgnore] 或保留屬性標記 [Obsolete]。
  3. 敏感資料:連線字串密碼、API Key 標記 [XmlIgnore],改用 DPAPI/Key Vault 加密儲存於獨立檔案。
  4. 執行緒安全:XmlSerializer 建構函數有快取機制,靜態 `serializer` 實例可重用,避免記憶體洩漏 (動態型別除外)。
  5. 錯誤處理:`Deserialize` 可能拋出 `InvalidOperationException` (XML 結構不符),需 try-catch 回傳預設實例並記錄日誌。

結語

XML 序列化讓 .NET 設定管理回歸物件導向:強型別、IntelliSense 支援、版本演進友善、人眼可讀。配合屬性精確控制 XML 結構,是桌面應用、Windows Service、ASP.NET 應用程式設定的首選方案。

copyright © 萬盛學電腦網 all rights reserved