C#怎么读取配置文件_C# appsettings.json节点获取方法【基础】

穿越時空

穿越時空

2026-05-01

129人浏览

原创

iconfiguration 是首选,因其默认注入且已自动加载多源配置、支持层级合并、类型转换与热更新;手动反序列化或 configurationbuilder 易绕过内置机制,导致环境配置失效或热重载失败。

c#怎么读取配置文件_c# appsettings.json节点获取方法【基础】

直接读取 appsettings.json 的节点,靠 IConfiguration 就够了,不需要手动反序列化或写 ConfigurationBuilder 链式调用——除非你有特殊加载路径或环境隔离需求。

为什么 IConfiguration 是首选?

ASP.NET Core 从 2.0 开始默认注入 IConfiguration 实例,它已自动加载 appsettings.jsonappsettings.{Environment}.json 和环境变量等,层级合并、类型转换、重载监听都内置好了。手写 JsonSerializer.DeserializeConfigurationBuilder.AddJsonFile() 反而容易绕过这些机制,导致环境配置不生效、热重载失效、或类型转换失败。

常见错误现象:IConfiguration.GetSection("Logging").GetChildren() 返回空集合 → 实际是节点名大小写不匹配(JSON 键名区分大小写,但 C# 属性名常首字母大写);或误用 GetValue<string>("Key")</string> 去读对象节点(该方法只适用于标量值)。

  • 使用场景:Web API、Worker Service、甚至控制台项目(只要用了 Host.CreateDefaultBuilder
  • 参数差异:GetSection("ConnectionStrings") 返回 IConfigurationSection,而 GetValue<int>("Timeout")</int> 直接转基础类型
  • 性能影响:无额外开销,IConfiguration 是只读快照,底层缓存键值对

appsettings.json 节点嵌套深时怎么安全取值?

深层嵌套(如 "Features:Auth:Enabled")不能用点号拼字符串硬写,一来易错,二来无法静态检查。推荐用 GetSection 链式调用 + GetValue 或绑定到 POCO。

php版微信js-sdk支付接口类
php版微信js-sdk支付接口类

php版微信js-sdk支付接口类

下载

示例配置:

{
  "Features": {
    "Auth": {
      "Enabled": true,
      "MaxRetries": 3
    }
  }
}

正确做法:

  • config.GetSection("Features:Auth").GetValue<bool>("Enabled")</bool> → 返回 true
  • config.GetSection("Features:Auth").Get<authoptions>()</authoptions>,其中 AuthOptions 是含 public bool Enabled { get; set; } 的类
  • 避免:config["Features:Auth:Enabled"] —— 返回 string,需手动 bool.Parse,且空值时抛异常

非 ASP.NET Core 项目(如传统 .NET Framework 控制台)怎么读?

没有 IConfiguration 注入时,必须手动构建 ConfigurationBuilder,但关键点是:路径要对、要调用 Build()、且 JSON 文件属性设为“复制到输出目录”。

  • 确保 appsettings.json 的“复制到输出目录”设为“始终复制”或“如果较新则复制”
  • 代码中写:var config = new ConfigurationBuilder().AddJsonFile("appsettings.json").Build();
  • 错误现象:System.IO.FileNotFoundException → 路径不对,或文件没复制过去;GetValue<t>()</t> 返回默认值 → 节点名拼错,或 JSON 中该字段为 null 且未设默认值
  • 兼容性注意:.NET Framework 需引用 Microsoft.Extensions.Configuration.Json NuGet 包(v3.1+ 支持 net461)

最易被忽略的是环境变量覆盖逻辑:即使 appsettings.json 里写了 "LogLevel": "Debug",若系统环境变量设置了 LOGLEVEL=Warning,最终生效的是后者——这在 Docker 容器或 CI 环境中特别容易踩坑。

相关专题

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

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

2023.08.08

529

5

什么是c#
什么是c#

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

2023.08.31

1181

3

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

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

2024.03.13

557

8

C#Task用法
C#Task用法

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

2024.03.14

1053

11

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

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

2026.02.03

149

18

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

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

2026.02.06

203

20

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

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

2026.03.11

526

24

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

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

2026.04.13

139

20

热门下载

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

精品课程

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

共101课时 | 18.8万人学习

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

共39课时 | 4.3万人学习