如何获取web.config中自定义配置节的所有列表项（IEnumerable格式）？

我之前也踩过一模一样的坑——按照官方指南配置好了自定义配置节，但就是没法直接用枚举类的方式获取所有条目。其实核心是要让你的配置集合类实现泛型IEnumerable<T>接口，或者在配置节里封装一个返回枚举的便捷方法。下面一步步给你拆解解决方案：

1. 先确认你的配置文件结构（web.config） #

首先确保你的web.config里的配置节和条目是正确的，比如这样：

<configuration>
  <configSections>
    <!-- 注册自定义配置节 -->
    <section name="nameListSection" type="YourProjectNamespace.NameListSection, YourProjectAssembly" />
  </configSections>
  
  <!-- 自定义配置节内容 -->
  <nameListSection>
    <names>
      <add name="Alice" />
      <add name="Bob" />
      <add name="Charlie" />
    </names>
  </nameListSection>
</configuration>

2. 实现配置元素与集合类 #

第一步：单个条目的配置元素类 #

先定义单个名称条目的类，继承ConfigurationElement：

public class NameElement : ConfigurationElement
{
    // 对应配置里的name属性
    [ConfigurationProperty("name", IsRequired = true, IsKey = true)]
    public string Name
    {
        get => (string)this["name"];
        set => this["name"] = value;
    }
}

第二步：配置集合类（关键！实现泛型IEnumerable） #

这是最核心的部分——让你的集合类继承ConfigurationElementCollection的同时，实现IEnumerable<NameElement>：

using System.Collections;
using System.Collections.Generic;
using System.Configuration;

public class NameCollection : ConfigurationElementCollection, IEnumerable<NameElement>
{
    // 重写创建新元素的方法
    protected override ConfigurationElement CreateNewElement()
    {
        return new NameElement();
    }

    // 重写获取元素键的方法
    protected override object GetElementKey(ConfigurationElement element)
    {
        return ((NameElement)element).Name;
    }

    // 实现泛型GetEnumerator方法，这是让集合支持枚举的关键
    public new IEnumerator<NameElement> GetEnumerator()
    {
        foreach (NameElement element in this)
        {
            yield return element;
        }
    }
}

第三步：自定义配置节类 #

把集合类关联到配置节里：

public class NameListSection : ConfigurationSection
{
    // 关联names集合，对应配置里的<names>节点
    [ConfigurationProperty("names", IsDefaultCollection = false)]
    [ConfigurationCollection(typeof(NameCollection), AddItemName = "add")]
    public NameCollection Names
    {
        get => (NameCollection)this["names"];
        set => this["names"] = value;
    }

    // 可选：封装一个直接返回名称字符串列表的便捷方法
    public IEnumerable<string> GetAllNames()
    {
        return Names.Select(element => element.Name);
    }
}

3. 获取并使用IEnumerable格式的条目 #

现在你就可以轻松获取枚举格式的条目了，有几种方式：

using System.Configuration;
using System.Linq;
using System.Collections.Generic;

// 读取自定义配置节
var nameSection = ConfigurationManager.GetSection("nameListSection") as NameListSection;
if (nameSection != null)
{
    // 方式1：直接遍历泛型集合
    foreach (var nameElement in nameSection.Names)
    {
        // 拿到单个条目的Name属性
        Console.WriteLine(nameElement.Name);
    }

    // 方式2：用便捷方法直接获取字符串列表
    IEnumerable<string> nameList = nameSection.GetAllNames();
    foreach (var name in nameList)
    {
        Console.WriteLine(name);
    }

    // 方式3：转换成List或Array
    List<string> nameListAsList = nameSection.GetAllNames().ToList();
    string[] nameListAsArray = nameSection.GetAllNames().ToArray();
}

关键说明 #

默认的ConfigurationElementCollection只实现了非泛型的IEnumerable，所以没法直接用LINQ或者转换成泛型集合。通过手动实现泛型IEnumerable<NameElement>，你就能把配置里的所有条目转换成任意你需要的枚举格式（List、Array、IEnumerable都可以）。

内容的提问来源于stack exchange，提问作者Bagzli