Чтение / запись INI-файла
https://stackoverflow.com/questions/217902
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianВопрос
Есть ли какой-либо класс в .NET framework, который может читать / записывать стандартные файлы .ini:
[Section]
<keyname>=<value>
...
В Delphi есть TIniFile компонент, и я хочу знать, есть ли что-нибудь подобное для C #?
Решение
Создатели .NET Framework хотят, чтобы вы использовали конфигурационные файлы на основе XML, а не INI-файлы.Так что нет, встроенного механизма для их чтения нет.
Однако существуют сторонние решения.
- Обработчики INI могут быть получены следующим образом Пакеты NuGet, такие как Анализатор INI.
- Вы можете написать свой собственный обработчик INI, который является олдскульным, трудоемким способом.Это дает вам больше контроля над реализацией, которую вы можете использовать во вред или во благо.Смотрите , например класс обработки INI-файлов с использованием C #, P /Invoke и Win32.
Другие советы
Введение
Во-первых, прочитайте этот пост в блоге MSDN на ограничениях файлов INI , Если это соответствует вашим потребностям, читайте дальше.
Это сжатая реализация, которую я написал с использованием оригинального Windows P / Invoke, поэтому она поддерживается всеми версиями Windows с установленным .NET (то есть Windows 98 - Windows 10). Настоящим я передаю его в общественное достояние - вы можете свободно использовать его в коммерческих целях без указания авторства.
Крошечный класс
Добавьте новый класс с именем 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.ToString();
}
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;
}
}
}
Как его использовать
Откройте файл INI одним из 3 следующих способов:
// 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 = IniFile.Read("DefaultVolume");
var HomePage = IniFile.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");
Пожалуйста, не стесняйтесь комментировать любые улучшения!
Эта статья о CodeProject " Класс обработки файлов INI с использованием C # <> Quot!; должно помочь.
Автор создал класс 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/ сеть / понимание / 797169-чтение-синтаксический-ини-файлов с
Хорошо работает для того, что мне нужно.
Вот как вы это используете:
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);
}
}
Код в ответе Джоериджа вдохновляет.
К сожалению, он меняет регистр символов клавиш и не обрабатывает комментарии. Поэтому я написал что-то, что должно быть достаточно надежным, чтобы читать (только) очень грязные 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();
}
}
Я хочу представить библиотеку IniParser, которую я полностью создал в c #, поэтому она не содержит зависимостей ни в одной ОС, что делает ее Mono-совместимой. Открытый исходный код с лицензией MIT, поэтому его можно использовать в любом коде.
Вы можете проверить источник в GitHub , и это также доступен в виде пакета NuGet
Он легко настраивается и очень прост в использовании .
Извините за бесстыдный плагин, но я надеюсь, что он может помочь любому, кто вернется к этому ответу.
Обычно при создании приложений с использованием C # и платформы .NET вы не будете использовать файлы INI. Чаще всего параметры хранятся в файле конфигурации на основе XML или в реестре. Однако, если ваше программное обеспечение использует общие настройки с унаследованным приложением, может быть проще использовать его файл конфигурации, чем дублировать информацию в другом месте.
.NET Framework не поддерживает непосредственное использование файлов INI. Тем не менее, вы можете использовать функции Windows API с Platform Invocation Services (P / Invoke) для записи и чтения из файлов. В этой ссылке мы создаем класс, который представляет INI-файлы и использует функции Windows API для управления ими. Пожалуйста, перейдите по следующей ссылке.
Я опоздал, чтобы вступить в партию, но у меня была та же проблема сегодня, и я написал следующую реализацию:
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 - файл, я использую следующий код:
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());
Ini Parser доступен в CommonLibrary.NET
Это имеет различные очень удобные перегрузки для получения разделов / значений и очень легкий вес.
Вот моя собственная версия с использованием регулярных выражений. В этом коде предполагается, что каждое имя раздела уникально - если, однако, это не так - имеет смысл заменить словарь списком. Эта функция поддерживает комментирование файла .ini, начиная с ';' персонаж. Секция начинается нормально [section], и пары ключ-значение также приходят обычно & Quot; ключ = значение & Quot ;. То же самое, что и для разделов - имя ключа уникально.
/// <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;
}
Попробуйте этот метод:
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));
PeanutButter.INI - это пакет Nuget для манипулирования файлами INI. Он поддерживает чтение / запись, включая комментарии & # 8211; Ваши комментарии сохраняются при записи. Похоже, он достаточно популярен, проверен и прост в использовании. Это также абсолютно бесплатно и с открытым исходным кодом.
Отказ от ответственности: я являюсь автором PeanutButter.INI.
Если вам нужен простой читатель без разделов и любых других библиотек, вот простое решение:
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
Если вам нужен только доступ на чтение, а не доступ на запись, и вы используете 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();
}
Вот мой класс, работает как по волшебству :
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 / библиотека / ms172873.aspx Прочитать данные объекта из файла XML: https://msdn.microsoft.com/en -us / библиотека / ms172872.aspx
