.NET Core 6+中IConfiguration默认注入,旧版需确保AddControllers;appsettings.json须设为“复制到输出目录”,自定义路径需显式AddJsonFile;推荐IOptions绑定强类型配置并用IOptionsMonitor支持热重载。

Startup.cs 或 Program.cs 中注入 IConfiguration
在 .NET Core 6+(Minimal Hosting Model)中,IConfiguration 默认已注册并可直接注入;旧版(.NET Core 3.1/5)需确认 Startup.ConfigureServices 中调用了 services.AddControllers() 或类似方法,它会自动添加配置服务。
常见错误:直接 new 一个 ConfigurationBuilder 却没调用 AddJsonFile("appsettings.json"),导致读不到值;或路径写错(比如漏掉 CopyToOutputDirectory 设置,导致运行时找不到文件)。
-
appsettings.json文件属性必须设为「复制到输出目录:如果较新则复制」 - 若使用自定义路径(如
config/appsettings.prod.json),需显式调用.AddJsonFile("config/appsettings.prod.json", optional: true) - 环境变量(如
ASPNETCORE_ENVIRONMENT=Production)会影响是否加载appsettings.Production.json
通过 IOptions 绑定强类型配置
比手动调用 configuration["Section:Key"] 更安全、可测试、支持热重载。适用于结构清晰、复用频繁的配置块(如数据库连接字符串、第三方 API 参数)。
容易踩的坑:忘记在 Program.cs 中调用 services.Configure,导致依赖注入失败;或者类字段名与 JSON 键名不一致且未加 [ConfigurationKeyName("xxx")] 特性。
- 配置类字段必须是 public set 属性,不能是字段(
public string Url;不生效) - 嵌套对象支持自动映射(如
"Logging": { "Level": "Information" }→public LoggingSettings Logging { get; set; }) - 若需热重载(修改 JSON 后自动更新),确保使用
IOptionsMonitor而非IOptions
在普通类(非 Controller/Service)中读取配置
普通类(如工具类、静态帮助器)没有构造函数注入能力时,不能直接依赖 IConfiguration。硬编码路径(如 new ConfigurationBuilder().AddJsonFile(...))会导致重复加载、忽略环境配置、丢失热重载能力。
正确做法是:把配置项作为参数传入,或通过工厂模式解耦。例如,将 IConfiguration 注入到宿主类,再提取所需值传给工具类。
- 避免在静态方法里直接读
ConfigurationManager.AppSettings(那是 .NET Framework 的老方式,.NET Core 不适用) - 不要在类内部 new
ConfigurationBuilder—— 它不共享IWebHostEnvironment,无法识别appsettings.{Environment}.json - 若真需全局访问,可用
Microsoft.Extensions.Options.IOptionsSnapshot,但它仍需注入,不是“全局静态变量”
读取数组或对象列表配置
JSON 中的数组(如 "Features": ["A", "B"])可绑定到 string[] 或 List;对象数组(如 "Endpoints": [{ "Url": "a.com" }, { "Url": "b.com" }])需对应 List 类型。
关键点在于键名匹配和类型兼容性。常见错误是数组元素缺少无参构造函数,或属性名大小写不一致(JSON 默认区分大小写,除非配置了 ConfigureJsonOptions)。
- 使用
configuration.GetSection("Endpoints").Get是推荐方式- >()
- 若用
configuration["Endpoints:0:Url"]手动索引,注意冒号分隔符和从 0 开始计数 - 空数组或缺失节时,
Get返回 null,建议配合 null 合并操作符:() configuration.GetSection("Features").Get() ?? Array.Empty ()










