萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> 程式語言綜合

C# 讀寫 INI 配置文件完整封裝類(基於 Windows API)

INI 文件雖老舊,但在輕量級配置、跨進程共享、無註冊表權限場景仍廣泛使用。C# 通過 P/Invoke 調用 Windows API GetPrivateProfileString、WritePrivateProfileString 可高效操作 INI。本文提供生產級封裝類完整代碼。

1. P/Invoke 簽名

using System.Runtime.InteropServices;
using System.Text;

public class IniFile {
    [DllImport("kernel32", CharSet = CharSet.Auto, SetLastError = true)]
    private static extern int GetPrivateProfileString(
        string lpAppName, string lpKeyName, string lpDefault,
        StringBuilder lpReturnedString, int nSize, string lpFileName);

    [DllImport("kernel32", CharSet = CharSet.Auto, SetLastError = true)]
    private static extern int WritePrivateProfileString(
        string lpAppName, string lpKeyName, string lpString, string lpFileName);

    [DllImport("kernel32", CharSet = CharSet.Auto, SetLastError = true)]
    private static extern int GetPrivateProfileSection(
        string lpAppName, IntPtr lpReturnedString, int nSize, string lpFileName);
    
    private readonly string _path;
    public IniFile(string path) { _path = Path.GetFullPath(path); }
}

2. 核心讀寫方法

// 讀取值(支持默認值)
public string Read(string section, string key, string defaultValue = "") {
    var sb = new StringBuilder(256);
    GetPrivateProfileString(section, key, defaultValue, sb, sb.Capacity, _path);
    return sb.ToString();
}

// 寫入值(section/key 為 null 可刪除整節/鍵)
public void Write(string section, string key, string value) {
    if (value == null) value = ""; // 空字符串表示刪除鍵
    WritePrivateProfileString(section, key, value, _path);
}

// 刪除鍵
public void DeleteKey(string section, string key) {
    WritePrivateProfileString(section, key, null, _path);
}

// 刪除整節
public void DeleteSection(string section) {
    WritePrivateProfileString(section, null, null, _path);
}

// 讀取整節所有鍵值
public Dictionary<string, string> ReadSection(string section) {
    var dict = new Dictionary<string, string>();
    IntPtr ptr = Marshal.AllocHGlobal(65536);
    try {
        int size = GetPrivateProfileSection(section, ptr, 65536, _path);
        if (size > 0) {
            string data = Marshal.PtrToStringAuto(ptr, size);
            foreach (var pair in data.Split('\0', StringSplitOptions.RemoveEmptyEntries)) {
                int idx = pair.IndexOf('=');
                if (idx > 0) dict[pair.Substring(0, idx)] = pair.Substring(idx + 1);
            }
        }
    } finally { Marshal.FreeHGlobal(ptr); }
    return dict;
}

3. WinForms 使用示例

public partial class MainForm : Form {
    private readonly IniFile _ini = new IniFile(Application.StartupPath + @"\config.ini");

    private void btnWrite_Click(object sender, EventArgs e) {
        _ini.Write("Settings", "Username", txtUser.Text);
        _ini.Write("Settings", "Theme", cmbTheme.SelectedItem?.ToString() ?? "Light");
        MessageBox.Show("寫入成功");
    }

    private void btnRead_Click(object sender, EventArgs e) {
        txtUser.Text = _ini.Read("Settings", "Username", "Guest");
        cmbTheme.SelectedItem = _ini.Read("Settings", "Theme", "Light");
    }

    private void btnDeleteKey_Click(object sender, EventArgs e) {
        _ini.DeleteKey("Settings", "Username");
    }

    private void btnDeleteSection_Click(object sender, EventArgs e) {
        _ini.DeleteSection("Settings");
    }
}

4. 生成的 INI 文件示例

; config.ini
[Settings]
Username=Admin
Theme=Dark

5. 進階提示

  • 線程安全:Windows API 內部已同步,多線程調用安全。
  • 編碼:默認使用系統 ANSI 頁面;需 Unicode 存儲請用 GetPrivateProfileStringW/WritePrivateProfileStringW 並將 CharSet = CharSet.Unicode。
  • 大文件性能:INI 非結構化存儲,超過 64KB 讀寫變慢,建議改用 XML/JSON/SQLite。
  • 替代方案:.NET Core / 5+ 推薦 Microsoft.Extensions.Configuration.Ini(NuGet 包),無需 P/Invoke,跨平台。

總結

封裝 Windows API 操作 INI 文件僅需十幾行核心代碼,配合 StringBuilder、Marshal 處理非托管內存,即可獲得穩定、高性能的配置讀寫能力。

copyright © 萬盛學電腦網 all rights reserved