0

0

C# 配置文件读取方法 C#如何读取appsettings.json

幻夢星雲

幻夢星雲

发布时间:2026-02-07 02:05:17

|

317人浏览过

|

来源于php中文网

原创

appsettings.json 默认不会自动加载,需显式构建 IConfiguration 实例并注册;控制台或类库项目必须手动调用 ConfigurationBuilder.AddJsonFile;读取嵌套对象须用 GetSection().Get(),而非 GetValue();环境配置文件需手动指定且大小写敏感。

c# 配置文件读取方法 c#如何读取appsettings.json

appsettings.json 默认不被 C# 项目自动加载

新建的 .NET Core 或 .NET 5+ 项目默认会包含 appsettings.json,但它不会“自动生效”——你得显式构建 IConfiguration 实例并注册它。控制台、类库、甚至某些 ASP.NET Core 模块(如中间件外的静态方法)里直接用 Configuration["Key"] 会返回 null,因为没初始化配置源。

常见错误现象:Configuration.GetSection("Logging").GetChildren() 返回空集合;Configuration.GetValue("Timeout") 始终是 0;读取不到自定义节内容。

  • ASP.NET Core Web 项目:通常在 Program.cs 中通过 WebApplication.CreateBuilder(args) 自动完成配置加载,无需手动干预
  • 控制台或类库项目:必须自己调用 ConfigurationBuilder 并添加 .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
  • reloadOnChange: true 仅在文件系统支持热重载的环境(如开发时的 Kestrel + dotnet watch)下有效,发布后不生效

读取嵌套对象需用 Get() 而非 GetValue()

GetValue() 只适用于扁平键(如 "ConnectionStrings:Default"),遇到对象结构(如 "Features:EnableCache" 或整个 "Features" 节)必须用 GetSection().Get(),否则返回默认值或抛异常。

例如,有如下 JSON:

{
  "Features": {
    "EnableCache": true,
    "MaxRetries": 3
  }
}

正确做法:

  • 读布尔值:config.GetSection("Features").GetValue("EnableCache")
  • 读整个对象:config.GetSection("Features").Get(),其中 FeaturesOptions 是含 public bool EnableCache { get; set; }public int MaxRetries { get; set; } 的类
  • 错误写法:config.GetValue("Features") —— 这会失败,因为 GetValue 不支持反序列化对象

环境配置文件(appsettings.Development.json)需手动指定环境名

appsettings.{Environment}.json 不会自动加载,除非你在 ConfigurationBuilder 中明确调用 .AddJsonFile($"appsettings.{env}.json", optional: true),且 env 值必须与当前运行时环境匹配。

爱AI工具库
爱AI工具库

爱AI工具库是一个实用的AI工具导航网站

下载

ASP.NET Core 项目中,IWebHostEnvironment.EnvironmentNameIHostEnvironment.EnvironmentName 决定加载哪个文件;但纯控制台程序没有内置环境变量,你得自己设置:

  • 方式一:设置环境变量 DOTNET_ENVIRONMENT=Development(Windows 下用 set DOTNET_ENVIRONMENT=Development
  • 方式二:代码中传入:var env = Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT") ?? "Production";,再拼接文件名
  • 注意:optional: true 很关键——否则缺失 appsettings.Development.json 时会抛 FileNotFoundException

配置键名大小写敏感,但 JSON 文件本身不区分

JSON 解析器不关心大小写,但 .NET 的 IConfiguration 键是**大小写敏感**的。如果你在 JSON 中写 "connectionstrings",而代码里读 Configuration.GetConnectionString("ConnectionStrings:Default"),就会返回 null

常见陷阱:

  • GetConnectionString() 方法内部会查找 "ConnectionStrings"(首字母大写)节,所以 JSON 中必须是 "ConnectionStrings": { ... },不能是 "connectionstrings"
  • 自定义节名建议统一 PascalCase,避免混用 ApiSettingsapiSettings
  • 调试时可用 config.AsEnumerable() 查看所有实际加载的键名,确认大小写是否一致

配置加载不是“放个 JSON 就能用”的事,最常出问题的地方其实是路径没设对、环境名没传进去、或者误用 GetValue 去反序列化对象。动手前先确认 IConfiguration 实例是否真的包含了你要的键。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

179

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

222

2025.12.18

json数据格式
json数据格式

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

430

2023.08.07

json是什么
json是什么

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

541

2023.08.23

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

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

313

2023.10.13

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

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

79

2025.09.10

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

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

240

2023.09.22

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

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

600

2024.03.01

Golang处理数据库错误教程合集
Golang处理数据库错误教程合集

本专题整合了Golang数据库错误处理方法、技巧、管理策略相关内容,阅读专题下面的文章了解更多详细内容。

2

2026.02.06

热门下载

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

精品课程

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

共101课时 | 8.9万人学习

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号