C# 如何读取应用程序的配置文件 - ConfigurationManager vs IConfiguration

答案:.NET Framework 用 ConfigurationManager 读 XML 配置,.NET Core+ 用 IConfiguration 支持多源配置。1. ConfigurationManager 仅适用于 .NET Framework,依赖 app.config/web.config,读取 XML 格式,不支持 DI 和现代配置源;2. IConfiguration 是 .NET Core+ 的统一配置模型,支持 appsettings.json、环境变量等多源、分层配置,可绑定 POCO 类并集成 DI;3. 两者不可混用,新项目必须用 IConfiguration,旧项目升级需迁移配置文件并替换 API。选错导致编译或运行失败。

在 C# 中读取应用程序配置文件,核心区别在于项目类型和所用框架:.NET Framework 传统项目多用 ConfigurationManager,而 .NET Core / .NET 5+ 推荐使用 IConfiguration。两者不是替代关系,而是不同生态下的设计产物,选错会导致编译失败或运行时异常。

ConfigurationManager:仅适用于 .NET Framework

System.Configuration.ConfigurationManager 是 .NET Framework 的经典配置 API,依赖 app.config(桌面应用)或 web.config(ASP.NET Web Forms / MVC)。它直接读取 XML 格式配置节,如 或自定义配置节。

  • 需引用 System.Configuration 程序集(NuGet 包已废弃,仅 Framework 自带)
  • 配置文件必须命名为 app.config(编译后自动复制为 [AppName].exe.config
  • 读取示例:ConfigurationManager.AppSettings["ApiUrl"]
  • 不支持 JSON、环境变量、命令行参数等现代配置源,扩展性差

IConfiguration:.NET Core 及以后的统一配置模型

IConfiguration 是 .NET Core 引入的抽象接口,背后由 ConfigurationBuilder 构建,支持多源、分层、可重载的配置系统。默认支持 appsettings.json、环境变量、命令行、内存对象等。

  • 需通过 Host.CreateDefaultBuilder() 或手动构建 ConfigurationBuilder
  • 典型配置文件是 appsettings.json,也可添加 appsettings.Development.json 实现环境区分
  • 读取方式更结构化:configuration.GetValue("ConnectionStrings:Default") 或绑定到 POCO 类
  • 天然支持依赖注入——服务中直接注入 IConfiguration 实例即可使用

不能混用,也不能强行迁移

在 .NET 6+ 项目里引用 System.Configuration 并调用 ConfigurationManager 会失败(除非启用兼容包 System.Configuration.ConfigurationManager NuGet,但仅限基础 appSettings 支持,且不推荐)。

  • 新项目一律用 IConfiguration,哪怕只是读一个字符串
  • 老项目升级到 .NET Core/.NET 5+ 时,应将 app.config 迁移为 appsettings.json,并改用 IConfiguration
  • 若必须保留 XML 配置,可用 AddXmlFile() 扩展方法把 app.config 当作普通 XML 配置源加载(需自行处理路径和命名)

简单对比速查

ConfigurationManager → 旧式、XML-only、无 DI 集成、仅 Framework。
IConfiguration → 新式、多源、分层键、强类型绑定、深度集成 DI 和 Host 生命周期。

基本上就这些。选对 API,比写对代码还重要。