在WPF .Net Core中保留用户设置

时间:2019-07-02 07:39:39

标签: c# wpf .net-core

使用.Net Core> = 3.0持久保存WPF应用程序的用户设置的首选方法是什么?

创建了WPF .Net Core 3.0项目(VS2019 V16.1.3) 现在,我已经看到不再有Properties.Settings部分。在线搜索之后,开始深入研究Microsoft.Extensions.Configuration。

除了the肿的代码可以访问设置外,现在更糟->无法保存吗?
User Configuration Settings in .NET Core

  

幸运的是,Microsoft.Extensions.Configuration   不支持按设计保存。阅读本Github问题Why there is no save in ConfigurationProvider?

中的更多内容


坚持使用.Net Core> = 3.0的WPF应用程序保留用户设置的首选(便捷/快速/简单)方式是什么?


<= .Net 4.8之前,它很简单:

  • 将变量添加到属性。 User Settings

  • 在启动时读取变量
    var culture = new CultureInfo(Properties.Settings.Default.LanguageSettings);

  • 当变量更改时->立即保存
    Properties.Settings.Default.LanguageSettings = selected.TwoLetterISOLanguageName; Properties.Settings.Default.Save();

6 个答案:

答案 0 :(得分:6)

enter image description here

您可以添加相同的旧有效设置文件,例如通过右键单击属性->添加->新项目,然后搜索“设置”。可以在设置设计器中编辑该文件,然后在.net Framework项目中使用该文件(ConfigurationManager,Settings.Default.Upgrade(),Settings.Default.Save等起作用)。

还将app.config文件添加到项目根文件夹(通过添加->新建项的相同方法),再次保存设置,编译项目,您将在输出中找到一个.dll.config文件。夹。您现在可以像以前一样更改默认的应用程序值。

在Visual Studio 1.16.3.5和.net core 3.0 WPF项目中进行了测试。

答案 1 :(得分:5)

正如您所引用的帖子中所指出的那样,配置API是为您的应用设置一次的设置,或者至少是只读的。如果您的主要目标是保持简单/快速/简单的用户设置,则可以自己汇总一些内容。与旧的API类似,将设置存储在ApplicationData文件夹中。

public class SettingsManager<T> where T : class
{
    private readonly string _filePath;

    public SettingsManager(string fileName)
    {
        _filePath = GetLocalFilePath(fileName);
    }

    private string GetLocalFilePath(string fileName)
    {
        string appData = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData);
        return Path.Combine(appData, fileName);
    }

    public T LoadSettings() =>
        File.Exists(_filePath) ?
        JsonConvert.DeserializeObject<T>(File.ReadAllText(_filePath)) :
        null;

    public void SaveSettings(T settings)
    {
        string json = JsonConvert.SerializeObject(settings);
        File.WriteAllText(_filePath, json);
    }
}

使用最基础的UserSettings

的演示
public class UserSettings
{
    public string Name { get; set; }
}

我将不提供完整的MVVM示例,但仍然在内存中有一个实例,参考号_userSettings。加载设置后,演示将覆盖其默认属性。当然,在生产中,您不会在启动时提供默认值。只是出于说明的目的。

public partial class MainWindow : Window
{
    private readonly SettingsManager<UserSettings> _settingsManager;
    private UserSettings _userSettings;

    public MainWindow()
    {
        InitializeComponent();

        _userSettings = new UserSettings() { Name = "Funk" };
        _settingsManager = new SettingsManager<UserSettings>("UserSettings.json");
    }

    private void Button_FromMemory(object sender, RoutedEventArgs e)
    {
        Apply(_userSettings);
    }

    private void Button_LoadSettings(object sender, RoutedEventArgs e)
    {
        _userSettings = _settingsManager.LoadSettings();
        Apply(_userSettings);
    }

    private void Button_SaveSettings(object sender, RoutedEventArgs e)
    {
        _userSettings.Name = textBox.Text;
        _settingsManager.SaveSettings(_userSettings);
    }

    private void Apply(UserSettings userSettings)
    {
        textBox.Text = userSettings?.Name ?? "No settings found";
    }
}

XAML

<Window x:Class="WpfApp.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:WpfApp"
        mc:Ignorable="d"
        Title="MainWindow" Height="450" Width="800">
    <Window.Resources>
        <Style TargetType="Button">
            <Setter Property="Margin" Value="10"/>
        </Style> 
    </Window.Resources>
    <Grid Margin="10">
        <Grid.RowDefinitions>
            <RowDefinition/>
            <RowDefinition Height="Auto"/>
            <RowDefinition Height="Auto"/>
            <RowDefinition Height="Auto"/>
        </Grid.RowDefinitions>
        <TextBox Grid.Row="0" x:Name="textBox" Width="150" HorizontalAlignment="Center" VerticalAlignment="Center"/>
        <Button Grid.Row="1" Click="Button_FromMemory">From Memory</Button>
        <Button Grid.Row="2" Click="Button_LoadSettings">Load Settings</Button>
        <Button Grid.Row="3" Click="Button_SaveSettings">Save Settings</Button>
    </Grid>
</Window>

答案 2 :(得分:4)

对于Wpf Net.Core

项目,单击鼠标右键->添加新项->设置文件(常规)

使用

display: flow-root;

“ Settings1”在其中创建文件名的地方

示例

双击“ Settings1.settings ”文件并编辑

Settings1.Default.Height = this.Height;
Settings1.Default.Width = this.Width;

this.Height = Settings1.Default.Height;
this.Width = Settings1.Default.Width;

Settings1.Default.Save();

答案 3 :(得分:3)

您可以使用Nuget软件包System.Configuration.ConfigurationManager。它与.Net Standard 2.0兼容,因此应在.Net Core应用程序中使用。

没有用于此的设计器,但否则它的作用与.Net版本相同,因此您应该可以仅从Settings.Designer.cs复制代码。另外,您可以覆盖OnPropertyChanged,因此无需调用Save

以下是一个示例,来自正在运行的.Net Standard项目:

public class WatchConfig: ApplicationSettingsBase
{
    static WatchConfig _defaultInstance = (WatchConfig)Synchronized(new WatchConfig());

    public static WatchConfig Default { get => _defaultInstance; }

    protected override void OnPropertyChanged(object sender, PropertyChangedEventArgs e)
    {
        Save();
        base.OnPropertyChanged(sender, e);
    }

    [UserScopedSetting]
    [global::System.Configuration.DefaultSettingValueAttribute(
    @"<?xml    version=""1.0"" encoding=""utf-16""?>
    <ArrayOfString>
      <string>C:\temp</string>
     <string>..\otherdir</string>
     </ArrayOfString>")]
    public StringCollection Directories
    {
        get { return (StringCollection)this[nameof(Directories)]; }
        set { this[nameof(Directories)] = value; }
    }
}

答案 4 :(得分:3)

基于Funk的answer,这是一个抽象的通用单例样式变体,它删除了SettingsManager周围的一些管理,使创建附加设置类和使用它们尽可能简单:

类型设置类别:

//Use System.Text.Json attributes to control serialization and defaults
public class MySettings : SettingsManager<MySettings>
{
    public bool SomeBoolean { get; set; }
    public string MyText { get; set; }
}

用法:

//Loading and reading values
MySettings.Load();
var theText = MySettings.Instance.MyText;
var theBool = MySettings.Instance.SomeBoolean;

//Updating values
MySettings.Instance.MyText = "SomeNewText"
MySettings.Save();

正如您所看到的,创建和使用设置的行数非常少,并且由于没有参数而更加严格。

基类定义设置的存储位置,并且每个MySettings子类仅允许一个设置文件-程序集和类名称确定其位置。为了替换足够的属性文件。

using System;
using System.IO;
using System.Linq;
using System.Reflection;

public abstract class SettingsManager<T> where T : SettingsManager<T>, new()
{
    private static readonly string filePath = GetLocalFilePath($"{typeof(T).Name}.json");

    public static T Instance { get; private set; }

    private static string GetLocalFilePath(string fileName)
    {
        string appData = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData); 
        var companyName = Assembly.GetEntryAssembly().GetCustomAttributes<AssemblyCompanyAttribute>().FirstOrDefault();
        return Path.Combine(appData, companyName?.Company ?? Assembly.GetEntryAssembly().GetName().Name, fileName);
    }

    public static void Load()
    {
        if (File.Exists(filePath))
            Instance = System.Text.Json.JsonSerializer.Deserialize<T>(File.ReadAllText(filePath));
        else
            Instance = new T(); 
    }

    public static void Save()
    {
        string json = System.Text.Json.JsonSerializer.Serialize(Instance);
        Directory.CreateDirectory(Path.GetDirectoryName(filePath));
        File.WriteAllText(filePath, json);
    }
}

在禁用设置子类的构造函数和创建SettingsManager<T>.Instance而不用Load()的情况下,可能会进行一些改进。这取决于您自己的用例。

答案 5 :(得分:0)

只需双击项目中的Settings.settings文件。它仍将像以前一样在设计器中打开。您只是不再在“属性”窗口中列出它。