讲师中心 微信公众号
AI工具推荐 视频效率加速

C#怎么读取配置文件_C# appsettings.json配置读取教程【实战】

陌芳君_7858

陌芳君_7858

发布时间:2026-04-13 16:17:01

|

463人浏览过

|

来源于php中文网

原创

必须通过 IConfiguration 加载 appsettings.json,而非 File.ReadAllText 或 JsonSerializer.Deserialize,否则无法支持环境区分、层级映射、类型转换、热重载及多源合并;正确方式是用 ConfigurationBuilder.AddJsonFile 并配合 IOptionsMonitor 实现配置热更新。

c#怎么读取配置文件_c# appsettings.json配置读取教程【实战】

直接读取 appsettings.json 不能靠 File.ReadAllText 硬解析——它需要被 IConfiguration 实例加载并绑定,否则你拿不到环境区分、层级展开、类型转换和重载刷新能力。

为什么 ConfigurationBuilder 必须调用 AddJsonFile 而不是手动反序列化?

手动用 JsonSerializer.Deserialize 读取 appsettings.json 只能得到原始 JSON 对象,无法支持:

  • appsettings.Development.json 的自动覆盖逻辑
  • Logging:LogLevel:Default 这种冒号分隔的层级键自动映射到 C# 层级对象
  • IOptionsMonitor<t></t> 的热重载(修改文件后自动更新)
  • 环境变量、命令行参数等其他源的合并优先级控制

正确做法是让 ConfigurationBuilder 统一接管:

var config = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
    .AddJsonFile($"appsettings.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT") ?? "Production"}.json", 
                  optional: true, reloadOnChange: true)
    .Build();

IConfiguration 和 IOptions<t></t> 该选哪个?

直接用 IConfiguration 适合简单场景(如读一个连接字符串),但容易出错;IOptions<t></t> 更安全、可测试、支持验证。区别如下:

  • IConfiguration["ConnectionStrings:Default"] → 返回 string,拼错键名或类型不匹配时运行时报错
  • IOptions<appsettings>.Value.DatabaseTimeout</appsettings> → 编译期检查字段存在性,启动时校验类型和必需项
  • 若需响应配置变更,必须用 IOptionsMonitor<t></t>,IOptionsSnapshot<t></t> 只在作用域内快照一次

注册示例(.NET 6+ Program.cs):

arcgis-js
arcgis-js

提供 ArcGIS Maps SDK for JavaScript 开发辅助,涵盖 2D/3D 地图视图、图层管理、数据可视化、空间分析等功能模块的参考和示例指导。

下载
builder.Services.Configure<AppSettings>(builder.Configuration.GetSection("AppSettings"));
// 或启用热重载
builder.Services.ConfigureMonitor<AppSettings>(builder.Configuration.GetSection("AppSettings"));

读取嵌套对象或数组时常见的 key 写法错误

JSON 中的数组和对象在 IConfiguration 里统一转为扁平 key,冒号是层级分隔符,索引用方括号——但不能写成 MyList[0].Name,而要写成 MyList:0:Name:

{
  "Features": {
    "Enabled": true,
    "Modules": [ { "Name": "Auth", "Version": "2.1" } ]
  }
}

对应读取方式:

  • config.GetValue<bool>("Features:Enabled")</bool> ✅
  • config.GetSection("Features:Modules:0").GetValue<string>("Name")</string> ✅(注意是 :0,不是 [0])
  • config.GetSection("Features:Modules").Get<list>>()</list> ✅(需类定义 + Get<t></t>)
  • config["Features:Modules[0]:Name"] ❌ 不识别方括号语法

部署时 appsettings.json 文件找不到或没生效?检查这三点

常见原因不是代码问题,而是发布/部署细节遗漏:

  • 确保 .csproj 中包含:<content include="appsettings*.json" copytooutputdirectory="PreserveNewest"></content>
  • Linux 容器中路径大小写敏感:AppSettings.json ≠ appsettings.json,文件名必须全小写
  • reloadOnChange: true 在 IIS 或某些托管服务中无效(文件系统通知被禁用),此时修改配置需重启应用

最稳妥的调试方式:启动后立刻打印 config.AsEnumerable() 查看实际加载了哪些键值对,比猜路径更直接。

热门AI工具

更多
花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

1092

2023.08.08

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

3211

2023.08.31

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

905

2024.03.13

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2655

2024.03.14

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

332

2026.02.03

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

429

2026.02.06

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

631

2026.03.11

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

329

2026.04.13

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

100

2026.10.28

热门下载

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

精品课程

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

共101课时 | 21.3万人学习

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

共39课时 | 4.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn