.net自定义配置节元素必须具有键吗

本文关键字：自定义 配置 元素 net | 更新日期: 2023-09-27 18:20:00

整理以下配置部分：

<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也是可选的。我可以使用推荐的类来解析一个看起来像这样的配置部分吗？或者我必须通过添加"dummy"键来更改我的配置以适应ConfigurationClasses的制度吗？

.net自定义配置节元素必须具有键吗

否。

但为了避免钥匙，你需要做更多的工作。

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

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

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

因此，基于Richard的出色回答，我决定重写我的配置解析。结果如下：

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; }
        }
    }
}
相关文章：