Есть ли какой-либо класс в .NET framework, который может читать/записывать стандартные .ini файлы:
[Section]
<keyname>=<value>
...
Delphi имеет компонент TIniFile, и я хочу знать, есть ли что-то подобное для С#?
Чтение/запись INI файла
Ответ 1
Создатели платформы .NET хотят, чтобы вы использовали файлы конфигурации на основе XML, а не файлы INI. Нет, нет встроенного механизма для их чтения.
Однако существуют сторонние решения.
- Обработчики INI могут быть получены как пакеты NuGet, такие как INI Parser.
- Вы можете написать свой собственный обработчик INI, который является старой школой, кропотливым способом. Это дает вам больше контроля над реализацией, которую вы можете использовать для плохого или хорошего. См. класс обработки INI файлов с использованием С#, P/Invoke и Win32.
Ответ 2
Введение
Во-первых, прочитайте это сообщение в блоге 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 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 файл одним из следующих способов:
// 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] 's:
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");
Пожалуйста, не стесняйтесь комментировать любые улучшения!
Ответ 3
Эта статья о CodeProject " класс обработки файлов INI с использованием С#" должна помочь.
Автор создал класс С# "Ini", который предоставляет две функции из KERNEL32.dll. Эти функции: WritePrivateProfileString и GetPrivateProfileString. Вам понадобятся два пространства имен: System.Runtime.InteropServices и System.Text.
Шаги по использованию класса Ini
В определении пространства имен проекта добавьте
using INI;
Создайте INIFile, как этот
INIFile ini = new INIFile("C:\\test.ini");
Используйте IniWriteValue для записи нового значения в конкретный ключ в разделе или используйте IniReadValue для чтения значения FROM ключа в определенной секции.
Примечание. Если вы начинаете с нуля, вы можете прочитать эту статью MSDN: Как добавить файлы конфигурации приложения в Проекты С#. Это лучший способ настройки вашего приложения.
Ответ 4
Я нашел эту простую реализацию:
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);
}
}
Ответ 5
Код в сообщении 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();
}
}
Ответ 6
Я хочу представить библиотеку IniParser, полностью созданную в С#, поэтому она не содержит зависимостей в любой ОС, что делает ее совместимой с Mono. Open Source с лицензией MIT, так как он может использоваться в любом коде.
Вы можете проверить источник в GitHub, а также доступен как пакет NuGet
Он сильно настраиваемый и действительно прост в использовании.
Извините за бесстыдный плагин, но я надеюсь, что это может помочь любому, кто пересматривает этот ответ.
Ответ 7
Вы можете использовать SharpConfig для чтения файлов .cfg и/или .ini. Это простая в использовании библиотека config для .NET.
Ответ 8
Обычно, когда вы создаете приложения с использованием С# и .NET framework, вы не будете использовать INI файлы. Чаще всего хранить настройки в файле конфигурации на базе XML или в реестре. Однако, если ваше программное обеспечение обменивается настройками с устаревшим приложением, может быть проще использовать его файл конфигурации, а не дублировать информацию в другом месте.
.NET framework не поддерживает использование файлов INI напрямую. Однако вы можете использовать функции Windows API с помощью служб Invocation Services (P/Invoke) для записи и чтения из файлов. В этой ссылке мы создаем класс, который представляет файлы INI, и использует функции Windows API для управления ими. Перейдите по следующей ссылке.
Ответ 9
Существует Ini Parser, доступный в CommonLibrary.NET
У этого есть различные очень удобные перегрузки для получения разделов/значений и очень легкий вес.
Ответ 10
Вот моя собственная версия, используя регулярные выражения. Этот код предполагает, что имя каждого раздела уникально - если это не так, имеет смысл заменить словарь со списком. Эта функция поддерживает комментарии .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;
}
Ответ 11
Попробуйте этот метод:
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));
Ответ 12
Я опаздываю, чтобы присоединиться к вечеринке, но сегодня у меня была такая же проблема, и я написал следующую реализацию:
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());
Ответ 13
Если вам нужен только доступ на чтение и доступ без записи, и вы используете 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();
}
Ответ 14
PeanutButter.INI - это пакет, упакованный в Nuget для обработки файлов INI. Он поддерживает чтение/запись, включая комментарии - ваши комментарии сохраняются при записи. Он, по-видимому, достаточно популярен, протестирован и прост в использовании. Это также совершенно бесплатно и с открытым исходным кодом.
Отказ от ответственности: я автор PeanutButter.INI.
Ответ 15
Если вы хотите, чтобы простой читатель без разделов и других 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
Ответ 16
Вы должны читать и записывать данные из xml файлов, так как вы можете сохранить целый объект в xml, а также вы можете заполнить объект из сохраненного xml. Лучше всего легко манипулировать объектами.
Вот как это сделать: Запись данных объекта в файл XML: https://msdn.microsoft.com/en-us/library/ms172873.aspx Чтение данных объекта из файла XML: https://msdn.microsoft.com/en-us/library/ms172872.aspx