将设置类添加到UWP应用程序

时间:2016-02-18 00:21:27

标签: c# settings win-universal-app appsettings windows-10-universal

我正在开发通用Windows平台应用,但Visual Studio中没有设置模板。

如何实现一个简单,强类型和可观察的类,将我的设置存储在LocalSettings或RoamingSettings中?

1 个答案:

答案 0 :(得分:54)

  1. 创建一个继承自ObservableSettings的新类。
  2. 调用基类构造函数,指示是否要将设置存储在 LocalSettings RoamingSettings 中。
  3. 添加调用基类成员的所有属性 在getter和setter中设置获取。无需传递属性名称或使用 nameof()运算符!
  4. 您可以选择使用 DefaultSettingValue 属性设置装饰属性的默认值。
  5. 以下是设置类的示例:

    namespace Test
    {
        public class Settings : ObservableSettings
        {
            private static Settings settings = new Settings();
            public static Settings Default
            {
                get { return settings; }
            }
    
            public Settings()
                : base(ApplicationData.Current.LocalSettings)
            {
            }
    
            [DefaultSettingValue(Value = 115200)]
            public int Bauds
            {
                get { return Get<int>(); }
                set { Set(value); }
            }
    
            [DefaultSettingValue(Value = "Jose")]
            public string Name
            {
                get { return Get<string>(); }
                set { Set(value); }
            }
    
        }
    }
    

    以及如何在app.xaml中添加实例:

    <Application
        x:Class="Test.App"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:local="using:Test"
        RequestedTheme="Light">
        <Application.Resources>
            <local:Settings x:Key="settings"/>
        </Application.Resources>
    </Application>
    

    以MVVM方式访问和修改值:

    <Page
        x:Class="Test.MainPage"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:local="using:Test"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        mc:Ignorable="d"
        DataContext="{StaticResource settings}">
    
        <StackPanel Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">
            <TextBlock Text="Bauds"/>
            <TextBox Text="{Binding Default.Bauds, Mode=TwoWay}"/>
            <TextBlock Text="Name"/>
            <TextBox Text="{Binding Default.Name, Mode=TwoWay}"/>
        </StackPanel>
    </Page>
    

    所有内容都将正确存储在您的设置存储库中。

    您可以执行 DefaultSettingValue ObservableSettings

    using System.Collections.Generic;
    using System.Linq;
    using System.Runtime.CompilerServices;
    using System.Reflection;
    using System.ComponentModel;
    using Windows.Storage;
    
    
    [AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
    public sealed class DefaultSettingValueAttribute : Attribute
    {
        public DefaultSettingValueAttribute()
        {
        }
    
        public DefaultSettingValueAttribute(object value)
        {
            Value = value;
        }
    
        public object Value { get; set; }
    }
    
    public class ObservableSettings : INotifyPropertyChanged
    {
        private readonly ApplicationDataContainer settings;
    
        public ObservableSettings(ApplicationDataContainer settings)
        {
            this.settings = settings;
        }
    
        public event PropertyChangedEventHandler PropertyChanged;
    
        protected bool Set<T>(T value, [CallerMemberName] string propertyName = null)
        {
            if (settings.Values.ContainsKey(propertyName))
            {
                var currentValue = (T)settings.Values[propertyName];
                if (EqualityComparer<T>.Default.Equals(currentValue, value))
                    return false;
            }
    
            settings.Values[propertyName] = value;
            PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
            return true;
        }
    
        protected T Get<T>([CallerMemberName] string propertyName = null)
        {
            if (settings.Values.ContainsKey(propertyName))
                return (T)settings.Values[propertyName];
    
            var attributes = GetType().GetTypeInfo().GetDeclaredProperty(propertyName).CustomAttributes.Where(ca => ca.AttributeType == typeof(DefaultSettingValueAttribute)).ToList();
            if (attributes.Count == 1)
                return (T)attributes[0].NamedArguments[0].TypedValue.Value;
    
            return default(T);
        }
    

    您可以从我在GitHub中创建的存储库下载带有功能示例的解决方案。