自定义配置、ConfigurationElements 和 ConfigurationProperties

Question

过去三天我一直在网上搜寻，但找不到任何有关此问题的参考资料。 我创建了一个与我的 app.config 一起使用的自定义配置类。 一切正常。 当不需要（配置元素的）配置属性并且未在 app.config 中定义时，就会出现问题。 似乎为配置属性返回了默认值。 有谁知道如何确定 app.config 中是否未定义该属性？ （我一直在尝试发布我的 app.config，但不知道该怎么做......有人知道怎么做吗？）

//Main
namespace TestStub
{
    class Program
    {
        static void Main(string[] args)
        {
            CustomSettingsHandler config = (CustomSettingsHandler)ConfigurationManager.GetSection("CustomSettingsManager");
            Console.WriteLine("Setting1 {0}", config.Setting1.CustomSettingItem);
            Console.WriteLine("Setting2 {0}", config.Setting2.CustomSettingItem);
        }
    }
}

//Custom Configuration Class
namespace CustomConfiguration
{
    public class CustomSettingsHandler : ConfigurationSection
    {
        [ConfigurationProperty("setting1", IsRequired = false)]
        public CustomSettingElement Setting1 { get { return (CustomSettingElement)this["setting1"]; } }

        [ConfigurationProperty("setting2", IsRequired = false)]
        public CustomSettingElement Setting2 { get { return (CustomSettingElement)this["setting2"]; } }
    }

    public class CustomSettingElement : ConfigurationElement
    {
        [ConfigurationProperty("customsettingitem", IsRequired = false)]
        public int CustomSettingItem { get { return (int)this["customsettingitem"]; } }
    }
}

Answer 1

我发现最好的方法是重写 ConfigurationSection.PostDeserialize() 并检查从 ConfigurationElement 派生的每个节成员的 IsPresent 属性。

public class CustomSettingsHandler : ConfigurationSection
{
    // ...

    protected override void PostDeserialize()
    {
        foreach (ConfigurationProperty property in Properties)
        {
            var configElement = this[property] as ConfigurationElement;

            if (configElement != null 
                && !configElement.ElementInformation.IsPresent)
            {
                this[property] = null;
            }
        }

        base.PostDeserialize();
    }
}

之后，每个尚未从配置文件中读取的 ConfigurationElement 都将为 null。

Answer 2

我能立即想到的两件事是使用 DefaultValue，如下所示：

    [ConfigurationProperty("customsettingitem", DefaultValue = -1)]
    public int CustomSettingItem { get { return (int)this["customsettingitem"]; } }

假设有一些值无效。 在本例中，CustomSettingItem == -1 表示未设置，而 >= 0 是在 config.xml 中设置的值。 当然，假设 -1 首先不是有效输入。

第二个想法是使用可空 int 来代替：

    [ConfigurationProperty("customsettingitem", IsRequired = false)]
    public int? CustomSettingItem { get { return (int?)this["customsettingitem"]; } }

现在如果配置中没有设置任何内容，则它应该默认为 null 而不是 0。

Answer 3

请尝试以下操作：

configElement.ElementInformation.Properties[propName].ValueOrigin = 
        PropertyValueOrigin.SetHere

ValueOrigin 属性告诉您该值来自哪里。

Answer 4

到目前为止，如果配置文件中未定义属性，我还无法将其告知为空。 看起来，微软以无限的智慧决定，当您键入 null 时，您真正指的是 String.Empty 或 new ConfigurationElement() 。

我目前解决这个问题的方法是这样的：

    bool _hasProp = true;
    protected override object OnRequiredPropertyNotFound(string name)
    {
        if (name == "prop")
        {
            _hasProp = false;
            return null; // note that this will still not make prop null
        }
        return base.OnRequiredPropertyNotFound(name);
    }

    [ConfigurationProperty("prop", IsRequired = true)]
    public string Prop
    {
        get { return _hasProp ? (string) this["prop"] : null; }
    }

这是一种黑客行为，会错误地根据需要标记属性。 如果您使用工具来编辑配置文件，则不会这样。

Answer 5

您还可以使用以下命令进行检查：

config.Setting1.CustomSettingItem.ElementInformation.IsPresent 

如果在您的配置文件中找不到它，它会给您错误。