Как сохранить настройки приложения в приложении Windows Forms? - PullRequest
Новая
       282

Как сохранить настройки приложения в приложении Windows Forms?

544 голосов
/ 17 января 2009

То, чего я хочу достичь, очень просто: у меня есть приложение Windows Forms (.NET 3.5), которое использует путь для чтения информации. Этот путь может быть изменен пользователем с помощью формы параметров, которую я предоставляю.

Теперь я хочу сохранить значение пути в файле для последующего использования. Это будет одна из многих настроек, сохраненных в этом файле. Этот файл будет находиться непосредственно в папке приложения.

Я понимаю, что доступны три варианта:

  • Файл настроек конфигурации (appname.exe.config)
  • Registry
  • Пользовательский XML-файл

Я прочитал, что файл конфигурации .NET не предназначен для сохранения значений обратно в него. Что касается реестра, я хотел бы получить как можно дальше от него.

Значит ли это, что мне следует использовать собственный XML-файл для сохранения настроек конфигурации? Если так, я хотел бы видеть пример кода этого (C #).

Я видел другие дискуссии на эту тему, но мне все еще неясно.

Ответы [ 13 ]

564 голосов
/ 17 января 2009

Если вы работаете с Visual Studio, то получить постоянные настройки довольно просто. Щелкните правой кнопкой мыши проект в обозревателе решений, выберите «Свойства». Выберите вкладку «Настройки», нажмите на гиперссылку, если настройки не существуют. Используйте вкладку «Настройки» для создания настроек приложения. Visual Studio создает файлы Settings.settings и Settings.Designer.settings, которые содержат одноэлементный класс Settings, унаследованный от ApplicationSettingsBase . Вы можете получить доступ к этому классу из своего кода для чтения / записи настроек приложения: 

Properties.Settings.Default["SomeProperty"] = "Some Value";
Properties.Settings.Default.Save(); // Saves settings in application configuration file

Этот метод применим как для консоли, Windows Forms и других типов проектов.

Обратите внимание, что вам нужно установить свойство scope ваших настроек. Если вы выберите Область приложения, тогда Settings.Default. <Ваше свойство> будет доступно только для чтения.

89 голосов
/ 01 июля 2011

Если вы планируете сохранить файл в том же каталоге, что и ваш исполняемый файл, вот хорошее решение, которое использует формат JSON : 

using System;
using System.IO;
using System.Web.Script.Serialization;

namespace MiscConsole
{
    class Program
    {
        static void Main(string[] args)
        {
            MySettings settings = MySettings.Load();
            Console.WriteLine("Current value of 'myInteger': " + settings.myInteger);
            Console.WriteLine("Incrementing 'myInteger'...");
            settings.myInteger++;
            Console.WriteLine("Saving settings...");
            settings.Save();
            Console.WriteLine("Done.");
            Console.ReadKey();
        }

        class MySettings : AppSettings<MySettings>
        {
            public string myString = "Hello World";
            public int myInteger = 1;
        }
    }

    public class AppSettings<T> where T : new()
    {
        private const string DEFAULT_FILENAME = "settings.json";

        public void Save(string fileName = DEFAULT_FILENAME)
        {
            File.WriteAllText(fileName, (new JavaScriptSerializer()).Serialize(this));
        }

        public static void Save(T pSettings, string fileName = DEFAULT_FILENAME)
        {
            File.WriteAllText(fileName, (new JavaScriptSerializer()).Serialize(pSettings));
        }

        public static T Load(string fileName = DEFAULT_FILENAME)
        {
            T t = new T();
            if(File.Exists(fileName))
                t = (new JavaScriptSerializer()).Deserialize<T>(File.ReadAllText(fileName));
            return t;
        }
    }
}
66 голосов
/ 17 января 2009

Реестр запрещён. Вы не уверены, имеет ли пользователь, который использует ваше приложение, достаточные права для записи в реестр.

Вы можете использовать файл app.config для сохранения настроек уровня приложения (которые одинаковы для каждого пользователя, использующего ваше приложение).

Я бы сохранял пользовательские настройки в файле XML, который сохранялся бы в изолированном хранилище или в каталоге SpecialFolder.ApplicationData .

Кроме того, начиная с .NET 2.0 можно сохранять значения обратно в файл app.config.

20 голосов
/ 17 января 2009

Класс ApplicationSettings не поддерживает сохранение настроек в файл app.config. По замыслу это очень важно, приложения, работающие с должным образом защищенной учетной записью пользователя (например, Vista UAC), не имеют доступа для записи в папку установки программы.

Вы можете бороться с системой с классом ConfigurationManager. Но тривиальный обходной путь заключается в том, чтобы зайти в конструктор настроек и изменить область настройки на «Пользователь». Если это вызывает затруднения (скажем, настройка важна для каждого пользователя), вы должны поместить свою опцию «Параметры» в отдельную программу, чтобы вы могли запросить запрос на повышение привилегий. Или отказаться от настройки.

15 голосов
/ 07 июня 2016

Я хотел поделиться библиотекой, которую я создал для этого. Это крошечная библиотека, но большое улучшение (IMHO) по сравнению с файлами .settings.

Библиотека называется Jot (GitHub) , вот старая Статья Code Project Я писал об этом.

Вот как вы можете использовать его для отслеживания размера и местоположения окна: 

public MainWindow()
{
    InitializeComponent();

    _stateTracker.Configure(this)
        .IdentifyAs("MyMainWindow")
        .AddProperties(nameof(Height), nameof(Width), nameof(Left), nameof(Top), nameof(WindowState))
        .RegisterPersistTrigger(nameof(Closed))
        .Apply();
}

Преимущество по сравнению с файлами .settings: В нем значительно меньше кода, и он намного менее подвержен ошибкам, поскольку вам нужно только упомянуть каждое свойство один раз .

В файлах настроек вам нужно упоминать каждое свойство пять раз: один раз, когда вы явно создаете свойство, и еще четыре раза в коде, который копирует значения туда и обратно.

Хранение, сериализация и т. Д. Полностью настраиваются. Когда целевые объекты создаются контейнером IOC, вы можете [подключить его] [], чтобы он автоматически применял отслеживание ко всем объектам, которые он разрешает, и все, что вам нужно сделать, чтобы сделать свойство постоянным, - добавить атрибут [Trackable] на нем.

Он легко настраивается, вы можете настроить: - когда данные сохраняются и применяются глобально или для каждого отслеживаемого объекта - как это сериализовано - где он хранится (например, файл, база данных, онлайн, изолированное хранилище, реестр) - правила, которые могут отменить применение / сохранение данных для свойства

Поверьте мне, библиотека на высшем уровне!

14 голосов
/ 11 октября 2011

Аргумент registry / configurationSettings / XML по-прежнему выглядит очень активным. Я использовал их все по мере развития технологии, но мой любимый основан на системе Трида в сочетании с изолированным хранилищем .

Следующий пример позволяет хранить объекты с именем properties в файле в изолированном хранилище. Такие как: 

AppSettings.Save(myobject, "Prop1,Prop2", "myFile.jsn");

Свойства могут быть восстановлены с использованием: 

AppSettings.Load(myobject, "myFile.jsn");

Это просто образец, не предполагающий лучших практик. 

internal static class AppSettings
{
    internal static void Save(object src, string targ, string fileName)
    {
        Dictionary<string, object> items = new Dictionary<string, object>();
        Type type = src.GetType();

        string[] paramList = targ.Split(new char[] { ',' });
        foreach (string paramName in paramList)
            items.Add(paramName, type.GetProperty(paramName.Trim()).GetValue(src, null));

        try
        {
            // GetUserStoreForApplication doesn't work - can't identify.
            // application unless published by ClickOnce or Silverlight
            IsolatedStorageFile storage = IsolatedStorageFile.GetUserStoreForAssembly();
            using (IsolatedStorageFileStream stream = new IsolatedStorageFileStream(fileName, FileMode.Create, storage))
            using (StreamWriter writer = new StreamWriter(stream))
            {
                writer.Write((new JavaScriptSerializer()).Serialize(items));
            }

        }
        catch (Exception) { }   // If fails - just don't use preferences
    }

    internal static void Load(object tar, string fileName)
    {
        Dictionary<string, object> items = new Dictionary<string, object>();
        Type type = tar.GetType();

        try
        {
            // GetUserStoreForApplication doesn't work - can't identify
            // application unless published by ClickOnce or Silverlight
            IsolatedStorageFile storage = IsolatedStorageFile.GetUserStoreForAssembly();
            using (IsolatedStorageFileStream stream = new IsolatedStorageFileStream(fileName, FileMode.Open, storage))
            using (StreamReader reader = new StreamReader(stream))
            {
                items = (new JavaScriptSerializer()).Deserialize<Dictionary<string, object>>(reader.ReadToEnd());
            }
        }
        catch (Exception) { return; }   // If fails - just don't use preferences.

        foreach (KeyValuePair<string, object> obj in items)
        {
            try
            {
                tar.GetType().GetProperty(obj.Key).SetValue(tar, obj.Value, null);
            }
            catch (Exception) { }
        }
    }
}
11 голосов
/ 25 ноября 2015

Простой способ - использовать объект данных конфигурации, сохранить его в виде файла XML с именем приложения в локальной папке и при запуске прочитать его обратно.

Вот пример для хранения позиции и размера формы.

Объект данных конфигурации строго типизирован и прост в использовании: 

[Serializable()]
public class CConfigDO
{
    private System.Drawing.Point m_oStartPos;
    private System.Drawing.Size m_oStartSize;

    public System.Drawing.Point StartPos
    {
        get { return m_oStartPos; }
        set { m_oStartPos = value; }
    }

    public System.Drawing.Size StartSize
    {
        get { return m_oStartSize; }
        set { m_oStartSize = value; }
    }
}

Управляющий класс для сохранения и загрузки: 

public class CConfigMng
{
    private string m_sConfigFileName = System.IO.Path.GetFileNameWithoutExtension(System.Windows.Forms.Application.ExecutablePath) + ".xml";
    private CConfigDO m_oConfig = new CConfigDO();

    public CConfigDO Config
    {
        get { return m_oConfig; }
        set { m_oConfig = value; }
    }

    // Load configuration file
    public void LoadConfig()
    {
        if (System.IO.File.Exists(m_sConfigFileName))
        {
            System.IO.StreamReader srReader = System.IO.File.OpenText(m_sConfigFileName);
            Type tType = m_oConfig.GetType();
            System.Xml.Serialization.XmlSerializer xsSerializer = new System.Xml.Serialization.XmlSerializer(tType);
            object oData = xsSerializer.Deserialize(srReader);
            m_oConfig = (CConfigDO)oData;
            srReader.Close();
        }
    }

    // Save configuration file
    public void SaveConfig()
    {
        System.IO.StreamWriter swWriter = System.IO.File.CreateText(m_sConfigFileName);
        Type tType = m_oConfig.GetType();
        if (tType.IsSerializable)
        {
            System.Xml.Serialization.XmlSerializer xsSerializer = new System.Xml.Serialization.XmlSerializer(tType);
            xsSerializer.Serialize(swWriter, m_oConfig);
            swWriter.Close();
        }
    }
}

Теперь вы можете создать экземпляр и использовать в событиях загрузки и закрытия формы: 

    private CConfigMng oConfigMng = new CConfigMng();

    private void Form1_Load(object sender, EventArgs e)
    {
        // Load configuration
        oConfigMng.LoadConfig();
        if (oConfigMng.Config.StartPos.X != 0 || oConfigMng.Config.StartPos.Y != 0)
        {
            Location = oConfigMng.Config.StartPos;
            Size = oConfigMng.Config.StartSize;
        }
    }

    private void Form1_FormClosed(object sender, FormClosedEventArgs e)
    {
        // Save configuration
        oConfigMng.Config.StartPos = Location;
        oConfigMng.Config.StartSize = Size;
        oConfigMng.SaveConfig();
    }

И созданный XML-файл также доступен для чтения: 

<?xml version="1.0" encoding="utf-8"?>
<CConfigDO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartPos>
    <X>70</X>
    <Y>278</Y>
  </StartPos>
  <StartSize>
    <Width>253</Width>
    <Height>229</Height>
  </StartSize>
</CConfigDO>
7 голосов
/ 10 сентября 2009

Мне не нравится предлагаемое решение использования web.config или app.config. Попробуйте прочитать свой собственный XML. Взгляните на Файлы настроек XML - больше нет web.config .

4 голосов
/ 19 сентября 2014

Другие опции, вместо использования пользовательского файла XML, мы можем использовать более удобный для пользователя формат файла: файл JSON или YAML.

  • Если вы используете динамический .NET 4.0, эта библиотека действительно проста в использовании (сериализация, десериализация, поддержка вложенных объектов и упорядочение вывода по вашему желанию + объединение нескольких настроек в одну) JsonConfig (использование эквивалентно ApplicationSettingsBase)
  • Для библиотеки конфигурации .NET YAML ... Я не нашел такую, которая прост в использовании как JsonConfig

Вы можете сохранить файл настроек в нескольких специальных папках (для всех пользователей и для каждого пользователя), как указано здесь Перечисление Environment.SpecialFolder и несколько файлов (только для чтения по умолчанию, для каждой роли, для каждого пользователя и т. Д.). )

Если вы решите использовать несколько настроек, вы можете объединить эти настройки: Например, объединение настроек по умолчанию + BasicUser + AdminUser. Вы можете использовать свои собственные правила: последнее переопределяет значение и т. Д.

3 голосов
/ 14 декабря 2017

"Значит ли это, что я должен использовать собственный XML-файл для сохранения настроек конфигурации?" Нет, не обязательно Мы используем SharpConfig для таких операций.

Например, если файл конфигурации такой 

[General]
# a comment
SomeString = Hello World!
SomeInteger = 10 # an inline comment

Мы можем получить такие значения, как это 

var config = Configuration.LoadFromFile("sample.cfg");
var section = config["General"];

string someString = section["SomeString"].StringValue;
int someInteger = section["SomeInteger"].IntValue;

Совместимо с .Net 2.0 и выше. Мы можем создавать файлы конфигурации на лету и сохранить их позже. Источник: http://sharpconfig.net/ Github: https://github.com/cemdervis/SharpConfig

Надеюсь, это поможет.

Страница:
...