c# - 实现通用设置类的最佳方法 - 反映获取/设置属性？

Question

我不知道如何制作通用设置类，希望您能帮助我。
首先，我想要一个单一的设置文件解决方案。为此，我创建了一个像这样的单例：

public sealed class Settings
{
  private static readonly Lazy<Settings> _instance = new Lazy<Settings>(() => new Settings());
  private Dictionary<string, object> m_lProperties = new Dictionary<string, object>();

  public void Load(string fileName)
  {
    throw new NotImplementedException();  
  }

  public void Save(string fileName)
  {
    throw new NotImplementedException();
  }

  public void Update()
  {
    throw new NotImplementedException();
  }

  /// <summary>
  /// Gets the propery.
  /// </summary>
  /// <param name="propertyName">Name of the property.</param>
  /// <returns></returns>
  public string GetPropery(string propertyName)
  {
    return m_lProperties[propertyName].ToString() ?? String.Empty;
  }

  /// <summary>
  /// Gets the propery.
  /// </summary>
  /// <param name="propertyName">Name of the property.</param>
  /// <param name="defaultValue">The default value.</param>
  /// <returns></returns>
  public string GetPropery(string propertyName, string defaultValue)
  {
    if (m_lProperties.ContainsKey(propertyName))
    {
      return m_lProperties[propertyName].ToString();
    }
    else
    {
      SetProperty(propertyName, defaultValue);
      return defaultValue;
    }
  }

  /// <summary>
  /// Sets the property.
  /// </summary>
  /// <param name="propertyName">Name of the property.</param>
  /// <param name="value">The value.</param>
  public void SetProperty(string propertyName, string value)
  {
    if (m_lProperties.ContainsKey(propertyName))
      m_lProperties[propertyName] = value;
    else
      m_lProperties.Add(propertyName, value);
  }
}

但我认为更好的方法是属性在类中，我可以通过反射获取属性。
- 你能帮我实现这样的事情吗？
- 是否可以提供诸如“encrypted = true”之类的属性属性？- 在 xml 文件中保存/加载设置的最佳方式是什么？

更新
这里是一个如何使用实际设置的示例：

class Test()
{
  private string applicationPath;
  private string configurationPath;
  private string configurationFile;

  public Test()
  {
    applicationPath = Settings.Instance.GetPropery("ApplicationPath", AppDomain.CurrentDomain.BaseDirectory);
    configurationPath = Settings.Instance.GetPropery("ConfigurationPath", "configurations");  
    configurationFile = Settings.Instance.GetPropery("ConfigurationFile", "application.xml");  
    // ... Load file with all settings from all classes
  }

score 2 · Accepted Answer

这是我自己的代码中相当相关的一点。

public class MyObject
{
    public string StringProperty {get; set;}

    public int IntProperty {get; set;}

    public object this[string PropertyName]
        {
            get
            {
                return GetType().GetProperty(PropertyName).GetGetMethod().Invoke(this, null);
            }
            set
            {
                GetType().GetProperty(PropertyName).GetSetMethod().Invoke(this, new object[] {value});
            }
        }
}

它允许的是：

MyObject X = new MyObject();
//Set
X["StringProperty"] = "The Answer Is: ";
X["IntProperty"] = 42;
//Get - Please note that object is the return type, so casting is required
int thingy1 = Convert.ToInt32(X["IntProperty"]);
string thingy2 = X["StringProperty"].ToString();

更新：更多解释 这种工作方式是反射访问属性，属性与字段不同，因为它们使用 getter 和 setter，而不是直接声明和访问。您可以使用相同的方法来获取字段，或者也可以获取字段，如果您对 GetProperty 的返回值进行空检查，而不是简单地假设它有效。此外，正如另一条评论中所指出的，如果您使用不存在的属性按原样调用它，这将中断，因为它缺少任何形式的错误捕获。我以最简单的形式展示了代码，而不是最健壮的形式。

至于属性属性....该索引器需要在您想要使用它的类（或父类，我有它BaseObject）中创建，因此在内部您可以在给定属性上实现属性，然后应用开关或在访问属性时对其进行检查。也许将所有属性设置为您实现的其他自定义类，Object Value; Bool Encrypted;然后根据需要从那里对其进行处理，这实际上仅取决于您想要获得多少花哨以及想要编写多少代码。

score 1 · Accepted Answer

我不建议在可能没有反射的地方使用反射，因为它非常慢。

我没有反射和加密原型的例子：

public sealed class Settings
{
    private static readonly HashSet<string> _propertiesForEncrypt = new HashSet<string>(new string[] { "StringProperty", "Password" });
    private static readonly Lazy<Settings> _instance = new Lazy<Settings>(() => new Settings());
    private Dictionary<string, object> m_lProperties = new Dictionary<string, object>();

    public void Load(string fileName)
    {
        // TODO: When you deserialize property which contains into "_propertiesForEncrypt" than Decrypt this property.
        throw new NotImplementedException();
    }

    public void Save(string fileName)
    {
        // TODO: When you serialize property which contains into "_propertiesForEncrypt" than Encrypt this property.
        throw new NotImplementedException();
    }

    public void Update()
    {
        throw new NotImplementedException();
    }

    /// <summary>
    /// Gets the propery.
    /// </summary>
    /// <param name="propertyName">Name of the property.</param>
    /// <returns></returns>
    public object GetPropery(string propertyName)
    {
        if (m_lProperties.ContainsKey(propertyName))
            return m_lProperties[propertyName];

        return null;
    }

    /// <summary>
    /// Gets the propery.
    /// </summary>
    /// <param name="propertyName">Name of the property.</param>
    /// <param name="defaultValue">The default value.</param>
    /// <returns></returns>
    public object GetPropery(string propertyName, object defaultValue)
    {
        if (m_lProperties.ContainsKey(propertyName))
        {
            return m_lProperties[propertyName].ToString();
        }
        else
        {
            SetProperty(propertyName, defaultValue);
            return defaultValue;
        }
    }

    /// <summary>
    /// Sets the property.
    /// </summary>
    /// <param name="propertyName">Name of the property.</param>
    /// <param name="value">The value.</param>
    public void SetProperty(string propertyName, object value)
    {
        if (m_lProperties.ContainsKey(propertyName))
            m_lProperties[propertyName] = value;
        else
            m_lProperties.Add(propertyName, value);
    }


    // Sample of string property
    public string StringProperty
    {
        get
        {
            return GetPropery("StringProperty") as string;
        }
        set
        {
            SetProperty("StringProperty", value);
        }
    }

    // Sample of int property
    public int IntProperty
    {
        get
        {
            object intValue = GetPropery("IntProperty");
            if (intValue == null)
                return 0; // Default value for this property.

            return (int)intValue;
        }
        set
        {
            SetProperty("IntProperty", value);
        }
    }
}

score 0 · Accepted Answer

使用这样的动态类：https ://gist.github.com/3914644，这样您就可以访问您的属性：yourObject.stringProperty 或 yourObject.intProperty

score 0 · Accepted Answer

最大的问题之一是没有干净的方法将对象反序列化为对象。如果您不提前知道对象的类型需要是什么，那么它很难使用。所以我们有一个替代的解决方案，存储类型信息。

鉴于它没有列出，我将提供我认为的示例 XML，以及使用它的方法，以及访问属性本身的方法。您用于 Get 和 Set 属性的函数按原样运行，无需更改。

在各个类中，您需要确保该类中的相关属性在其自己的 get/set 方法中引用 Settings 类

public int? MyClassProperty
{
    get
    {
        return (int?)Settings.Instance.GetProperty("MyClassProperty");
    }
    set
    {
        Settings.Instance.SetProperty("MyClassProperty", value);
    }
}

在您的加载和保存功能中，您将需要使用序列化，特别是XmlSerializer. 为此，您需要适当地声明设置列表。为此，我实际上会使用自定义类。

更新以允许正确加载

public class AppSetting
{
    [XmlAttribute("Name")]
    public string Name { get; set; }
    [XmlAttribute("pType")]
    public string pType{ get; set; }
    [XmlIgnore()]
    public object Value{ get; set; }
    [XmlText()]
    public string AttributeValue 
    {
        get { return Value.ToString(); }
        set {
        //this is where you have to have a MESSY type switch
        switch(pType) 
        { case "System.String": Value = value; break;
          //not showing the whole thing, you get the idea
        }
    }
}

然后，您将拥有以下内容，而不仅仅是一本字典：

public sealed class Settings
{
  private static readonly Lazy<Settings> _instance = new Lazy<Settings>(() => new Settings());
  private Dictionary<string, object> m_lProperties = new Dictionary<string, object>();
  private List<AppSetting> mySettings = new List<AppSetting>();

您的加载功能将是一个简单的反序列化

public void Load(string fileName)
{//Note: the assumption is that the app settings XML will be defined BEFORE this is called, and be under the same name every time.
    XmlSerializer ser = new XmlSerializer(typeof(List<AppSetting>));
    FileStream fs = File.Open(fileName);
    StreamReader sr = new StreamReader(fs);
    mySettings = (List<AppSetting>)ser.DeSerialize(sr);
    sr.Close();
    fs.Close();

    //skipping the foreach loop that will add all the properties to the dictionary
}

保存功能基本上需要反转它。

public void Save(string fileName)
    {
        //skipping the foreach loop that re-builds the List from the Dictionary
        //Note: make sure when each AppSetting is created, you also set the pType field...use Value.GetType().ToString()

        XmlSerializer ser = new XmlSerializer(typeof(List<AppSetting>));
        FileStream fs = File.Open(fileName, FileMode.Create);
        StreamWriter sw = new StreamWriter(fs);
        //get rid of those pesky default namespaces
        XmlSerializerNamespaces ns = new XmlSerializerNamespaces();
        ns.Add("", "");
        ser.Serialize(sw, mySettings, ns);
        sw.Flush();
        sw.Close();
        fs.Close();
        mySettings = null;//no need to keep it around
    }

并且 xml 将类似于以下内容：

更新

<ArrayOfAppSetting>
    <AppSetting Name="ApplicationPath" pType="System.String">C:\Users\ME\Documents\Visual Studio 2010\Projects\WindowsFormsApplication1\WindowsFormsApplication1\bin\Debug\</AppSetting> 
    <AppSetting Name="ConfigurationPath" pType="System.String">configurations</AppSetting> 
    <AppSetting Name="ConfigurationFile" pType="System.String">application.xml</AppSetting> 
    <AppSetting Name="prop" pType="System.Int32">1</AppSetting> 
</ArrayOfAppSetting>

我使用中间体展示了这个示例，List<>因为事实证明您不能使用任何通过 XmlSerializer 实现 IDictionary 的东西。它将无法初始化，它只是不起作用。

您可以在字典旁边创建和维护列表，也可以将字典替换为列表...确保检查以验证“名称”是唯一的，或者您可以简单地忽略列表，除非在保存和加载操作（这就是我写这个例子的方式）

更新这确实只适用于原始类型（int、double、string 等），但是因为您直接存储类型，所以您可以使用任何您想要的自定义类型，因为您知道它是什么以及如何处理它, 你只需要在 AttributeValue 的 set 方法中处理

另一个更新：如果您只存储字符串，而不是所有类型的对象......它会变得非常简单。摆脱XmlIgnore valueAND pType，然后自动实现AttributeValue. 砰，完成。但是，这将限制您使用字符串和其他原语，请确保其他类中的值的 Get/Set 适当地转换它们......但它是一个更简单和更容易的实现。

c# - 实现通用设置类的最佳方法 - 反映获取/设置属性？

4 回答 4

Related

Reference