web-dev-qa-db-ja.com

ConfigurationElementCollectionにカスタム属性を設定する方法

次のように構成する

<MyCollection default="one">
  <entry name="one" ... other attrubutes />
  ... other entries
</MyCollection>

myCollectionを実装するとき、「デフォルト」属性に対して何をすべきですか？

c#.net-4.0configuration-files
26
jojo

次の.configファイルがあるとします。

<configuration>
    <configSections>
        <section name="mySection" type="ConsoleApplication1.MySection, ConsoleApplication1" /> // update type  & Assembly names accordingly
    </configSections>

    <mySection>
        <MyCollection default="one">
            <entry name="one" />
            <entry name="two" />
        </MyCollection>
    </mySection>
</configuration>

次に、このコードで：

public class MySection : ConfigurationSection
{
    [ConfigurationProperty("MyCollection", Options = ConfigurationPropertyOptions.IsRequired)]
    public MyCollection MyCollection
    {
        get
        {
            return (MyCollection)this["MyCollection"];
        }
    }
}

[ConfigurationCollection(typeof(EntryElement), AddItemName = "entry", CollectionType = ConfigurationElementCollectionType.BasicMap)]
public class MyCollection : ConfigurationElementCollection
{
    protected override ConfigurationElement CreateNewElement()
    {
        return new EntryElement();
    }

    protected override object GetElementKey(ConfigurationElement element)
    {
        if (element == null)
            throw new ArgumentNullException("element");

        return ((EntryElement)element).Name;
    }

    [ConfigurationProperty("default", IsRequired = false)]
    public string Default
    {
        get
        {
            return (string)base["default"];
        }
    }
}

public class EntryElement : ConfigurationElement
{
    [ConfigurationProperty("name", IsRequired = true, IsKey = true)]
    public string Name
    {
        get
        {
            return (string)base["name"];
        }
    }
}

次のように、 'default'属性を使用して構成を読み取ることができます。

    MySection section = (MySection)ConfigurationManager.GetSection("mySection");
    Console.WriteLine(section.MyCollection.Default);

これは「1」を出力します

55
Simon Mourier

ConfigurationElementCollectionにデフォルト値を含めることが可能かどうかはわかりません。 （デフォルト値のプロパティはありません）。

これは自分で実装する必要があると思います。以下の例を見てください。

public class Repository : ConfigurationElement
{
    [ConfigurationProperty("key", IsRequired = true)]
    public string Key
    {
        get { return (string)this["key"]; }
    }

    [ConfigurationProperty("value", IsRequired = true)]
    public string Value
    {
        get { return (string)this["value"]; }
    }
}

public class RepositoryCollection : ConfigurationElementCollection
{
    protected override ConfigurationElement CreateNewElement()
    {
        return new Repository();
    }

    protected override object GetElementKey(ConfigurationElement element)
    {
        return (element as Repository).Key;
    }

    public Repository this[int index]
    {
        get { return base.BaseGet(index) as Repository; }
    }

    public new Repository this[string key]
    {
        get { return base.BaseGet(key) as Repository; }
    }

}

public class MyConfig : ConfigurationSection
{
    [ConfigurationProperty("currentRepository", IsRequired = true)]
    private string InternalCurrentRepository
    {
        get { return (string)this["currentRepository"]; }
    }

    [ConfigurationProperty("repositories", IsRequired = true)]
    private RepositoryCollection InternalRepositories
    {
        get { return this["repositories"] as RepositoryCollection; }
    }
}

XML設定は次のとおりです。

  <myConfig currentRepository="SQL2008">
    <repositories>
      <add key="SQL2008" value="abc"/>
      <add key="Oracle" value="xyz"/>
    </repositories>
  </myConfig>

そして、あなたのコードで、あなたは以下を使ってデフォルトアイテムにアクセスします：

MyConfig conf = (MyConfig)ConfigurationManager.GetSection("myConfig");
string myValue = conf.Repositories[conf.CurrentRepository].Value;

もちろん、MyConfigクラスは、RepositoriesプロパティとCurrentRepositoryプロパティへのアクセスの詳細を非表示にすることができます。これを返すには、MyConfigクラスに（Repositoryタイプの）DefaultRepositoryというプロパティを設定できます。

5
Fabio

これは少し遅いかもしれませんが、他の人に役立つかもしれません。

可能ですが、多少の変更が必要です。

  • ConfigurationElementCollectionはConfigurationElementを継承するため、 "this [string]"はConfigurationElementで使用できます。

  • 通常、ConfigurationElementCollectionが継承されて別のクラスに実装されると、「this [string]」は「new this [string]」で非表示になります。

  • これを回避する1つの方法は、「this [string、string]」など、this []の別の実装を作成することです。

以下の例を参照してください。

public class CustomCollection : ConfigurationElementCollection
{
    protected override ConfigurationElement CreateNewElement()
    {
        return new CustomElement();
    }

    protected override object GetElementKey(ConfigurationElement element)
    {
        return ((CustomElement)element).Name;
    }

    public CustomElement this[int index]
    {
        get { return (CustomElement)base.BaseGet(index); }
        set
        {
            if (BaseGet(index) != null)
                BaseRemoveAt(index);

            BaseAdd(index, value);
        }
    }

    // ConfigurationElement this[string] now becomes hidden in child class
    public new CustomElement this[string name]
    {
        get { return (CustomElement)BaseGet(name); }
    }

    // ConfigurationElement this[string] is now exposed
    // however, a value must be entered in second argument for property to be access
    // otherwise "this[string]" will be called and a CustomElement returned instead
    public object this[string name, string str = null]
    {
        get { return base[name]; }
        set { base[name] = value; }
    }
}
1
clattaclism

それを一般化したい場合は、これが役立ちます：

using System.Configuration;

namespace Abcd
{
  // Generic implementation of ConfigurationElementCollection.
  [ConfigurationCollection(typeof(ConfigurationElement))]
  public class ConfigurationElementCollection<T> : ConfigurationElementCollection
                                         where T : ConfigurationElement, IConfigurationElement, new()
  {
    protected override ConfigurationElement CreateNewElement()
    {
      return new T();
    }

    protected override object GetElementKey(ConfigurationElement element)
    {
      return ((IConfigurationElement)element).GetElementKey();
    }

    public T this[int index]
    {
      get { return (T)BaseGet(index); }
    }

    public T GetElement(object key)
    {
      return (T)BaseGet(key);
    }
  }
}

上記のインターフェースは次のとおりです。

namespace Abcd
{
  public interface IConfigurationElement
  {
    object GetElementKey();
  }
}
0
GaTechThomas