c#如何读取appsettings.json_c#读取appsettings.json新手必看入门教程

小明吖_3163

小明吖_3163

2026-04-23

978人浏览

原创

根本原因是 iconfiguration 未正确加载 appsettings.json:手动构建 configurationbuilder 时漏掉 addjsonfile,或路径/环境变量配置错误导致文件未加载。

c#如何读取appsettings.json_c#读取appsettings.json新手必看入门教程

为什么 Configuration.GetSection("xxx") 返回 null?

不是配置写错了,大概率是没把 appsettings.json 正确加载进 IConfiguration。.NET 6+ 默认模板会自动调用 Host.CreateDefaultBuilder(),它内部已注册 appsettings.json 和 appsettings.{Environment}.json,但如果你手动构建 ConfigurationBuilder(比如在单元测试或控制台工具里),必须显式加:

var config = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
    .Build();

漏掉 AddJsonFile 这一行,所有读取都返回 null 或默认值。

常见坑:

  • optional: false 表示文件必须存在,设为 true 时即使文件缺失也不报错,但后续读不到配置——容易误以为“读取成功”
  • reloadOnChange: true 在开发期有用,但发布到 IIS 或 Linux 容器时,文件权限或监视机制可能失效,别依赖它自动刷新
  • 路径用 Directory.GetCurrentDirectory() 不一定对:ASP.NET Core Web 项目默认工作目录是项目根,但控制台或类库中可能是 bin 输出目录,建议用 AppContext.BaseDirectory 更稳

怎么安全读取嵌套对象(比如数据库连接字符串)?

别直接用 config["ConnectionStrings:Default"] 拼字符串键——大小写、冒号、空格一错就静默失败。推荐用强类型绑定:

public class DatabaseOptions
{
    public string ConnectionString { get; set; } = string.Empty;
    public int TimeoutSeconds { get; set; } = 30;
}

然后在 Program.cs 注册:

builder.Services.Configure<databaseoptions>(builder.Configuration.GetSection("Database"));</databaseoptions>

使用时通过 IOptions<databaseoptions></databaseoptions> 或 IOptionsSnapshot<databaseoptions></databaseoptions> 注入。注意:

wechat-article-extraction-mp-weixin-qq-com news-webpage-cleaning blog-post-parsing metadata-extraction-title-author-date multiple-output-formats-markdown-json-plain-text batch-processing-support
wechat-article-extraction-mp-weixin-qq-com news-webpage-cleaning blog-post-parsing metadata-extraction-title-author-date multiple-output-formats-markdown-json-plain-text batch-processing-support

基于三引擎设计,从微信文章、新闻和博客网页提取干净内容,支持标题作者日期元数据,多格式和批量处理。

下载
  • IOptions 是单例,启动后不再响应 appsettings.json 文件变更;IOptionsSnapshot 每次请求新建实例,支持热重载(但仅限 reloadOnChange: true 且文件实际被修改时)
  • 如果配置节不存在(比如 "Database" 根本没写),GetSection 返回非 null 的空节,绑定后对象字段全是默认值——不会抛异常,得自己校验 string.IsNullOrEmpty(options.ConnectionString)
  • 不推荐用 ConfigurationBinder.Bind() 手动绑定,它绕过 DI 生命周期,也难测

GetValue<t>()</t> 和 GetSection().Get<t>()</t> 有什么区别?

前者读单个原始值(如字符串、数字、布尔),后者读整个对象结构。例如:

// appsettings.json 中:
// "LogLevel": "Warning"
// "Features": { "EnableCache": true, "MaxRetries": 3 }
<p>var level = config.GetValue<string>("LogLevel"); // OK,返回 "Warning"
var features = config.GetSection("Features").Get<features>(); // OK,返回新对象</features></string></p>

关键差异:

  • GetValue<t>()</t> 要求键路径精确匹配一个 JSON 值,不能指向对象或数组,否则返回 default(T) 且无提示
  • GetSection("x").Get<t>()</t> 要求 T 是 class 或 record,且属性名需与 JSON 字段名匹配(默认忽略大小写,但建议保持 camelCase 一致)
  • 两者都不支持自动转换枚举:如果 JSON 写 "Status": "Active",而 C# 属性是 Status { get; set; } = StatusEnum.Inactive,绑定后仍是默认值,不会解析字符串为枚举项

环境配置(appsettings.Development.json)为啥不生效?

核心只看一个值:DOTNET_ENVIRONMENT 环境变量(或 ASPNETCORE_ENVIRONMENT,后者仅 ASP.NET Core 有效)。它决定了 CreateDefaultBuilder() 加载哪个 appsettings.{env}.json。

验证方法:在代码里打日志

Console.WriteLine($"Env: {Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT")}");

常见问题:

  • VS 调试时没设环境变量——右键项目 → “属性” → “调试” → “环境变量” 添加 DOTNET_ENVIRONMENT=Development
  • Docker 运行时忘记传:启动容器要加 -e DOTNET_ENVIRONMENT=Production
  • 代码里硬编码了 Environment.SetEnvironmentVariable(),但它只影响当前进程,且必须在 Host.CreateDefaultBuilder() 之前调用才有效
  • appsettings.Development.json 的优先级高于 appsettings.json,但低于命令行参数和环境变量——如果命令行传了 --Logging__LogLevel__Default=Debug,它会覆盖 JSON 里的设置

多环境配置最易被忽略的点:不同环境的配置节结构最好保持一致。比如 Development 里写了 "Cache": { "Enabled": true },Production 却删了整个 "Cache" 节,那绑定到对象时该字段就是默认值,运行时才暴露问题。

相关专题

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

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

2023.08.08

952

5

什么是c#
什么是c#

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

2023.08.31

2711

3

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

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

2024.03.13

865

8

C#Task用法
C#Task用法

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

2024.03.14

2615

11

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

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

2026.02.03

292

18

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

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

2026.02.06

389

20

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

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

2026.03.11

611

24

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

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

2026.04.13

309

20

json数据格式
json数据格式

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

2023.08.07

2055

5

热门下载

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

精品课程

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

共101课时 | 20.9万人学习

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

共39课时 | 4.8万人学习