0

0

C# 如何配置和读取appsettings.json - .NET Core配置系统详解

星降

星降

发布时间:2025-12-12 20:23:56

|

664人浏览过

|

来源于php中文网

原创

.NET Core及后续版本默认使用appsettings.json作为配置源,通过IConfiguration接口自动加载、合并多源配置,并支持环境变量覆盖;推荐绑定强类型对象或使用IOptionsMonitor实现热重载。

c# 如何配置和读取appsettings.json - .net core配置系统详解

在 .NET Core 及后续版本(.NET 5+)中,appsettings.json 是默认推荐的配置源,它通过统一的 IConfiguration 接口被读取和管理。配置不是“手动解析 JSON”,而是由 配置提供程序(Configuration Providers) 自动加载、合并、分层,并支持环境变量、命令行参数等多源叠加。

配置文件结构与约定

appsettings.json 是标准 JSON 格式,支持嵌套对象和数组。框架按层级自动映射为冒号分隔的键(如 "Logging:LogLevel:Default")。常见结构如下:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "ConnectionStrings": {
    "DefaultConnection": "Server=.;Database=MyApp;Trusted_Connection=true;"
  },
  "AppSettings": {
    "SiteName": "My Site",
    "PageSize": 20
  }
}

注意:文件名不重要,但必须在 Program.cs 中显式添加对应提供程序appsettings.Development.json 等环境变体需配合 IWebHostEnvironment.EnvironmentName 自动加载。

在 Program.cs 中注册配置源

.NET 6+ 使用最小托管模型,配置构建在 Host.CreateDefaultBuilder() 或手动 Host.CreateApplicationBuilder() 中完成。默认已包含 appsettings.json 和环境变体,但可自定义:

  • 确保 appsettings.json“复制到输出目录”属性设为“始终复制”(否则运行时找不到)
  • 若需额外 JSON 文件(如 secrets.json),用 builder.Configuration.AddJsonFile("custom.json", optional: true)
  • 环境变量优先级高于 JSON,可用于覆盖敏感值(如连接字符串)

示例(.NET 7+):

var builder = Host.CreateApplicationBuilder(args);
// 默认已加载 appsettings.json + appsettings.{Environment}.json
// 如需额外文件:
builder.Configuration.AddJsonFile("appsettings.extra.json", optional: true);

读取配置的三种常用方式

1. 直接通过 IConfiguration 读取(适合简单值)
注入 IConfiguration,用索引器或 GetValue 获取:

var connectionString = configuration["ConnectionStrings:DefaultConnection"];
var pageSize = configuration.GetValue("AppSettings:PageSize");
var siteName = configuration.GetValue("AppSettings:SiteName");

2. 绑定到强类型对象(推荐用于结构化配置)
定义 POCO 类(字段/属性名需与 JSON 键路径匹配):

Vinteo AI
Vinteo AI

利用人工智能在逼真的室内环境中创建产品可视化。无需设计师和产品照片拍摄

下载

public class AppSettings
{
  public string SiteName { get; set; } = string.Empty;
  public int PageSize { get; set; }
}

Program.cs 注册绑定:

builder.Services.Configure(builder.Configuration.GetSection("AppSettings"));

使用时注入 IOptionsIOptionsSnapshot(后者支持重载):

var settings = options.Value.SiteName; // 或 options.Value.PageSize

3. 使用 IOptionsMonitor 响应配置热重载(如开发时修改 JSON 实时生效)
适用于需要监听变更的场景(如日志级别动态调整):

builder.Services.Configure(builder.Configuration.GetSection("Logging"));
// 在服务中注入 IOptionsMonitor 即可订阅 OnChange

关键细节与避坑提示

  • GetSection("AppSettings") 返回的是子配置节,不是深拷贝,仍依赖原始 IConfiguration 的生命周期
  • 配置键名**不区分大小写**(JSON 本身是小写,但 configuration["AppSettings:SiteName"]["appsettings:sitename"] 都有效)
  • 数组无法直接绑定到 List,需用 Get()GetChildren() 手动遍历
  • 若配置缺失,GetValue() 返回 default(T)GetSection().Get() 返回 null(引用类型)或抛异常(值类型未设默认值时)
  • 生产环境慎用 appsettings.json 存密钥——改用 Azure Key Vault、User Secrets(仅开发)或环境变量

基本上就这些。配置系统设计得足够灵活,但核心逻辑很清晰:加载 → 合并 → 绑定 → 使用。不需要手写 JSON 解析器,也不必操心线程安全——IConfiguration 是线程安全的只读快照。

相关专题

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

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

412

2023.08.07

json是什么
json是什么

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

533

2023.08.23

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

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

310

2023.10.13

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

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

75

2025.09.10

string转int
string转int

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

318

2023.08.02

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

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

232

2023.09.22

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

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

436

2024.03.01

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

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

258

2023.08.03

PS使用蒙版相关教程
PS使用蒙版相关教程

本专题整合了ps使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

23

2026.01.19

热门下载

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

精品课程

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

共101课时 | 8.4万人学习

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

共39课时 | 3.2万人学习

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

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