C#读写INI文件的最简方法_C#

一、引言

ini文件，全称为initialization file（初始化文件），是一种传统的文本型配置文件格式，广泛应用于windows操作系统及早期应用程序中，用于存储软件的各项设置和参数。

尽管开发中xml、json或更现代的配置格式如yaml等逐渐占据主流，但ini文件凭借其简洁明了的结构和易于人类阅读与编辑的特点，在特定场景下仍然具有不可替代的价值。

本文将聚焦于c#语言环境下，介绍如何以最简化的方式实现ini文件的读写操作。

二、ini文件基础

ini文件采用键值对（key-value pairs）的形式组织数据，并将其划分为若干个逻辑段落（sections）。其基本结构如下：

; 注释行（以分号开始）

[section1]     ; 段落名，用方括号包围
key1 = value1   ; 键值对，等号分隔键与值
key2 = value2

[section2]
keya = valuea
keyb = valueb

其中：

注释：以分号（;）开头的行被视为注释，用于解释文件中的设置。

段落（section）：用方括号（[]）包裹的名称标识一个特定的配置区域，用于分类相关设置。

键（key）：在每个段落内定义的唯一标识符，用于表示特定的配置项。

值（value）：与键关联的数据，可以是字符串、数字或其他简单文本表示的信息。

三、c#读写ini文件的最简方法

在c#中，虽然.net框架并未直接提供对ini文件的内置支持，但可以通过以下两种简便途径实现ini文件的读写：

1、使用microsoft.visualbasic命名空间提供的api

尽管名为visual basic，但此命名空间中的类库在c#中同样可用。

其中包含了对ini文件操作的便捷方法，无需额外引入外部库或编写复杂的p/invoke代码。

以下是最简示例：

using microsoft.visualbasic.fileio;

// 读取ini文件
public string readinivalue(string section, string key, string filepath)
{
    return iniparser.readkeyvalue(filepath, section, key, "");
}

// 写入ini文件
public void writeinivalue(string section, string key, string value, string filepath)
{
    iniparser.writekeyvalue(filepath, section, key, value);
}

// 定义辅助类
internal static class iniparser
{
    [dllimport("kernel32")]
    private static extern int getprivateprofilestring(string section, string key, string def, stringbuilder retval, int size, string filepath);
    [dllimport("kernel32")]
    private static extern int writeprivateprofilestring(string section, string key, string val, string filepath);

    internal static string readkeyvalue(string inipath, string section, string key, string defaultvalue)
    {
        const int max_buffer = 65535;
        var sb = new stringbuilder(max_buffer);
        getprivateprofilestring(section, key, defaultvalue, sb, max_buffer, inipath);
        return sb.tostring();
    }

    internal static void writekeyvalue(string inipath, string section, string key, string value)
    {
        writeprivateprofilestring(section, key, value, inipath);
    }
}

2、利用第三方库

若希望避免直接调用win32 api，或者寻求更丰富的功能和更好的错误处理，可以选用成熟的第三方库，如inifileparser或nini等。这些库提供了面向对象的接口，简化了ini文件的操作。以下是一个使用inifileparser库的简例：

using iniparser;
using iniparser.model;

// 读取ini文件
public string readinivalue(string section, string key, string filepath)
{
    var parser = new fileinidataparser();
    inidata data = parser.readfile(filepath);
    return data[section][key];
}

// 写入ini文件
public void writeinivalue(string section, string key, string value, string filepath)
{
    var parser = new fileinidataparser();
    inidata data = parser.readfile(filepath);
    data[section][key] = value;
    parser.writefile(filepath, data);
}