读取/写入 INI 文件
本文关键字：文件 INI 写入 读取 | 更新日期: 2023-09-27 17:48:48
.NET 框架中是否有任何类可以读取/写入标准.ini文件：
[Section]
<keyname>=<value>
...
Delphi 有 TIniFile 组件，我想知道 C# 是否有类似的东西？
前言
首先，阅读这篇关于 INI 文件限制的 MSDN 博客文章。如果它适合您的需求，请继续阅读。
这是我编写的一个简洁的实现，利用了原始的Windows P/Invoke，因此所有安装了.NET的Windows版本(即Windows 98 - Windows 11(都支持它。我特此将其发布到公共领域 - 您可以自由地将其用于商业用途，而无需署名。
小班
将一个名为 IniFile.cs 的新类添加到项目中：
using System.IO;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Text;
// Change this to match your program's normal namespace
namespace MyProg
{
class IniFile // revision 11
{
string Path;
string EXE = Assembly.GetExecutingAssembly().GetName().Name;
[DllImport("kernel32", CharSet = CharSet.Unicode)]
static extern long WritePrivateProfileString(string Section, string Key, string Value, string FilePath);
[DllImport("kernel32", CharSet = CharSet.Unicode)]
static extern int GetPrivateProfileString(string Section, string Key, string Default, StringBuilder RetVal, int Size, string FilePath);
public IniFile(string IniPath = null)
{
Path = new FileInfo(IniPath ?? EXE + ".ini").FullName;
}
public string Read(string Key, string Section = null)
{
var RetVal = new StringBuilder(255);
GetPrivateProfileString(Section ?? EXE, Key, "", RetVal, 255, Path);
return RetVal.ToString();
}
public void Write(string Key, string Value, string Section = null)
{
WritePrivateProfileString(Section ?? EXE, Key, Value, Path);
}
public void DeleteKey(string Key, string Section = null)
{
Write(Key, null, Section ?? EXE);
}
public void DeleteSection(string Section = null)
{
Write(null, null, Section ?? EXE);
}
public bool KeyExists(string Key, string Section = null)
{
return Read(Key, Section).Length > 0;
}
}
}
如何使用它
通过以下 3 种方式之一打开 INI 文件：
// Creates or loads an INI file in the same directory as your executable
// named EXE.ini (where EXE is the name of your executable)
var MyIni = new IniFile();
// Or specify a specific name in the current dir
var MyIni = new IniFile("Settings.ini");
// Or specify a specific name in a specific dir
var MyIni = new IniFile(@"C:'Settings.ini");
您可以编写一些值，如下所示：
MyIni.Write("DefaultVolume", "100");
MyIni.Write("HomePage", "http://www.google.com");
要创建如下文件，请执行以下操作：
[MyProg]
DefaultVolume=100
HomePage=http://www.google.com
要从 INI 文件中读取值，请执行以下操作：
var DefaultVolume = MyIni.Read("DefaultVolume");
var HomePage = MyIni.Read("HomePage");
或者，您可以设置[Section] 的：
MyIni.Write("DefaultVolume", "100", "Audio");
MyIni.Write("HomePage", "http://www.google.com", "Web");
要创建如下文件，请执行以下操作：
[Audio]
DefaultVolume=100
[Web]
HomePage=http://www.google.com
您还可以检查是否存在密钥，如下所示：
if(!MyIni.KeyExists("DefaultVolume", "Audio"))
{
MyIni.Write("DefaultVolume", "100", "Audio");
}
您可以像这样删除密钥：
MyIni.DeleteKey("DefaultVolume", "Audio");
您还可以删除整个部分(包括所有键(，如下所示：
MyIni.DeleteSection("Web");
请随时评论任何改进！
.NET 框架的创建者希望您使用基于 XML 的配置文件，而不是 INI 文件。所以不，没有内置的机制来读取它们。
不过，有第三方解决方案可用。
- INI 处理程序可以作为 NuGet 包获取，例如 INI 分析器。
- 您可以编写自己的 INI 处理程序，这是老派的、费力的方式。它使您可以更好地控制实现，您可以将其用于坏或好。例如，参见使用 C#、P/Invoke 和 Win32 的 INI 文件处理类。
这篇关于CodeProject的文章"使用C#的INI文件处理类"应该会有所帮助。
作者创建了一个 C# 类"Ini"，它公开了 KERNEL32.dll 中的两个函数。这些功能是：WritePrivateProfileString和GetPrivateProfileString。您将需要两个命名空间：System.Runtime.InteropServices 和 System.Text 。
使用 Ini 类的步骤
在项目命名空间定义中添加
using INI;
像这样创建一个 INIFile
INIFile ini = new INIFile("C:''test.ini");
使用 IniWriteValue 将新值写入节中的特定键，或使用 IniReadValue 从特定节中的键读取值。
注意： 如果您从头开始，可以阅读此 MSDN 文章：如何：向 C# 项目添加应用程序配置文件。这是配置应用程序的更好方法。
我发现了这个简单的实现：
http://bytes.com/topic/net/insights/797169-reading-parsing-ini-file-c
适用于我需要的东西。
以下是您的使用方式：
public class TestParser
{
public static void Main()
{
IniParser parser = new IniParser(@"C:'test.ini");
String newMessage;
newMessage = parser.GetSetting("appsettings", "msgpart1");
newMessage += parser.GetSetting("appsettings", "msgpart2");
newMessage += parser.GetSetting("punctuation", "ex");
//Returns "Hello World!"
Console.WriteLine(newMessage);
Console.ReadLine();
}
}
这是代码：
using System;
using System.IO;
using System.Collections;
public class IniParser
{
private Hashtable keyPairs = new Hashtable();
private String iniFilePath;
private struct SectionPair
{
public String Section;
public String Key;
}
/// <summary>
/// Opens the INI file at the given path and enumerates the values in the IniParser.
/// </summary>
/// <param name="iniPath">Full path to INI file.</param>
public IniParser(String iniPath)
{
TextReader iniFile = null;
String strLine = null;
String currentRoot = null;
String[] keyPair = null;
iniFilePath = iniPath;
if (File.Exists(iniPath))
{
try
{
iniFile = new StreamReader(iniPath);
strLine = iniFile.ReadLine();
while (strLine != null)
{
strLine = strLine.Trim().ToUpper();
if (strLine != "")
{
if (strLine.StartsWith("[") && strLine.EndsWith("]"))
{
currentRoot = strLine.Substring(1, strLine.Length - 2);
}
else
{
keyPair = strLine.Split(new char[] { '=' }, 2);
SectionPair sectionPair;
String value = null;
if (currentRoot == null)
currentRoot = "ROOT";
sectionPair.Section = currentRoot;
sectionPair.Key = keyPair[0];
if (keyPair.Length > 1)
value = keyPair[1];
keyPairs.Add(sectionPair, value);
}
}
strLine = iniFile.ReadLine();
}
}
catch (Exception ex)
{
throw ex;
}
finally
{
if (iniFile != null)
iniFile.Close();
}
}
else
throw new FileNotFoundException("Unable to locate " + iniPath);
}
/// <summary>
/// Returns the value for the given section, key pair.
/// </summary>
/// <param name="sectionName">Section name.</param>
/// <param name="settingName">Key name.</param>
public String GetSetting(String sectionName, String settingName)
{
SectionPair sectionPair;
sectionPair.Section = sectionName.ToUpper();
sectionPair.Key = settingName.ToUpper();
return (String)keyPairs[sectionPair];
}
/// <summary>
/// Enumerates all lines for given section.
/// </summary>
/// <param name="sectionName">Section to enum.</param>
public String[] EnumSection(String sectionName)
{
ArrayList tmpArray = new ArrayList();
foreach (SectionPair pair in keyPairs.Keys)
{
if (pair.Section == sectionName.ToUpper())
tmpArray.Add(pair.Key);
}
return (String[])tmpArray.ToArray(typeof(String));
}
/// <summary>
/// Adds or replaces a setting to the table to be saved.
/// </summary>
/// <param name="sectionName">Section to add under.</param>
/// <param name="settingName">Key name to add.</param>
/// <param name="settingValue">Value of key.</param>
public void AddSetting(String sectionName, String settingName, String settingValue)
{
SectionPair sectionPair;
sectionPair.Section = sectionName.ToUpper();
sectionPair.Key = settingName.ToUpper();
if (keyPairs.ContainsKey(sectionPair))
keyPairs.Remove(sectionPair);
keyPairs.Add(sectionPair, settingValue);
}
/// <summary>
/// Adds or replaces a setting to the table to be saved with a null value.
/// </summary>
/// <param name="sectionName">Section to add under.</param>
/// <param name="settingName">Key name to add.</param>
public void AddSetting(String sectionName, String settingName)
{
AddSetting(sectionName, settingName, null);
}
/// <summary>
/// Remove a setting.
/// </summary>
/// <param name="sectionName">Section to add under.</param>
/// <param name="settingName">Key name to add.</param>
public void DeleteSetting(String sectionName, String settingName)
{
SectionPair sectionPair;
sectionPair.Section = sectionName.ToUpper();
sectionPair.Key = settingName.ToUpper();
if (keyPairs.ContainsKey(sectionPair))
keyPairs.Remove(sectionPair);
}
/// <summary>
/// Save settings to new file.
/// </summary>
/// <param name="newFilePath">New file path.</param>
public void SaveSettings(String newFilePath)
{
ArrayList sections = new ArrayList();
String tmpValue = "";
String strToSave = "";
foreach (SectionPair sectionPair in keyPairs.Keys)
{
if (!sections.Contains(sectionPair.Section))
sections.Add(sectionPair.Section);
}
foreach (String section in sections)
{
strToSave += ("[" + section + "]'r'n");
foreach (SectionPair sectionPair in keyPairs.Keys)
{
if (sectionPair.Section == section)
{
tmpValue = (String)keyPairs[sectionPair];
if (tmpValue != null)
tmpValue = "=" + tmpValue;
strToSave += (sectionPair.Key + tmpValue + "'r'n");
}
}
strToSave += "'r'n";
}
try
{
TextWriter tw = new StreamWriter(newFilePath);
tw.Write(strToSave);
tw.Close();
}
catch (Exception ex)
{
throw ex;
}
}
/// <summary>
/// Save settings back to ini file.
/// </summary>
public void SaveSettings()
{
SaveSettings(iniFilePath);
}
}
joerage回答中的代码鼓舞人心。
不幸的是，它更改了键的字符大小写，并且不处理注释。所以我写了一些应该足够健壮的东西来读取(仅(非常脏的 INI 文件，并允许按原样检索密钥。
它使用一些 LINQ(一种不区分大小写的嵌套字符串字典(来存储节、键和值，并一次性读取文件。
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
class IniReader
{
Dictionary<string, Dictionary<string, string>> ini = new Dictionary<string, Dictionary<string, string>>(StringComparer.InvariantCultureIgnoreCase);
public IniReader(string file)
{
var txt = File.ReadAllText(file);
Dictionary<string, string> currentSection = new Dictionary<string, string>(StringComparer.InvariantCultureIgnoreCase);
ini[""] = currentSection;
foreach(var line in txt.Split(new[]{"'n"}, StringSplitOptions.RemoveEmptyEntries)
.Where(t => !string.IsNullOrWhiteSpace(t))
.Select(t => t.Trim()))
{
if (line.StartsWith(";"))
continue;
if (line.StartsWith("[") && line.EndsWith("]"))
{
currentSection = new Dictionary<string, string>(StringComparer.InvariantCultureIgnoreCase);
ini[line.Substring(1, line.LastIndexOf("]") - 1)] = currentSection;
continue;
}
var idx = line.IndexOf("=");
if (idx == -1)
currentSection[line] = "";
else
currentSection[line.Substring(0, idx)] = line.Substring(idx + 1);
}
}
public string GetValue(string key)
{
return GetValue(key, "", "");
}
public string GetValue(string key, string section)
{
return GetValue(key, section, "");
}
public string GetValue(string key, string section, string @default)
{
if (!ini.ContainsKey(section))
return @default;
if (!ini[section].ContainsKey(key))
return @default;
return ini[section][key];
}
public string[] GetKeys(string section)
{
if (!ini.ContainsKey(section))
return new string[0];
return ini[section].Keys.ToArray();
}
public string[] GetSections()
{
return ini.Keys.Where(t => t != "").ToArray();
}
}
我想介绍一个我完全用 c# 创建的 IniParser 库，因此它不包含任何操作系统中的依赖项，这使得它与 Mono 兼容。具有 MIT 许可证的开源 - 因此它可以在任何代码中使用。
可以在 GitHub 中签出源代码，它也可以作为 NuGet 包提供
它是高度可配置的，并且使用起来非常简单。
很抱歉无耻的插头，但我希望它可以帮助任何重新审视这个答案的人。
如果只需要读取访问权限而不需要写入访问权限，并且使用的是Microsoft.Extensions.Confiuration(默认情况下与 ASP.NET Core 捆绑在一起，但也适用于常规程序(，则可以使用 NuGet 包Microsoft.Extensions.Configuration.Ini将 ini 文件导入到配置设置中。
public Startup(IHostingEnvironment env)
{
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddIniFile("SomeConfig.ini", optional: false);
Configuration = builder.Build();
}
PeanutButter.INI 是一个用于 INI 文件操作的 Nuget 打包类。它支持读/写，包括注释 - 您的注释在写入时保留。它似乎相当受欢迎，经过测试且易于使用。它也是完全免费和开源的。
免责声明：我是《花生酱.INI》的作者。
通常，使用 C# 和 .NET 框架创建应用程序时，不会使用 INI 文件。将设置存储在基于 XML 的配置文件或注册表中更为常见。但是，如果您的软件与旧版应用程序共享设置，则使用其配置文件可能比在其他地方复制信息更容易。
.NET 框架不支持直接使用 INI 文件。但是，您可以将 Windows API 函数与平台调用服务 (P/Invoke( 结合使用，以写入和读取文件。在此链接中，我们创建一个表示 INI 文件的类，并使用 Windows API 函数来操作它们。请通过以下链接。
读取和写入 INI 文件
如果您只想要一个没有部分和任何其他 dll 的简单阅读器，这里有一个简单的解决方案：
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Tool
{
public class Config
{
Dictionary <string, string> values;
public Config (string path)
{
values = File.ReadLines(path)
.Where(line => (!String.IsNullOrWhiteSpace(line) && !line.StartsWith("#")))
.Select(line => line.Split(new char[] { '=' }, 2, 0))
.ToDictionary(parts => parts[0].Trim(), parts => parts.Length>1?parts[1].Trim():null);
}
public string Value (string name, string value=null)
{
if (values!=null && values.ContainsKey(name))
{
return values[name];
}
return value;
}
}
}
使用示例：
file = new Tool.Config (Path.GetDirectoryName(System.Reflection.Assembly.GetExecutingAssembly().Location) + "''config.ini");
command = file.Value ("command");
action = file.Value ("action");
string value;
//second parameter is default value if no key found with this name
value = file.Value("debug","true");
this.debug = (value.ToLower()=="true" || value== "1");
value = file.Value("plain", "false");
this.plain = (value.ToLower() == "true" || value == "1");
同时配置文件内容(如您所见，支持#符号的行注释(：
#command to run
command = php
#default script
action = index.php
#debug mode
#debug = true
#plain text mode
#plain = false
#icon = favico.ico
试试这个方法：
public static Dictionary<string, string> ParseIniDataWithSections(string[] iniData)
{
var dict = new Dictionary<string, string>();
var rows = iniData.Where(t =>
!String.IsNullOrEmpty(t.Trim()) && !t.StartsWith(";") && (t.Contains('[') || t.Contains('=')));
if (rows == null || rows.Count() == 0) return dict;
string section = "";
foreach (string row in rows)
{
string rw = row.TrimStart();
if (rw.StartsWith("["))
section = rw.TrimStart('[').TrimEnd(']');
else
{
int index = rw.IndexOf('=');
dict[section + "-" + rw.Substring(0, index).Trim()] = rw.Substring(index+1).Trim().Trim('"');
}
}
return dict;
}
它创建键为"-"的字典。你可以像这样加载它：
var dict = ParseIniDataWithSections(File.ReadAllLines(fileName));
我加入聚会迟到了，但我今天遇到了同样的问题，我写了以下实现：
using System.Text.RegularExpressions;
static bool match(this string str, string pat, out Match m) =>
(m = Regex.Match(str, pat, RegexOptions.IgnoreCase)).Success;
static void Main()
{
Dictionary<string, Dictionary<string, string>> ini = new Dictionary<string, Dictionary<string, string>>();
string section = "";
foreach (string line in File.ReadAllLines(.........)) // read from file
{
string ln = (line.Contains('#') ? line.Remove(line.IndexOf('#')) : line).Trim();
if (ln.match(@"^[ 't]*'[(?<sec>['w'-]+)']", out Match m))
section = m.Groups["sec"].ToString();
else if (ln.match(@"^[ 't]*(?<prop>['w'-]+)'=(?<val>.*)", out m))
{
if (!ini.ContainsKey(section))
ini[section] = new Dictionary<string, string>();
ini[section][m.Groups["prop"].ToString()] = m.Groups["val"].ToString();
}
}
// access the ini file as follows:
string content = ini["section"]["property"];
}
必须注意的是，此实现不处理未找到的部分或属性。为此，应扩展 Dictionary<,> -类以处理未找到的键。
若要将 Dictionary<string, Dictionary<string, string>> 的实例序列化为 .ini -file，我使用以下代码：
string targetpath = .........;
Dictionary<string, Dictionary<string, string>> ini = ........;
StringBuilder sb = new StringBuilder();
foreach (string section in ini.Keys)
{
sb.AppendLine($"[{section}]");
foreach (string property in ini[section].Keys)
sb.AppendLine($"{property}={ini[section][property]");
}
File.WriteAllText(targetpath, sb.ToString());
CommonLibrary.NET 中有一个 Ini 解析器
它具有各种非常方便的重载，用于获取部分/值，并且重量非常轻。
这是我自己的版本，使用正则表达式。此代码假定每个节名称都是唯一的 - 但如果这不是真的 - 将字典替换为 List 是有意义的。此函数支持从 ';" 字符开始.ini文件注释。部分正常开始[部分]，键值对也正常出现"键=值"。与部分相同的假设 - 键名称是唯一的。
/// <summary>
/// Loads .ini file into dictionary.
/// </summary>
public static Dictionary<String, Dictionary<String, String>> loadIni(String file)
{
Dictionary<String, Dictionary<String, String>> d = new Dictionary<string, Dictionary<string, string>>();
String ini = File.ReadAllText(file);
// Remove comments, preserve linefeeds, if end-user needs to count line number.
ini = Regex.Replace(ini, @"^'s*;.*$", "", RegexOptions.Multiline);
// Pick up all lines from first section to another section
foreach (Match m in Regex.Matches(ini, "(^|['r'n])''[([^'r'n]*)'']['r'n]+(.*?)(''[([^'r'n]*)'']['r'n]+|$)", RegexOptions.Singleline))
{
String sectionName = m.Groups[2].Value;
Dictionary<String, String> lines = new Dictionary<String, String>();
// Pick up "key = value" kind of syntax.
foreach (Match l in Regex.Matches(ini, @"^'s*(.*?)'s*='s*(.*?)'s*$", RegexOptions.Multiline))
{
String key = l.Groups[1].Value;
String value = l.Groups[2].Value;
// Open up quotation if any.
value = Regex.Replace(value, "^'"(.*)'"$", "$1");
if (!lines.ContainsKey(key))
lines[key] = value;
}
if (!d.ContainsKey(sectionName))
d[sectionName] = lines;
}
return d;
}
如果你不需要花里胡哨(即部分(，这里有一个行：
List<(string, string)> ini = File.ReadLines(filename)
.Select(s => {
var spl = s.Split('=', 2);
return spl.Length == 2 ? (spl[0], spl[1]) : (s, "");
})
.Select(vt => (vt.Item1.Trim(), vt.Item2.Trim()))
.Where(vt => vt.Item1 != "")
.ToList();
写：
File.WriteAllLines(filename, ini.Select(vt => $"{vt.Item1}={vt.Item2}"));
(如果您不关心重复项，请使用.ToDictionary()而不是.ToList()以便于访问(
这是我
的类，就像一个魅力：
public static class IniFileManager
{
[DllImport("kernel32")]
private static extern long WritePrivateProfileString(string section,
string key, string val, string filePath);
[DllImport("kernel32")]
private static extern int GetPrivateProfileString(string section,
string key, string def, StringBuilder retVal,
int size, string filePath);
[DllImport("kernel32.dll")]
private static extern int GetPrivateProfileSection(string lpAppName,
byte[] lpszReturnBuffer, int nSize, string lpFileName);
/// <summary>
/// Write Data to the INI File
/// </summary>
/// <PARAM name="Section"></PARAM>
/// Section name
/// <PARAM name="Key"></PARAM>
/// Key Name
/// <PARAM name="Value"></PARAM>
/// Value Name
public static void IniWriteValue(string sPath,string Section, string Key, string Value)
{
WritePrivateProfileString(Section, Key, Value, sPath);
}
/// <summary>
/// Read Data Value From the Ini File
/// </summary>
/// <PARAM name="Section"></PARAM>
/// <PARAM name="Key"></PARAM>
/// <PARAM name="Path"></PARAM>
/// <returns></returns>
public static string IniReadValue(string sPath,string Section, string Key)
{
StringBuilder temp = new StringBuilder(255);
int i = GetPrivateProfileString(Section, Key, "", temp,
255, sPath);
return temp.ToString();
}
}
使用是显而易见的，因为它是一个静态类，只需调用 IniFileManager.IniWriteValue 来读取一个部分或调用 IniFileManager.IniReadValue 来读取一个部分。
您应该从 xml 文件中读取和写入数据，因为您可以将整个对象保存到 xml，也可以从保存的 xml 填充对象。最好是易于操作的对象。
这是操作方法：将对象数据写入 XML 文件：https://msdn.microsoft.com/en-us/library/ms172873.aspx从 XML 文件中读取对象数据：https://msdn.microsoft.com/en-us/library/ms172872.aspx