如何修复ConfigurationManager.GetSection读取app.config返回null问题

我来帮你搞定这个配置读取返回null的问题，咱们一步步梳理问题根源，再逐个修正：

问题核心原因 #

你的配置文件和代码之间存在几处关键不匹配，这是读取失败的主要原因：

• 配置节的层级结构与读取路径不对应
• 配置类的属性映射名称和配置文件中的元素名不一致
• 配置类属性的Setter逻辑写反了（虽不直接导致null，但会引发后续赋值问题）

1. 修正app.config的配置结构 #

首先要确保配置节的层级正确，并且section的type指向正确的程序集（注意：如果模型类在单独类库，这里要写类库名称，否则写主项目名称）：

<configSections>
  <sectionGroup name="GeneralTenantEmailSettings">
    <section name="TenantEmailSettings" type="DataApiService.Models.TenantEmailSettings, DataApiService" />
  </sectionGroup>
</configSections>

<GeneralTenantEmailSettings>
  <TenantEmailSettings>
    <CcgSettingCcg SettingsId="520305DC-6E68-4FA3-B53B-18E25E0E21FF" TenantId="A0C55F11-516E-4F7C-9ECD-DEF7C47290B4" Frequency="168" StartDate="03/06/2020" RuleType="Default" To="Ccg" />
    <!-- 未来可以直接添加同类型的其他配置项 -->
    <CcgSettingCcg2 SettingsId="XXXX-XXXX-XXXX-XXXX" TenantId="XXXX-XXXX-XXXX-XXXX" Frequency="24" StartDate="03/07/2020" RuleType="Custom" To="Ccg2" />
  </TenantEmailSettings>
</GeneralTenantEmailSettings>

2. 修正配置类的映射逻辑 #

你的配置类有两处致命错误，现在一并修正：

using System;
using System.Configuration;

namespace DataApiService.Models
{
    public class CcgSettings : ConfigurationElement
    {
        [ConfigurationProperty("SettingsId", IsRequired = true)]
        public Guid SettingsId
        {
            get { return (Guid)this["SettingsId"]; }
            set { this["SettingsId"] = value; } // 修正Setter：把值赋值给配置项
        }

        [ConfigurationProperty("TenantId", DefaultValue = null, IsRequired = false)]
        public Guid? TenantId
        {
            get { return this["TenantId"] as Guid?; } // 避免null时强制转换报错
            set { this["TenantId"] = value; }
        }

        [ConfigurationProperty("Frequency", DefaultValue = 0, IsRequired = true)]
        public int Frequency
        {
            get { return (int)this["Frequency"]; }
            set { this["Frequency"] = value; }
        }

        [ConfigurationProperty("StartDate", IsRequired = true)]
        public DateTime StartDate
        {
            get { return (DateTime)this["StartDate"]; }
            set { this["StartDate"] = value; }
        }

        [ConfigurationProperty("RuleType", DefaultValue = "default", IsRequired = true)]
        public string RuleType
        {
            get { return (string)this["RuleType"]; }
            set { this["RuleType"] = value; }
        }

        [ConfigurationProperty("To", IsRequired = true)]
        public string To
        {
            get { return (string)this["To"]; }
            set { this["To"] = value; }
        }
    }

    public class TenantEmailSettings : ConfigurationSection
    {
        // ConfigurationProperty名称必须和配置文件中的元素名完全一致
        [ConfigurationProperty("CcgSettingCcg")]
        public CcgSettings CcgSettingsCcg
        {
            get { return (CcgSettings)this["CcgSettingCcg"]; }
            set { this["CcgSettingCcg"] = value; }
        }

        // 为未来的CcgSettingCcg2预留属性
        [ConfigurationProperty("CcgSettingCcg2")]
        public CcgSettings CcgSettingsCcg2
        {
            get { return (CcgSettings)this["CcgSettingCcg2"]; }
            set { this["CcgSettingCcg2"] = value; }
        }
    }

    public class GeneralTenantEmailSettings : ConfigurationSectionGroup
    {
        [ConfigurationProperty("TenantEmailSettings")]
        public TenantEmailSettings TenantEmailSettings
        {
            get { return (TenantEmailSettings)Sections["TenantEmailSettings"]; }
            set { Sections["TenantEmailSettings"] = value; }
        }
    }
}

3. 正确的配置读取代码 #

必须按照配置节的层级路径读取，不能直接读取子元素，两种可行的读取方式：

// 方式1：通过SectionGroup逐层读取
var generalSettings = ConfigurationManager.GetSectionGroup("GeneralTenantEmailSettings") as GeneralTenantEmailSettings;
if (generalSettings != null && generalSettings.TenantEmailSettings != null)
{
    var ccgSetting = generalSettings.TenantEmailSettings.CcgSettingsCcg;
    // 正常访问配置属性
    Console.WriteLine($"SettingsId: {ccgSetting.SettingsId}, To: {ccgSetting.To}");
    
    // 读取未来添加的CcgSettingCcg2
    var ccgSetting2 = generalSettings.TenantEmailSettings.CcgSettingsCcg2;
}

// 方式2：直接读取TenantEmailSettings节（指定完整路径）
var tenantSettingsDirect = ConfigurationManager.GetSection("GeneralTenantEmailSettings/TenantEmailSettings") as TenantEmailSettings;
if (tenantSettingsDirect != null)
{
    var ccgSetting = tenantSettingsDirect.CcgSettingsCcg;
}

额外注意事项 #

• 确保项目已引用System.Configuration程序集（右键项目→添加引用→框架→找到System.Configuration）
• 配置文件中的元素名称和配置类的ConfigurationProperty名称大小写敏感，必须完全一致
• 如果是.NET Core/.NET 5+项目，建议使用Microsoft.Extensions.Configuration替代ConfigurationManager，但你的代码看起来是.NET Framework，无需改动

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