ASP.NET杂谈-一切都从web.config说起（2）（ConfigSections详解-中）

我们就接着上一篇继续说，上一篇中介绍了ConfigSection的结构和两个简单的DEMO，本篇就说一下SectionGroup、ConfigurationElementCollection和key/value pair configurationsection.

的使用。

1、SectionGroup的使用

---

下面的代码简单的说明一下SectionGroup的使用：

1)、首先定义一个继承ConfigurationSectionGroup的类：

/// <summary>
/// 自定义SectionGroup
/// </summary>
   public class MySectionGroup:ConfigurationSectionGroup
   {
       [ConfigurationProperty("myBlog")]
       public MySection MyBlog
       {
           get
           {
               return (MySection)base.Sections["myBlog"];
           }
       }
   }

2)、其次，在定义一个继承ConfigurationSection的Section：

/// <summary>
    /// 自定义Section
    /// </summary>
    public class MySection:ConfigurationSection
    {
        [ConfigurationProperty("name")]
        public string BlogName
        {
            get
            {
                return (string)base["name"];
            }
        }
        [ConfigurationProperty("url")]
        public string BlogUrl
        {
            get
            {
                return (string)base["url"];
            }
        }
    }

下面再讨论一下怎么在web.config中如何配置和使用：

web.config中的配置：

<configSections>
        <sectionGroup name="myBlogs" type="KevinDiao.MySectionDemo01.MySectionGroup,KevinDiao.MySectionDemo01">
            <section name="myBlog" type="KevinDiao.MySectionDemo01.MySection,KevinDiao.MySectionDemo01"/>
        </sectionGroup>
</configSections>

<myBlogs>
    <myBlog name="五香瓜子" url="http://www.cnblogs.com/diaojia/"></myBlog>
</myBlogs>

读取web.config中配置：

 MySection mySection = ConfigurationManager.GetSection("myBlogs/myBlog") as MySection;
 Response.Write("博客名称：" + mySection.BlogName + "<br/>");
Response.Write("博客地址：<a href='" + mySection.BlogUrl + "'>" + mySection.BlogUrl + "</a>");

运行得到的结果：

博客名称：五香瓜子
博客地址：http://www.cnblogs.com/diaojia/

2、ConfigurationElementCollection的使用

---

    下面再来讨论一下怎么在ConfigSections中配置自定义集合，我们还是用代码说明吧。

   1)、 首先定义一个继承ConfigurationElement的类。

    /// <summary>
    /// 自定义Element
    /// </summary>
    public class MyBlogElement:ConfigurationElement
    {
        [ConfigurationProperty("name")]
        public string Name
        {
            get
            {
                return (string)base["name"];
            }
        }
        [ConfigurationProperty("url")]
        public string Url
        {
            get
            {
                return (string)base["url"];
            }
        }
    }

它主要包含要配置的主要内容。

2)、其次定义一个继承ConfigurationElementCollection的类

    /// <summary>
    /// 自定义ElementCollection
    /// </summary>
    public class MyBlogElementCollection:ConfigurationElementCollection
    {
        protected override ConfigurationElement CreateNewElement()
        {
            return new MyBlogElement();
        }
        protected override object GetElementKey(ConfigurationElement element)
        {
            return ((MyBlogElement)element).Name;
        }
        public override ConfigurationElementCollectionType CollectionType
        {
            get
            {
                return ConfigurationElementCollectionType.BasicMap;
            }
        }

        protected override string ElementName
        {
            get
            {
                return "myBlog";
            }
        }
        public MyBlogElement this[int index]
        {
            get
            {
                return (MyBlogElement)BaseGet(index);
            }
            set
            {
                if (BaseGet(index) != null)
                {
                    BaseRemoveAt(index);
                }
                BaseAdd(index, this);
            }
        }
    }

3）、再次定义一个继承ConfigurationSection的类

    /// <summary>
    /// 自定义Section
    /// </summary>
    public class MyBlogSection:ConfigurationSection
    {
        [ConfigurationProperty("name")]
        public string Name
        {
            get
            {
                return (string)base["name"];
            }
        }
        [ConfigurationProperty("",IsDefaultCollection=true)]
        public MyBlogElementCollection MyBlogCollection
        {
            get
            {
                return (MyBlogElementCollection)base[""];
            }
        }

    }

下面在看看怎么在web.config中如何配置：

<configSections>
<section name ="MyBlogs"  type="KevinDiao.MySectionDemo02.MyBlogSection,KevinDiao.MySectionDemo02"/>
</configSections>
 <MyBlogs name="KevinDiao">
    <myBlog name="五香瓜子" url="http://www.cnblogs.com/diaojia/"></myBlog>
    <myBlog name="业精于勤" url="http://diaojia.blog.51cto.com/"></myBlog>
  </MyBlogs>

再看看怎么读取:

MyBlogSection mySection = ConfigurationManager.GetSection("MyBlogs") as MyBlogSection;
foreach (MyBlogElement item in mySection.MyBlogCollection)
 {
      Response.Write("博客名称：" + item.Name + "<br/>");
      Response.Write("博客地址：<a href='" + item.Url + "'>" + item.Url + "</a>" + "<br/>");
      Response.Write("-----------------------------------------------------------------<br/>");
  }

最后在看看运行的结果：

博客名称：五香瓜子
博客地址：http://www.cnblogs.com/diaojia/
-----------------------------------------------------------------
博客名称：业精于勤
博客地址：http://diaojia.blog.51cto.com/
-----------------------------------------------------------------

3、key/value pair configurationsection的使用（例如：appSettings）

---

最后在简单的说明一下在web.config中怎么使用key/value pair configurationsection。

1)、首先定义一个继承ConfigurationElement的类

    /// <summary>
    /// 自定义ConfigurationElement
    /// </summary>
    public class MyBlogElement: ConfigurationElement
    {
        [ConfigurationProperty("name")]
        public string Name
        {
            get
            {
                return (string)base["name"];
            }
        }
        [ConfigurationProperty("url")]
        public string Url
        {
            get
            {
                return (string)base["url"];
            }
        }
    }

其实和在2、ConfigurationElementCollection的使用中的差不多。

2)、其次在定义一个继承ConfigurationElementCollection的类：

    /// <summary>
    /// 自定义ConfigurationElementCollection
    /// </summary>
    public class MyBlogsElectionCollection:ConfigurationElementCollection
    {
        protected override ConfigurationElement CreateNewElement()
        {
            return new MyBlogElement();
        }

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

3）、再次就是定义一个继承ConfigurationSection的类

    /// <summary>
    /// 自定义Section
    /// </summary>
    public class MyBlogsSection : ConfigurationSection
    {
        [ConfigurationProperty("name")]
        public string Name
        {
            get
            {
                return (string)base["name"];
            }
        }
        [ConfigurationProperty("",IsDefaultCollection=true)]
        public MyBlogsElectionCollection MyBlogs
        {
            get
            {
                return (MyBlogsElectionCollection)base[""];
            }
        }
    }

下面在看看怎么在web.config中如何配置：

<configSections>
 <section name="MyBlogs" type="KevinDiao.MySectionDemo03.MyBlogsSection,KevinDiao.MySectionDemo03"/>
</configSections>
 <MyBlogs name="KevinDiao">
    <add name="五香瓜子" url="http://www.cnblogs.com/diaojia/"></add>
    <add name="业精于勤" url="http://diaojia.blog.51cto.com/"></add>
 </MyBlogs>

再看看怎么读取:

MyBlogsSection mySection = ConfigurationManager.GetSection("MyBlogs") as MyBlogsSection;
 foreach (MyBlogElement item in mySection.MyBlogs)
 {
     Response.Write("博客名称：" + item.Name + "<br/>");
     Response.Write("博客地址：<a href='" + item.Url + "'>" + item.Url + "</a>" + "<br/>");
     Response.Write("-----------------------------------------------------------------<br/>");
 }

最后在看看运行的结果：

博客名称：五香瓜子
博客地址：http://www.cnblogs.com/diaojia/
-----------------------------------------------------------------
博客名称：业精于勤
博客地址：http://diaojia.blog.51cto.com/
-----------------------------------------------------------------

最后在附上本篇的代码：DEMO

参考：

MSDN