方法 : ConfigurationSection を使用してカスタム構成セクションを作成する

[アーティクル]
10/22/2014

更新 : 2007 年 11 月

独自の XML 構成要素を使用して、標準の ASP.NET 構成設定のセットを拡張できます。拡張する場合は、独自の構成セクションハンドラを作成する必要があります。

このハンドラは、System.Configuration.ConfigurationSection クラスを実装する .NET Framework クラスであることが必要です。

メモ :
.NET Framework Versions 1.0 および 1.1 では、構成セクションハンドラに System.Configuration.IConfigurationSectionHandler インターフェイスを実装する必要がありましたが、現在ではこれは推奨されていません。ただし、「方法 : IConfigurationSectionHandler を使用してカスタム構成セクションを作成する」にはコード例が紹介されています。

.NET Framework Versions 1.0 および 1.1 では、構成セクションハンドラに System.Configuration.IConfigurationSectionHandler インターフェイスを実装する必要がありましたが、現在ではこれは推奨されていません。ただし、「方法 : IConfigurationSectionHandler を使用してカスタム構成セクションを作成する」にはコード例が紹介されています。

セクションハンドラは、Web.config ファイルの特定の部分にある XML 構成要素で定義された設定を解釈して処理し、その構成設定に基づいて適切な構成オブジェクトを返します。ハンドラクラスが返す構成オブジェクトでは、任意のデータ構造を使用できます。このオブジェクトは基本構成クラスや構成形式に限定されません。ASP.NET は構成オブジェクトを使用して、カスタム構成要素の読み取りおよび書き込みを行います。

カスタム構成セクションハンドラを作成するには

次のコード例に示すように、System.Configuration.ConfigurationSection クラスを継承するパブリッククラスを作成します。

Imports System
Imports System.Collections
Imports System.Text
Imports System.Configuration
Imports System.Xml

Namespace MyConfigSectionHandler

    Public Class MyHandler
        Inherits ConfigurationSection

        Public Sub New()
        End Sub

        ' Add declarations for child elements and attributes like this:
        '<ConfigurationProperty("<propertyName>", <named parameters>)> _
        'Public Property MyAttrib1() As <type>
        '    Get
        '        Return CStr(Me("<propertyName>"))
        '    End Get
        '    Set(ByVal value As <type>)
        '        Me("<propertyName>") = value
        '    End Set
        'End Property

    End Class
End Namespace

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

namespace MyConfigSectionHandler
{
    public class MyHandler : ConfigurationSection
    {
        public MyHandler()
        {
        }

        // Add declarations for child elements and attributes like this:
        // [ConfigurationProperty("<propertyName>", <named parameters>)]
        // public <type> <PropertyName>
        // {
        //     get { return (<type>)this["<propertyName>"]; }
        //     set { this["<propertyName>"] = value; }
        // }
    }
}

必要な構成作業を実行する、独自のコードを追加します。

たとえば、カスタムセクションから値を取得する次のコードに、コメントのあるコードを置き換えることができます。

Imports System
Imports System.Collections
Imports System.Text
Imports System.Configuration
Imports System.Xml

Namespace MyConfigSectionHandler

    Public Class MyHandler
        Inherits ConfigurationSection

        Public Sub New()
        End Sub

        Public Sub New(ByVal attribVal As String)
            MyAttrib1 = attribVal
        End Sub

        <ConfigurationProperty("myAttrib1", DefaultValue:="Clowns", IsRequired:=True)> _
        <StringValidator(InvalidCharacters:="~!@#$%^&*()[]{}/;'\|\\", MinLength:=1, MaxLength:=60)> _
        Public Property MyAttrib1() As String
            Get
                Return CStr(Me("myAttrib1"))
            End Get
            Set(ByVal value As String)
                Me("myAttrib1") = value
            End Set
        End Property

        <ConfigurationProperty("myChildSection")> _
        Public Property MyChildSection() As MyChildConfigElement
            Get
                Return CType(Me("myChildSection"), MyChildConfigElement)
            End Get
            Set(ByVal value As MyChildConfigElement)
                Me("myChildSection") = CType(value, MyChildConfigElement)
            End Set
        End Property
    End Class

    Public Class MyChildConfigElement
        Inherits ConfigurationElement

        Public Sub New()
        End Sub

        Public Sub New( _
        ByVal a1 As String, ByVal a2 As String)
            MyChildAttribute1 = a1
            MyChildAttribute2 = a2
        End Sub

        <ConfigurationProperty("myChildAttrib1", DefaultValue:="Zippy", IsRequired:=True)> _
        <StringValidator(InvalidCharacters:="~!@#$%^&*()[]{}/;'\|\\", MinLength:=1, MaxLength:=60)> _
        Public Property MyChildAttribute1() As String
            Get
                Return CStr(Me("myChildAttrib1"))
            End Get
            Set(ByVal value As String)
                Me("myChildAttrib1") = value
            End Set
        End Property

        <ConfigurationProperty("myChildAttrib2", DefaultValue:="Michael Zawondy", IsRequired:=True)> _
        <StringValidator(InvalidCharacters:="~!@#$%^&*()[]{}/;'\|\\", MinLength:=1, MaxLength:=60)> _
        Public Property MyChildAttribute2() As String
            Get
                Return CStr(Me("myChildAttrib2"))
            End Get
            Set(ByVal value As String)
                Me("myChildAttrib2") = value
            End Set
        End Property

    End Class
End Namespace

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

namespace MyConfigSectionHandler
{
    public class MyHandler : ConfigurationSection
    {
        public MyHandler()
        {
        }

        public MyHandler(String attribVal)
        {
            MyAttrib1 = attribVal;
        }

        [ConfigurationProperty("myAttrib1", DefaultValue = "Clowns", IsRequired = true)]
        [StringValidator(InvalidCharacters = "~!@#$%^&*()[]{}/;'\"|\\", MinLength = 1, MaxLength = 60)]
        public String MyAttrib1
        {
            get
            { return (String)this["myAttrib1"]; }
            set
            { this["myAttrib1"] = value; }
        }

        [ConfigurationProperty("myChildSection")]
        public MyChildConfigElement MyChildSection
        {
            get
            { return (MyChildConfigElement)this["myChildSection"]; }
            set
            { this["myChildSection"] = value; }
        }
    }

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

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

        [ConfigurationProperty("myChildAttrib1", DefaultValue = "Zippy", IsRequired = true)]
        [StringValidator(InvalidCharacters = "~!@#$%^&*()[]{}/;'\"|\\", MinLength = 1, MaxLength = 60)]
        public String MyChildAttribute1
        {
            get
            { return (String)this["myChildAttrib1"]; }
            set
            { this["myChildAttrib1"] = value; }
        }

        [ConfigurationProperty("myChildAttrib2", DefaultValue = "Michael Zawondy", IsRequired = true)]
        [StringValidator(InvalidCharacters = "~!@#$%^&*()[]{}/;'\"|\\", MinLength = 1, MaxLength = 60)]
        public String MyChildAttribute2
        {
            get
            { return (String)this["myChildAttrib2"]; }
            set
            { this["myChildAttrib2"] = value; }
        }
    }
}

この例では、宣言モデルを使用しています。System.Configuration.ConfigurationSection クラスは、プログラムモデルを使用して実装することもできます。例については、「System.Configuration.ConfigurationSection」のクラスの概要トピック、および「カスタムセクションハンドラを作成するためのクラス」を参照してください。

参考までに、このコード例は、「方法 : IConfigurationSectionHandler を使用してカスタム構成セクションを作成する」のコードと似ていますが、System.Configuration.ConfigurationSection クラスを継承すると、セクションハンドラをより細かく制御できるようになります。たとえば、次の手順に示す構成ファイルを使用すると、上記のコードで ConfigurationProperty を宣言し、ConfigurationElement から派生したクラスとして定義した myChildSection という子要素を使用できるようになります。さらに、ConfigurationElementCollection クラス内にコレクション機能をカプセル化することにより、構成ファイル内で add 要素、remove 要素、および clear 要素を使用できるコレクション要素を容易に作成できます。使用例を含む詳細については、「ConfigurationElementCollection」を参照してください。

ASP.NET 構成ファイルにカスタムセクションハンドラを追加するには

次のコード例に示すように、configSections 要素内の Web.config ファイルに、sectionGroup 要素と section 要素を追加します。この宣言により、カスタムセクションハンドラがセクション名に関連付けられます。

メモ :

sectionGroup 内に section 要素を入れ子にすることは必須ではありませんが、構成データの的確な編成に役立つため、お勧めします。

セクションハンドラ宣言は、カスタム構成要素を追加する構成ファイルとは異なる構成ファイルに追加できます。ただし、その場合は、セクションハンドラが宣言される構成ファイルの方が構成ファイル階層で上位にある必要があります。詳細については、「ASP.NET 構成ファイルの階層と継承」を参照してください。

section 要素の type 属性は、アセンブリのマニフェストに一致する必要があり、一致しなければ構成エラーが発生します。アセンブリファイル自体は、これを定義する Web.config ファイルと同じ ASP.NET アプリケーションディレクトリ内に格納されている必要があります。
```
<configuration>


  <configSections>
    <sectionGroup name="myCustomGroup">
      <section 
        name="myCustomSection" 
        type="MyConfigSectionHandler.MyHandler, MyCustomConfigurationHandler, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" 
        allowLocation="true" 
        allowDefinition="Everywhere"
      />
    </sectionGroup>
      
  </configSections>

  

</configuration>
```

メモ :
sectionGroup 内に section 要素を入れ子にすることは必須ではありませんが、構成データの的確な編成に役立つため、お勧めします。

カスタム構成要素を、Web.config ファイルの構成セクション設定領域に追加します。

<configuration>

<!-- Configuration section-handler declaration area. -->

  <!-- Configuration section settings area. -->
  <myCustomGroup>
    <myCustomSection myAttrib1="Clowns">
      <myChildSection 
          myChildAttrib1="Zippy" 
          myChildAttrib2="Michael Zawondy "/>
    </myCustomSection>
  </myCustomGroup>

  <!-- Other configuration settings, like <system.web> -->

</configuration>

プログラムによりカスタム構成データにアクセスするには

カスタム構成オブジェクトのインスタンスを取得し、GetSection メソッドまたは GetSection メソッドを使用してインスタンスを設定します。

次の ASPX ページ例では、前の例と連動して、カスタム構成セクションの属性および子要素を列挙します。

<%@ Page Language="C#" %>

<script runat="server">
    protected void Button1_Click(object sender, EventArgs e)
    {
        MyConfigSectionHandler.MyHandler config =
            (MyConfigSectionHandler.MyHandler)System.Configuration.ConfigurationManager.GetSection(
            "myCustomGroup/myCustomSection");

        StringBuilder sb = new StringBuilder();

        sb.Append("<h2>Attributes in the myCustomSection Element:</h2>");
        sb.AppendFormat("myAttrib1 = {0}<br/>", config.MyAttrib1.ToString());
        sb.Append("<h2>Attributes in the myChildSection Element:</h2>");
        sb.AppendFormat("myChildAttrib1 = {0}<br/>", config.MyChildSection.MyChildAttribute1.ToString());
        sb.AppendFormat("myChildAttrib2 = {0}<br/>", config.MyChildSection.MyChildAttribute2.ToString());

        Label1.Text = sb.ToString();
        Label1.Visible = true;
    }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>

    <h1>Enumerate MyCustomSection</h1>
    <asp:Label ID="Label1" runat="server" 
        Text="" />
    <br />
    <asp:Button ID="Button1" runat="server" 
        Text="Get Custom Config Info" 
        OnClick="Button1_Click" />

    </div>
    </form>
</body>
</html>

<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
    Protected Sub Button1_Click(ByVal sender As Object, ByVal e As System.EventArgs)
        Dim config As New MyConfigSectionHandler.MyHandler
        config = _
            System.Configuration.ConfigurationManager.GetSection("myCustomGroup/myCustomSection")
        Dim sb As New StringBuilder
        sb.Append("<h2>Attributes in the myCustomSection Element:</h2>")
        sb.AppendFormat("myAttrib1 = {0}<br/>", config.MyAttrib1.ToString())
        sb.Append("<h2>Attributes in the myChildSection Element:</h2>")
        sb.AppendFormat("myChildAttrib1 = {0}<br/>", config.MyChildSection.MyChildAttribute1.ToString())
        sb.AppendFormat("myChildAttrib2 = {0}<br/>", config.MyChildSection.MyChildAttribute2.ToString())

        Label1.Text = sb.ToString()
        Label1.Visible = True

    End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>

    <h1>Enumerate MyCustomSection</h1>
    <asp:Label ID="Label1" runat="server" 
        Text=""/>
    <br />
    <asp:Button ID="Button1" runat="server" 
        Text="Get Custom Config Info" 
        OnClick="Button1_Click" />

    </div>
    </form>
</body>
</html>

参照

概念

ASP.NET 構成ファイルの構造 (セクションおよびセクションハンドラ)

ASP.NET 構成の概要

その他の技術情報

ASP.NET Web サイトの管理

アプリケーションの設定

次の方法で共有

方法 : ConfigurationSection を使用してカスタム構成セクションを作成する

カスタム構成セクションハンドラを作成するには

ASP.NET 構成ファイルにカスタムセクションハンドラを追加するには

プログラムによりカスタム構成データにアクセスするには

参照

概念

その他の技術情報

その他のリソース

次の方法で共有

方法 : ConfigurationSection を使用してカスタム構成セクションを作成する

カスタム構成セクション ハンドラを作成するには

ASP.NET 構成ファイルにカスタム セクション ハンドラを追加するには

プログラムによりカスタム構成データにアクセスするには

参照

概念

その他の技術情報

その他のリソース

カスタム構成セクションハンドラを作成するには

ASP.NET 構成ファイルにカスタムセクションハンドラを追加するには