.net自定义配置部分元素是否必须有密钥?

时间:2013-06-26 06:44:31

标签: c# nested configurationsection

Concider以下配置部分:

<PluginSection>
    <Plugins>
       <Plugin name="Plug1">
          <add MessageType="1" MessageSubType="1" Ringtone="chime.wav" Vibrate="1000:0:1"/>
          <add MessageType="1" MessageSubType="2" Ringtone="chime2.wav" Vibrate="1000:0:1"/>
       </Plugin>
       <Plugin name="Plug2">
          <add MessageType="1" MessageSubType="1" Ringtone="chime.wav"/>
          <add MessageType="1" MessageSubType="2" Ringtone="chime2.wav"/>
          <add MessageType="2" Ringtone="chime3.wav"/>
       </Plugin>
    </Plugins>
 </PluginSection>

我已经将其解析为c#IConfigSectionHandler。现在我明白这个方法已被弃用,我应该使用ConfigurationSection,ConfigurationElements和ConfigurationElementCollections。我在网上(msdn和SO)理解这个例子没有问题。但到目前为止我见过的所有例子都使用了其中一个属性作为关键。我的元素作为插件名称,MessageType和MessageSubType的组合是唯一的。 MessageSubType也是可选的。我可以使用推荐的类解析看起来像这样的配置部分,或者我是否必须改变我的配置以适应ConfigurationClasses的制度。添加“虚拟”键?

2 个答案:

答案 0 :(得分:5)

没有

但要避免按键,你需要做更多工作。

具体类型KeyValueConfigurationCollection允许通过设置一些属性来轻松创建配置集合。

要创建更加自定义的集合,需要扩展抽象ConfigurationElementCollection(但这仍将基于<appSettings>使用的添加/删除/清除模型。但允许元素名称为配置但是这仍然基于对集合中每个成员的密钥值(这由覆盖GetElementKey确定,因此不需要直接包含在XML中)。

或者,您可以通过扩展ConfigurationElement来创建自己的完全自定义配置集合,但是您需要自己完成解析子元素的所有工作(请记住ConfigurationElementCollection本身就是子类ConfigurationElement)。

答案 1 :(得分:0)

基于理查德的优秀答案,我决定重写我的配置解析。结果如下:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Configuration;

namespace PluginConfiguration
{
    public class PluginConfigSection : ConfigurationSection
    {
        [ConfigurationProperty("Plugins", IsDefaultCollection = true)]
        [ConfigurationCollection(typeof(PluginCollection), AddItemName = "Plugin")]
        public PluginCollection Plugins
        {
            get
            {
                PluginCollection coll = (PluginCollection)base["Plugins"];
                return coll;
            }
        }
    }

    public class PluginCollection : ConfigurationElementCollection
    {

        protected override ConfigurationElement CreateNewElement()
        {
            return new MessageMappingElementCollection();
        }

        protected override object GetElementKey(ConfigurationElement element)
        {
            MessageMappingElementCollection coll = element as MessageMappingElementCollection;
            return coll.Name;
        }
    }

    public class MessageMappingElementCollection : ConfigurationElementCollection
    {
        [ConfigurationProperty("name", IsRequired = true, IsKey = true)]
        public string Name
        {
            get { return this["name"].ToString(); }
            set { this["name"] = value; }
        }

        protected override ConfigurationElement CreateNewElement()
        {
            return new MessageMappingElement();
        }

        protected override object GetElementKey(ConfigurationElement element)
        {
            MessageMappingElement msgElement = element as MessageMappingElement;

            string ret = String.Format("{0}|{1}", msgElement.MessageType, msgElement.MessageSubType);
            return ret;
        }
    }

    public sealed class MessageMappingElement : ConfigurationElement
    {
        public MessageMappingElement()
        {
            MessageType = 0;
            MessageSubType = 0;
            RingTone = "";
            Description = "";
            Vibrate = "";
        }

        [ConfigurationProperty("MessageType", IsRequired = true)]
        public int MessageType
        {
            get { return int.Parse(this["MessageType"].ToString()); }
            set { this["MessageType"] = value; }
        }

        [ConfigurationProperty("MessageSubType", IsRequired = false)]
        public int MessageSubType
        {
            get { return int.Parse(this["MessageSubType"].ToString()); }
            set { this["MessageSubType"] = value; }
        }

        [ConfigurationProperty("RingTone", IsRequired = false)]
        public string RingTone
        {
            get { return this["RingTone"].ToString(); }
            set { this["RingTone"] = value; }
        }

        [ConfigurationProperty("Description", IsRequired = false)]
        public string Description
        {
            get { return this["Description"].ToString(); }
            set { this["Description"] = value; }
        }

        [ConfigurationProperty("Vibrate", IsRequired = false)]
        public string Vibrate
        {
            get { return this["Vibrate"].ToString(); }
            set { this["Vibrate"] = value; }
        }
    }
}