0

0

C#读取appsettings.json C# .NET Core如何获取配置项

星降

星降

发布时间:2026-02-12 12:07:03

|

281人浏览过

|

来源于php中文网

原创

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

c#读取appsettings.json c# .net core如何获取配置项

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(configuration.GetSection("MySettings")),导致依赖注入失败;或者类字段名与 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(...))会导致重复加载、忽略环境配置、丢失热重载能力。

飞桨PaddlePaddle
飞桨PaddlePaddle

飞桨PaddlePaddle开发者社区与布道,与社区共同进步

下载

正确做法是:把配置项作为参数传入,或通过工厂模式解耦。例如,将 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()
配置项解析看似简单,但实际项目中常因环境差异、热重载逻辑、嵌套层级和生命周期管理出问题。最易被忽略的是:**配置源的加载顺序影响最终值(命令行 > 环境变量 > appsettings.json > appsettings.{Environment}.json),以及 IOptionsMonitor 的回调时机并非实时——它只在首次访问和配置变更后触发更新**。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

436

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

544

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

317

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

688

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

243

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

685

2024.03.01

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

508

2023.08.03

2026春节习俗大全
2026春节习俗大全

本专题整合了2026春节习俗大全,阅读专题下面的文章了解更多详细内容。

189

2026.02.11

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 9.1万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号