如何自定義配置節點

目錄

• 自定義配置節點中相關類的介紹
• 自定義配置單節點
• 自定義配置多節點
• 使用實現接口方式來自定義配置節點

• 自定義配置節點中相關類的介紹 (返回)
• 自定義配置單節點 (返回)

1. 向項目中添加System.Configuration引用。ConfigurationSection、ConfigurationElement、ConfigurationElementCollection這幾個類都是在System.Configuration中定義的，而該dll默認並不是新建一個項目就有的，需要添加該dll引用。
2. 假如我們要配置的節點格式如下：

1. <?xml version="1.0" encoding="utf-8" ?>
2. <configuration>
3.   <configSections>
4.       <section name="SingleSectionHandler" type="CustomSingleSection.SingleSectionHandler, CustomSingleSection, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
5.   </configSections>
7.   <SingleSectionHandler myAttrib1="lastBeachhead">
8.     <MySingleSection MyAttribute1="softwarezxj" MyAttribute2="epms"/>
9.    </SingleSectionHandler>
11. </configuration>

    從配置信息可以看出，我們需要實現一個類CustomSingleSection.SingleSectionHandler，該類有2個屬性，一個屬性類型爲string,名稱爲myAttrib1,另外一個屬性類型爲MySingleSection，類型MySingleSection有2個string類型的屬性。因爲MySingleSection下並沒有子節點，故該類需要繼承自CongigurationElement,而SingleSectionHandler因爲是一個section,所以該類需要繼承自System.ConfigurationSection。
    具體的實現代碼如下：

1. using System;
2. using System.Collections.Generic;
3. using System.Linq;
4. using System.Text;
5. using System.Configuration;
7. namespace CustomSingleSection
8. {
9.     public class SingleSectionHandler : ConfigurationSection
10.     {
11.         public SingleSectionHandler()
12.         {
13.         }
14.         public SingleSectionHandler(String attribVal)
15.         {
16.             MyAttrib1 = attribVal;
17.         }
19.         [ConfigurationProperty("myAttrib1", DefaultValue = "默認值", IsRequired = true)]
20.         [StringValidator(InvalidCharacters = "~!@#$%^&*()[]{}/;'/"|//", MinLength = 1, MaxLength = 60)]
21.         public String MyAttrib1
22.         {
23.             get { return (String)this["myAttrib1"]; }
24.             set { this["myAttrib1"] = value; }
25.         }
27.         [ConfigurationProperty("MySingleSection")]
28.         public MySingleSection MySingleSection
29.         {
30.             get
31.             {
32.                 return (MySingleSection)this["MySingleSection"]; 
33.             }
34.             set
35.             {
36.                 this["MySingleSection"] = value; 
37.             }
38.         }
39.     }
41.     public class MySingleSection : ConfigurationElement 
42.     {
43.         public MySingleSection()
44.         {
45.         }
47.         public MySingleSection(String a1, String a2)
48.         {
49.             MyAttribute1 = a1;
50.             MyAttribute2 = a2;
51.         }
53.         [ConfigurationProperty("MyAttribute1", DefaultValue = "默認屬性1", IsRequired = true)]
54.         [StringValidator(InvalidCharacters = "~!@#$%^&*()[]{}/;'/"|//", MinLength = 1, MaxLength = 60)]
55.         public String MyAttribute1
56.         {
57.             get{ return (String)this["MyAttribute1"]; }
58.             set{ this["MyAttribute1"] = value; }
59.         }
61.         [ConfigurationProperty("MyAttribute2", DefaultValue = "默認屬性2", IsRequired = true)]
62.         [StringValidator(InvalidCharacters = "~!@#$%^&*()[]{}/;'/"|//", MinLength = 1, MaxLength = 60)]
63.         public String MyAttribute2
64.         {
65.             get{ return (String)this["MyAttribute2"]; }
66.             set{ this["MyAttribute2"] = value; }
67.         }
69.     }
70. }

   從代碼裏可以看出了各個基類本身已經有了索引器。另外需要注意的是，配置的信息都是大小寫敏感的。比如我們在類SingleSectionHandler中定義了屬性MyAttrib1的標籤[ConfigurationProperty("myAttrib1", DefaultValue = "默認值", IsRequired = true)]，那麼在config文件中屬性的名字就必須是myAttrib1,大小寫不能寫錯，而且MyAttrib1屬性的實現中，使用索引器的時候也必須是get { return (String)this["myAttrib1"]; } set { this["myAttrib1"] = value; },索引器中的鍵名如果不是myAttrib1,即跟config中的屬性名稱不一樣，那也是運行不成功的。
   使用該配置的代碼如下：

1. using System;
2. using System.Collections.Generic;
3. using System.Linq;
4. using System.Text;
5. using System.Configuration;
7. namespace CustomSingleSection
8. {
9.     class Program
10.     {
11.         static void Main(string[] args)
12.         {
13.             LookCustomSingleSection();
14.             Console.ReadLine();
15.         }
17.         private static void LookCustomSingleSection() 
18.         {
19.             SingleSectionHandler mySingleSection = ConfigurationManager.GetSection("SingleSectionHandler") as SingleSectionHandler;
20.             StringBuilder sb = new StringBuilder();
22.             sb.Append("該自定義配置節的屬性MyAttrib1的值是：");
23.             sb.Append(mySingleSection.MyAttrib1.ToString());
24.             sb.Append("/n");
26.             sb.Append("該自定義配置節的MySingleConfigElement節點的MyAttribute1屬性的值是：");
27.             sb.Append( mySingleSection.MySingleSection.MyAttribute1.ToString() );
28.             sb.Append("/n");
30.             sb.Append("該自定義配置節的MySingleConfigElement節點的MyAttribute2屬性的值是：");
31.             sb.Append(mySingleSection.MySingleSection.MyAttribute2.ToString());
32.             sb.Append("/n");
34.             Console.WriteLine( sb.ToString() );
35.         }
37.     }
39. }

• 自定義配置多節點 (返回)

   舉例說明，假如我們需要實現一個如下的配置：

1. <customMulSectionDemo>
2.     <regexUrlMapping enable="true" rebaseClientPath="true">
3.       <add url="(/d+)$" mappedUrl="default.aspx?id=$1"></add>
4.       <add url="/$" mappedUrl="default.aspx?id=0"></add>
5.     </regexUrlMapping>
6. </customMulSectionDemo>

    在這裏customMulSectionDemo就是我們要定義的配置節，而配置節裏面又包含一個regexUrlMapping元素，該元素有兩個屬性和一些子元素，我們選擇的子元素比較特殊，它是n個add元素。使用的形式跟assSettings元素下面的add元素類似。那麼如何實現這個自定義配置呢？
    首先需要定義一個配置節元素，如下：

1. <configSections>
2.     <section name="customMulSectionDemo" type="CustomMulSection.RegexUrlMappingConfig,CustomMulSection" allowDefinition="Everywhere" restartOnExternalChanges="true" allowLocation="true"/>
3. </configSections>

    在這裏，我們只講解name和type屬性的使用，其它屬性的用法請參閱MSDN。name屬性表示自定義配置節元素的名稱。Type表示應該由哪個dll下哪個命名空間的哪個類來處理這個配置節。如上例中所寫，CustomMulSection是dll的名稱(可以從AssemblyInfo.cs文件中找到)，CustomMulSection.RegexUrlMappingConfig是處理該配置節的類的全名稱（包含命名空間）。
    Ok，我們已經把目的明確了，下面的工作就是要實現RegexUrlMappingConfig這個類。要想此類擁有處理配置節的能力，就必須裝飾一下這個類，裝飾完成後，此類的代碼如下：

1. class RegexUrlMappingConfig : ConfigurationSection
2.     {
3.         [ConfigurationProperty("regexUrlMapping")]
4.         public UrlMappingCollection UrlMappings
5.         {
6.             get{return this["regexUrlMapping"] as UrlMappingCollection;}
7.         }
8.     }

    首先，我們的類應該從ConfigurationSection類繼承。這樣它就有了處理自定義配置信息的能力。由於我們的配置節中只有一個regexUrlMapping元素，而且此元素包含了很多add元素。這種情況下我們使用了一個名爲UrlMappings的屬性來表示這個集合。爲了表示該屬性和元素之間的映射關係，我們需要以ConfigurationProperty自定義屬性修飾UrlMappings。ConfigurationProperty類的參數” regexUrlMapping”指定了要映射的元素。get訪問器中的代碼非常程式化，這裏不講它的原理，只需要知道如此就可以實現對數據的訪問。
    下一步，就是實現UrlMappingCollection類。由名字可以得知，這是一個集合類，它一般用來處理包含add元素的元素。實現此類也需要使用自定義屬性對此類進行裝飾。如下：

1. class UrlMappingCollection : ConfigurationElementCollection
2.     {
3.         protected override ConfigurationElement CreateNewElement()
4.         {
5.             return new UrlMapping();
6.         }
7.         protected override object GetElementKey(ConfigurationElement element)
8.         {
9.             return ((UrlMapping)element).Url;
10.         }
12.         [ConfigurationProperty("enable")]
13.         public bool Enable
14.         {
15.             get
16.             {
17.                 return bool.Parse(this["enable"].ToString());
18.             }
19.         }
21.         [ConfigurationProperty("rebaseClientPath")]
22.         public bool RebaseClientPath
23.         {
24.             get
25.             {
26.                 return bool.Parse(this["rebaseClientPath"].ToString());
27.             }
28.         }
30.         //寫一個索引器，方便的訪問該集合中的元素。
31.         //如果不寫，則只有foreach來訪問。
32.         public UrlMapping this[int index] 
33.         {
34.             get
35.             {
36.                 return this.BaseGet(index) as UrlMapping;
37.             }
38.         }
40.     }

    可以看到，實現表示集合元素的類必須從ConfigurationElementCollection類繼承。並且必須提供CreateNewElement和GetElementKey兩個方法的重載。CreateNewElement其實是一個工廠方法，在此方法中，你必須返回一個表示一個add元素的對象，這樣系統才能從web.config讀取數據並形成一個集合。GetElementKey方法中，你需要返回一個可以表示爲add元素鍵值的屬性，方法的參數就是表示add元素的對象，該對象一定是從ConfigurationElement繼承的，所以我們可以將其轉換爲一個我們自定義的配置對象，然後訪問它的屬性。在示例中我們返回了add元素的url屬性值。因爲這個方法是拿到一個對象對應的key，所以經常被其它方法調用以獲取對象。
    現在，我們已經實現了需要重寫的方法。看到regexUrlMapping元素還包括兩個屬性，實現這兩個屬性的代碼與已講過的內容類似。在此不做贅述。
    還差最後一步，就是實現表示add元素的類。如下：

1. class UrlMapping : ConfigurationElement
2.     {
3.         [ConfigurationProperty("mappedUrl")]
4.         public string MappedUrl
5.         {
6.             get
7.             {
8.                 return (string)this["mappedUrl"];
9.             }
10.         }
12.         [ConfigurationProperty("url")]
13.         public string Url
14.         {
15.             get
16.             {
17.                 return (string)this["url"];
18.             }
19.         }
20.     }

   唯一需要講述的就是這個類必須從ConfigurationElement繼承。其它的內容通過以上的講述應該能夠很好的理解。
   至此，我們已經完成了配置的映射工作。
   完整的代碼如下所示：
   app.config:

1. <?xml version="1.0" encoding="utf-8" ?>
2. <configuration>
3.   <configSections>
4.     <section name="customMulSectionDemo" type="CustomMulSection.RegexUrlMappingConfig,CustomMulSection" allowDefinition="Everywhere" restartOnExternalChanges="true" allowLocation="true"/>
5.   </configSections>
7.   <customMulSectionDemo>
8.     <regexUrlMapping enable="true" rebaseClientPath="true">
9.       <add url="(/d+)$" mappedUrl="default.aspx?id=$1"></add>
10.       <add url="/$" mappedUrl="default.aspx?id=0"></add>
11.     </regexUrlMapping>
12.   </customMulSectionDemo>
13.   
14. </configuration>

   配置相關的解釋類：

1. using System;
2. using System.Collections.Generic;
3. using System.Linq;
4. using System.Text;
5. using System.Configuration;
7. namespace CustomMulSection
8. {
9.     class RegexUrlMappingConfig : ConfigurationSection
10.     {
11.         [ConfigurationProperty("regexUrlMapping")]
12.         public UrlMappingCollection UrlMappings
13.         {
14.             get{return this["regexUrlMapping"] as UrlMappingCollection;}
15.         }
16.     }
18.     class UrlMappingCollection : ConfigurationElementCollection
19.     {
20.         protected override ConfigurationElement CreateNewElement()
21.         {
22.             return new UrlMapping();
23.         }
24.         protected override object GetElementKey(ConfigurationElement element)
25.         {
26.             return ((UrlMapping)element).Url;
27.         }
29.         [ConfigurationProperty("enable")]
30.         public bool Enable
31.         {
32.             get
33.             {
34.                 return bool.Parse(this["enable"].ToString());
35.             }
36.         }
38.         [ConfigurationProperty("rebaseClientPath")]
39.         public bool RebaseClientPath
40.         {
41.             get
42.             {
43.                 return bool.Parse(this["rebaseClientPath"].ToString());
44.             }
45.         }
47.         //寫一個索引器，方便的訪問該集合中的元素。
48.         //如果不寫，則只有foreach來訪問。
49.         public UrlMapping this[int index] 
50.         {
51.             get
52.             {
53.                 return this.BaseGet(index) as UrlMapping;
54.             }
55.         }
57.     }
59.     class UrlMapping : ConfigurationElement
60.     {
61.         [ConfigurationProperty("mappedUrl")]
62.         public string MappedUrl
63.         {
64.             get
65.             {
66.                 return (string)this["mappedUrl"];
67.             }
68.         }
70.         [ConfigurationProperty("url")]
71.         public string Url
72.         {
73.             get
74.             {
75.                 return (string)this["url"];
76.             }
77.         }
78.     }
80. }

   測試代碼：

1. using System;
2. using System.Collections.Generic;
3. using System.Linq;
4. using System.Text;
5. using System.Configuration;
7. namespace CustomMulSection
8. {
9.     class Program
10.     {
11.         static void Main(string[] args)
12.         {
13.             DealMulSection();
14.             Console.ReadLine();
15.         }
17.         private static void DealMulSection() 
18.         {
19.             RegexUrlMappingConfig myCustomMulSection = ConfigurationManager.GetSection("customMulSectionDemo") as RegexUrlMappingConfig;
20.             StringBuilder sb = new StringBuilder();
22.             sb.Append("myCustomMulSection對象的regexUrlMapping屬性(實際是個集合)的enable:");
23.             sb.Append(myCustomMulSection.UrlMappings.Enable.ToString());
24.             sb.Append("/n");
26.             sb.Append("myCustomMulSection對象的regexUrlMapping屬性(實際是個集合)的rebaseClientPath:");
27.             sb.Append(myCustomMulSection.UrlMappings.RebaseClientPath.ToString());
28.             sb.Append("/n");
30.             for (int i = 0; i < myCustomMulSection.UrlMappings.Count; i++ )
31.             {
32.                 sb.Append("UrlMappings[");
33.                 sb.Append(i.ToString());
34.                 sb.Append("].url:");
35.                 sb.Append(myCustomMulSection.UrlMappings[i].Url.ToString());
36.                 sb.Append("/n");
38.                 sb.Append("UrlMappings[");
39.                 sb.Append(i.ToString());
40.                 sb.Append("].mappedUrl:");
41.                 sb.Append(myCustomMulSection.UrlMappings[i].MappedUrl.ToString());
42.                 sb.Append("/n");
43.             }
45.             Console.WriteLine(sb.ToString());
46.         }
47.     }
48. }

• 使用實現接口方式來自定義配置節點 (返回)