ConfigurationElementCollectionを使用してConfigurationSectionを実装する方法

Question

プロジェクトにカスタム構成セクションを実装しようとしていますが、理解できない例外に直面し続けています。私は誰かがここに空白を埋めることができることを望んでいます。

次のようなApp.configがあります。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <configSections>
        <section name="ServicesSection" type="RT.Core.Config.ServicesConfigurationSectionHandler, RT.Core"/>
    </configSections>
    <ServicesSection type="RT.Core.Config.ServicesSection, RT.Core">
            <Services>
                <AddService Port="6996" ReportType="File" />
                <AddService Port="7001" ReportType="Other" />
            </Services>
        </ServicesSection>
</configuration>

私はそのように定義されたServiceConfig要素を持っています：

public class ServiceConfig : ConfigurationElement
  {
    public ServiceConfig() {}

    public ServiceConfig(int port, string reportType)
    {
      Port = port;
      ReportType = reportType;
    }

    [ConfigurationProperty("Port", DefaultValue = 0, IsRequired = true, IsKey = true)]
    public int Port 
    {
      get { return (int) this["Port"]; }
      set { this["Port"] = value; }
    }

    [ConfigurationProperty("ReportType", DefaultValue = "File", IsRequired = true, IsKey = false)]
    public string ReportType
    {
      get { return (string) this["ReportType"]; }
      set { this["ReportType"] = value; }
    }
  }

そして、次のように定義されたServiceCollectionがあります：

public class ServiceCollection : ConfigurationElementCollection
  {
    public ServiceCollection()
    {
      Console.WriteLine("ServiceCollection Constructor");
    }

    public ServiceConfig this[int index]
    {
      get { return (ServiceConfig)BaseGet(index); }
      set
      {
        if (BaseGet(index) != null)
        {
          BaseRemoveAt(index);
        }
        BaseAdd(index, value);
      }
    }

    public void Add(ServiceConfig serviceConfig)
    {
      BaseAdd(serviceConfig);
    }

    public void Clear()
    {
      BaseClear();
    }

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

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

    public void Remove(ServiceConfig serviceConfig)
    {
      BaseRemove(serviceConfig.Port);
    }

    public void RemoveAt(int index)
    {
      BaseRemoveAt(index);
    }

    public void Remove(string name)
    {
      BaseRemove(name);
    }
  }

私が欠けている部分は、ハンドラのために何をすべきかです。元々、IConfigurationSectionHandlerを実装しようとしましたが、次の2つが見つかりました。

1. うまくいかなかった
2. 非推奨です。

Configからデータを読み取ることができるように、何をすべきか完全に失われました。助けてください！

Answer 1

前の答えは正しいですが、すべてのコードも提供します。

App.configは次のようになります。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
   <configSections>
      <section name="ServicesSection" type="RT.Core.Config.ServiceConfigurationSection, RT.Core"/>
   </configSections>
   <ServicesSection>
      <Services>
         <add Port="6996" ReportType="File" />
         <add Port="7001" ReportType="Other" />
      </Services>
   </ServicesSection>
</configuration>

ServiceConfigおよびServiceCollectionクラスは変更されません。

新しいクラスが必要です：

public class ServiceConfigurationSection : ConfigurationSection
{
   [ConfigurationProperty("Services", IsDefaultCollection = false)]
   [ConfigurationCollection(typeof(ServiceCollection),
       AddItemName = "add",
       ClearItemsName = "clear",
       RemoveItemName = "remove")]
   public ServiceCollection Services
   {
      get
      {
         return (ServiceCollection)base["Services"];
      }
   }
}

そして、これでうまくいくはずです。使用するには、次を使用できます。

ServiceConfigurationSection serviceConfigSection =
   ConfigurationManager.GetSection("ServicesSection") as ServiceConfigurationSection;

ServiceConfig serviceConfig = serviceConfigSection.Services[0];

Answer 2

次のようなカスタム構成セクションを探している場合

<CustomApplicationConfig>
        <Credentials Username="itsme" Password="mypassword"/>
        <PrimaryAgent Address="10.5.64.26" Port="3560"/>
        <SecondaryAgent Address="10.5.64.7" Port="3570"/>
        <Site Id="123" />
        <Lanes>
          <Lane Id="1" PointId="north" Direction="Entry"/>
          <Lane Id="2" PointId="south" Direction="Exit"/>
        </Lanes> 
</CustomApplicationConfig>

次に、構成セクションの実装を使用して、プロジェクトにSystem.Configurationアセンブリ参照を追加します

使用したネストされた各要素を見てください。最初の要素は2つの属性を持つ資格情報なので、最初に追加しましょう

Credentials要素

public class CredentialsConfigElement : System.Configuration.ConfigurationElement
    {
        [ConfigurationProperty("Username")]
        public string Username
        {
            get 
            {
                return base["Username"] as string;
            }
        }

        [ConfigurationProperty("Password")]
        public string Password
        {
            get
            {
                return base["Password"] as string;
            }
        }
    }

PrimaryAgentおよびSecondaryAgent

どちらも同じ属性を持ち、プライマリおよびフェイルオーバー用のサーバーのセットへのアドレスのように見えるため、次のような両方に対して1つの要素クラスを作成するだけです。

public class ServerInfoConfigElement : ConfigurationElement
    {
        [ConfigurationProperty("Address")]
        public string Address
        {
            get
            {
                return base["Address"] as string;
            }
        }

        [ConfigurationProperty("Port")]
        public int? Port
        {
            get
            {
                return base["Port"] as int?;
            }
        }
    }

この投稿の後半で、1つのクラスで2つの異なる要素を使用する方法を説明します。SiteIdには違いがないため、スキップします。 1つのプロパティのみで上記と同じ1つのクラスを作成する必要があります。 Lanesコレクションの実装方法を見てみましょう

最初に要素実装クラスを作成する必要があり、次にコレクション要素クラスを作成する必要があります

LaneConfigElement

public class LaneConfigElement : ConfigurationElement
    {
        [ConfigurationProperty("Id")]
        public string Id
        {
            get
            {
                return base["Id"] as string;
            }
        }

        [ConfigurationProperty("PointId")]
        public string PointId
        {
            get
            {
                return base["PointId"] as string;
            }
        }

        [ConfigurationProperty("Direction")]
        public Direction? Direction
        {
            get
            {
                return base["Direction"] as Direction?;
            }
        }
    }

    public enum Direction
    { 
        Entry,
        Exit
    }

LanElementの1つの属性が列挙型であり、列挙型アプリケーションで定義されていない構成で他の値を使用しようとすると、起動時にSystem.Configuration.ConfigurationErrorsExceptionがスローされます。 Okは、コレクション定義に進みます

[ConfigurationCollection(typeof(LaneConfigElement), AddItemName = "Lane", CollectionType = ConfigurationElementCollectionType.BasicMap)]
    public class LaneConfigCollection : ConfigurationElementCollection
    {
        public LaneConfigElement this[int index]
        {
            get { return (LaneConfigElement)BaseGet(index); }
            set
            {
                if (BaseGet(index) != null)
                {
                    BaseRemoveAt(index);
                }
                BaseAdd(index, value);
            }
        }

        public void Add(LaneConfigElement serviceConfig)
        {
            BaseAdd(serviceConfig);
        }

        public void Clear()
        {
            BaseClear();
        }

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

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

        public void Remove(LaneConfigElement serviceConfig)
        {
            BaseRemove(serviceConfig.Id);
        }

        public void RemoveAt(int index)
        {
            BaseRemoveAt(index);
        }

        public void Remove(String name)
        {
            BaseRemove(name);
        }

    }

AddItemName = "Lane"を設定していることに気づくでしょう。コレクションエントリアイテムに好きなものを選択できます。デフォルトの「追加」を使用したいのですが、この投稿のために変更しました。

ネストされたすべての要素が実装されたので、System.Configuration.ConfigurationSectionを実装する必要があるクラス内のすべての要素を集約する必要があります。

CustomApplicationConfigSection

public class CustomApplicationConfigSection : System.Configuration.ConfigurationSection
    {
        private static readonly ILog log = LogManager.GetLogger(typeof(CustomApplicationConfigSection));
        public const string SECTION_NAME = "CustomApplicationConfig";

        [ConfigurationProperty("Credentials")]
        public CredentialsConfigElement Credentials
        {
            get
            {
                return base["Credentials"] as CredentialsConfigElement;
            }
        }

        [ConfigurationProperty("PrimaryAgent")]
        public ServerInfoConfigElement PrimaryAgent
        {
            get
            {
                return base["PrimaryAgent"] as ServerInfoConfigElement;
            }
        }

        [ConfigurationProperty("SecondaryAgent")]
        public ServerInfoConfigElement SecondaryAgent
        {
            get
            {
                return base["SecondaryAgent"] as ServerInfoConfigElement;
            }
        }

        [ConfigurationProperty("Site")]
        public SiteConfigElement Site
        {
            get
            {
                return base["Site"] as SiteConfigElement;
            }
        }

        [ConfigurationProperty("Lanes")]
        public LaneConfigCollection Lanes
        {
            get { return base["Lanes"] as LaneConfigCollection; }
        }
    }

PrimaryAgentおよびSecondaryAgentという名前の2つのプロパティが両方とも同じ型であることがわかり、これら2つの要素に対して実装クラスが1つしかない理由を簡単に理解できます。

App.config（またはweb.config）でこの新しく発明された構成セクションを使用する前に、アプリケーションに独自の構成セクションを発明したことを伝え、それに敬意を払うだけで、次の行を追加する必要がありますapp.config内（ルートタグの開始直後かもしれません）。

<configSections>
    <section name="CustomApplicationConfig" type="MyNameSpace.CustomApplicationConfigSection, MyAssemblyName" />
  </configSections>

注：MyAssemblyNameは.dllなしである必要があります。アセンブリファイル名がmyDll.dllの場合、myDll.dllではなくmyDllを使用します。

この構成を取得するには、次のコード行をアプリケーションの任意の場所で使用します

CustomApplicationConfigSection config = System.Configuration.ConfigurationManager.GetSection(CustomApplicationConfigSection.SECTION_NAME) as CustomApplicationConfigSection;

上記の投稿が、少し複雑な種類のカスタム構成セクションの開始に役立つことを願っています。

ハッピーコーディング:)

****編集**** LaneConfigCollectionでLINQを有効にするには、IEnumerable<LaneConfigElement>を実装する必要があります

そして、次のGetEnumeratorの実装を追加します

public new IEnumerator<LaneConfigElement> GetEnumerator()
        {
            int count = base.Count;
            for (int i = 0; i < count; i++)
            {
                yield return base.BaseGet(i) as LaneConfigElement;
            }
        }

yieldが実際にどのように機能するかについてまだ混乱している人々のために このニースの記事

上記の記事から取られた2つのキーポイントは

メソッドの実行が実際に終了するわけではありません。 yield returnはメソッドの実行を一時停止し、次回呼び出したとき（次の列挙値の場合）、メソッドは最後のyield return呼び出しから実行を継続します。ちょっとわかりにくいかもしれませんが… （Shay Friedman）

収量は.Netランタイムの機能ではありません。これは、C＃コンパイラによって単純なILコードにコンパイルされる単なるC＃言語機能です。 （ラース・コーネリウスセン）

Answer 3

これは、構成収集の一般的なコードです。

public class GenericConfigurationElementCollection<T> :   ConfigurationElementCollection, IEnumerable<T> where T : ConfigurationElement, new()
{
    List<T> _elements = new List<T>();

    protected override ConfigurationElement CreateNewElement()
    {
        T newElement = new T();
        _elements.Add(newElement);
        return newElement;
    }

    protected override object GetElementKey(ConfigurationElement element)
    {
        return _elements.Find(e => e.Equals(element));
    }

    public new IEnumerator<T> GetEnumerator()
    {
        return _elements.GetEnumerator();
    }
}

GenericConfigurationElementCollectionを取得したら、configセクションで簡単に使用できます（これはDispatcherの例です）。

public class  DispatcherConfigurationSection: ConfigurationSection
{
    [ConfigurationProperty("maxRetry", IsRequired = false, DefaultValue = 5)]
    public int MaxRetry
    {
        get
        {
            return (int)this["maxRetry"];
        }
        set
        {
            this["maxRetry"] = value;
        }
    }

    [ConfigurationProperty("eventsDispatches", IsRequired = true)]
    [ConfigurationCollection(typeof(EventsDispatchConfigurationElement), AddItemName = "add", ClearItemsName = "clear", RemoveItemName = "remove")]
    public GenericConfigurationElementCollection<EventsDispatchConfigurationElement> EventsDispatches
    {
        get { return (GenericConfigurationElementCollection<EventsDispatchConfigurationElement>)this["eventsDispatches"]; }
    }
}

構成要素はここで構成されます：

public class EventsDispatchConfigurationElement : ConfigurationElement
{
    [ConfigurationProperty("name", IsRequired = true)]
    public string Name
    {
        get
        {
            return (string) this["name"];
        }
        set
        {
            this["name"] = value;
        }
    }
}

構成ファイルは次のようになります。

<?xml version="1.0" encoding="utf-8" ?>
  <dispatcherConfigurationSection>
    <eventsDispatches>
      <add name="Log" ></add>
      <add name="Notification" ></add>
      <add name="tester" ></add>
    </eventsDispatches>
  </dispatcherConfigurationSection>

助けてください！

Answer 4

すべての構成ボイラープレートを手動で記述したくない人のための簡単な代替...

1）インストール Nerdle.AutoConfig NuGetから

2）ServiceConfigタイプを定義します（具象クラスまたはインターフェースのいずれか、いずれかで行います）

public interface IServiceConfiguration
{
    int Port { get; }
    ReportType ReportType { get; }
}

3）コレクションを保持するタイプが必要です。

public interface IServiceCollectionConfiguration
{
    IEnumerable<IServiceConfiguration> Services { get; } 
}

4）そのように設定セクションを追加します（キャメルケースの命名に注意してください）

<configSections>
  <section name="serviceCollection" type="Nerdle.AutoConfig.Section, Nerdle.AutoConfig"/>
</configSections>

<serviceCollection>
  <services>
    <service port="6996" reportType="File" />
    <service port="7001" reportType="Other" />
  </services>
</serviceCollection>

5）AutoConfigを使用したマップ

var services = AutoConfig.Map<IServiceCollectionConfiguration>();

Answer 5

ConfigurationSection から継承してみてください。この ブログ投稿 Phil Haackによる例があります。

IConfigurationSectionHandler のドキュメントごとに確認済み：

.NET Frameworkバージョン2.0以降では、代わりにConfigurationSectionクラスから派生して、関連する構成セクションハンドラーを実装する必要があります。