为什么 C# 没有内置的 INI 文件支持
.NET 基础类库从 .NET Framework 2.0 起就移除了对
GetPrivateProfileString等 Win32 INI API 的封装,后续的 .NET Core / .NET 5+ 更是彻底不提供原生 INI 解析器。这意味着:你不能直接用
ConfigurationManager或
IConfiguration读取标准 INI 文件(如
app.ini),除非手动桥接 Windows API 或引入第三方解析逻辑。
用 Windows API 读写 INI(仅限 Windows)
如果目标平台确定是 Windows,且需要兼容传统 INI 格式(如节名
[Section]、键值
Key=Value),可调用
kernel32.dll中的
WritePrivateProfileString和
GetPrivateProfileString。这种方式零依赖,但跨平台失效,且不支持 Unicode 路径或含等号的值(如
Path=C:\=test)。
关键点:
lpAppName参数必须是节名(如
"Database"),不能带方括号
lpKeyName为键名(如
"Server"),传
null可读取整个节的所有键名(用
\0分隔) 读取缓冲区必须足够大;建议分配 32767 字节并检查返回长度,避免截断 写入时若节或键不存在,API 自动创建;若值为空字符串,等效于删除该键
using System;
using System.Runtime.InteropServices;
<p>public static class IniHelper
{
[DllImport("kernel32.dll", CharSet = CharSet.Unicode)]
private static extern uint GetPrivateProfileString(
string lpAppName, string lpKeyName, string lpDefault,
string lpReturnedString, uint nSize, string lpFileName);</p><pre class='brush:php;toolbar:false;'>[DllImport("kernel32.dll", CharSet = CharSet.Unicode)]
private static extern bool WritePrivateProfileString(
string lpAppName, string lpKeyName, string lpString,
string lpFileName);
public static string ReadValue(string iniPath, string section, string key, string defaultValue = "")
{
var buffer = new string('\0', 32767);
var len = GetPrivateProfileString(section, key, defaultValue, buffer, (uint)buffer.Length, iniPath);
return len > 0 ? buffer.Substring(0, (int)len) : defaultValue;
}
public static void WriteValue(string iniPath, string section, string key, string value)
{
WritePrivateProfileString(section, key, value, iniPath);
}}
用第三方库(推荐跨平台方案)
更通用的做法是使用
ini-parser(NuGet 包名:
ini-parser)。它支持标准 INI 语法、注释、多行值、Unicode,并可在 .NET 5+ / Linux / macOS 上运行。注意:它不支持“无节名”的全局键(即文件开头直接写
Key=Value),所有键必须在明确节内。
常见问题与应对:
读取失败却无异常?检查文件路径是否正确、是否有读取权限,IniData构造不会抛异常,但
Parse方法可能静默失败 —— 建议用
File.Exists预检 写入后中文乱码?确保保存时指定
Encoding.UTF8,否则默认 ANSI(Windows-1252)会损坏中文 想覆盖整个节?用
data.Sections[sectionName].Keys.Clear()再逐个
Add(),不要直接赋新
SectionData
using IniParser;
using IniParser.Model;
<p>var parser = new FileIniDataParser();
parser.Parser.Configuration.CommentString = ";"; // 支持分号注释</p><p>// 读取
if (File.Exists("config.ini"))
{
IniData data = parser.ReadFile("config.ini", Encoding.UTF8);
string server = data["Database"]["Server"]; // 节名 + 键名
}</p><p>// 写入
var newData = new IniData();
newData["Database"].AddKey("Server", "192.168.1.100");
newData["Database"].AddKey("Port", "5432");
parser.WriteFile("config.ini", newData, Encoding.UTF8);INI 不适合现代 C# 项目的真正原因
INI 文件缺乏层级嵌套、类型支持、环境变量插值、热重载等能力。即便用
ini-parser封装,你也得自己做类型转换(如把
"Timeout=30"转成
int)、校验缺失键、处理大小写敏感问题(
ini-parser默认区分大小写)。而
Microsoft.Extensions.Configuration生态(JSON/YAML/Environment Variables)天然支持这些。
如果你只是想快速存几个开关或连接串,INI 看似简单;但只要配置项超过 5 个、需支持开发/测试/生产多环境、或未来可能加嵌套结构,就该直接切到
appsettings.json+
IConfiguration。强行坚持 INI,最后往往变成自己重复造轮子补类型、验证、合并逻辑。
