C# Programming

Web.Configにカスタムセクションを追加する           

開発環境： Visual Studio 2005

１．目次

１．目次
２．目的
３．参考書
４．作成手順
  ４．1　Web.Config
  ４．２　コンフィグレーションセクションハンドラの実装
５．利用方法

２．目的

ASP.NET 2.0で、Web.Configに独自のカスタムセクションを追加する方法について。

ASP.NET 1.0, 1.1では、IConfigurationSectionHandlerインターフェイスを使用していましたが、ASP.NET 2.0では、ConfigurationSection クラスを使用します。

３．参考書

1.  MSDN: IConfigurationSectionHandler インターフェイス
   
2. MSDN: ConfigurationSection クラス

４．作成手順

次のステップで作成します。

1. Web.Config に Configuration Section ハンドラーを宣言する。
2. Web.Config に カスタムコンフィグレーショングループを追加する。
3. コンフィグレーションセクションハンドラー(dll)を実装する。
4. Web.Configのディレクトリにdllを配置する。

４．1　Web.Config

まず、Configuration Section Handler を宣言し、特定の名前のセクションがWeb.Config に現れた場合に呼び出すハンドラ(dll)を指定します。ここでは、Web.Config に次の行を追加します。Web.Configは、ケースセンシティブなので注意します。

  <configSections>
    <sectionGroup name="myCustomGroup">
      <section name="myCustomSection"
                   type="MyConfigSectionHandler.MyHandler,
                             MyCustomConfigurationHandler"/>
    </sectionGroup>
  </configSections>

次に、ハンドラが読み込むカスタムセクションを定義します。Web.Configファイルに次のようにカスタムコンフィグレーショングループ (myCustomGroup)を追加します。このmyCustomGroupには、myCustomSectionとして、３つの属性(fileName: String型、maxUsers: Integer型、 maxIdleTime: TimeSpan型、さらにその子供のセクションとして myChildSection)を定義します。これは<configSections> ブロック以降である必要があります。

  <!-- 追加したカスタムコンフィグレーショングループ -->
  <myCustomGroup>
    <myCustomSection fileName="test.html" maxUsers="12" maxIdleTime="0:55:34">
      <myChildSection myChildAttrib1="uchukamen" myChildAttrib2="csharp"/>
    </myCustomSection>
  </myCustomGroup>

<?xml version="1.0"?>
<configuration xmlns="http://schemas.microsoft.com/.NetConfiguration/v2.0">
  <!-- Configuration 
				section handler を宣言する -->
  <configSections>
    <sectionGroup name="myCustomGroup">
     <section name="myCustomSection"
              type="MyConfigSectionHandler.MyHandler, 

                    MyCustomConfigurationHandler"/>
    </sectionGroup>
  </configSections>

  <appSettings/>

  <system.web>
    <compilation debug="true"/>
    <authentication mode="Windows"/>
  </system.web>

  <!-- 追加したカスタムコンフィグレーショングループ -->
  <myCustomGroup>
    <myCustomSection fileName="test.html" maxUsers="12" maxIdleTime="0:55:34">
      <myChildSection myChildAttrib1="uchukamen" myChildAttrib2="csharp"/>
    </myCustomSection>
  </myCustomGroup>

</configuration>

４．２　コンフィグレーションセクションハンドラの実装

ソリューションに、クラスライブラリプロジェクトを追加し、ConfigurationSectionから継承したコンフィグレーションセクションハンドラの実体（MyCustomConfigurationHandler.cs）を実装します。このプロジェクトの出力(MyCustomConfigurationHandler.dll)は、Web.Config があるディレクトリの下のbinディレクトリに格納します。

MyCustomConfigurationHandler.cs は次のとおりで、プロパティを宣言し、[ConfigurationProperty]アトリビュートで宣言します。

パラメータとしては、Integer型、String型、TimeSpan型などが使えます。必要に応じて、IntegerValidator などのValidator アトリビュートにより、入力審査を行うことができます。

MyConfigurationSectionHandler.cs

using System;
using System.Collections;
using System.Text;
using System.Configuration;

namespace　MyConfigSectionHandler
{
　　public sealed class MyHandler : ConfigurationSection
    {

// 文字列
[ConfigurationProperty("fileName", DefaultValue = "Test.html", IsRequired = true)]
[StringValidator(InvalidCharacters = " ~!@#$%^&*()[]{}/;'\"|\\",　
MinLength = 1, MaxLength = 60)]
public string FileName
{
　　get
　　{
        return (string)this["fileName"];
　　}
　　set
　　{
　　　　this["fileName"] = value;
　　}
}

// 数値
[ConfigurationProperty("maxUsers", DefaultValue = 10, IsRequired = false)]
[IntegerValidator(MinValue = 1, MaxValue = 100,　ExcludeRange = false)]
public int MaxUsers
{
　　get
　　{
　　　　return (int)this["maxUsers"];
　　}
　　set
　　{
　　　　this["maxUsers"] = value;
　　}
}

// 時間間隔
[ConfigurationProperty("maxIdleTime")]
[TimeSpanValidator(MinValueString = "0:0:0",
MaxValueString = "1:23:45", ExcludeRange = false)]
public TimeSpan MaxIdleTime
{
    get
    {
        return (TimeSpan)this["maxIdleTime"];
    }
    set
    {
        this["maxIdleTime"] = value;
    }
}

// 子要素
[ConfigurationProperty("myChildSection")]
public ChildConfigElement MyChildSection
{
    get
    { return (ChildConfigElement)this["myChildSection"]; }
    set
    { this["myChildSection"] = value; }
}

}

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

    public ChildConfigElement(String a1, String a2)
    {
        MyChildAttribute1 = a1;
        MyChildAttribute2 = a2;
    }