在.Net Core应用开发中，Json配置文件是存储应用配置信息的主要载体，比如数据库连接字符串、接口地址、业务参数等内容都可以放在Json配置文件中。掌握读取Json配置文件的方法，是开发.Net Core应用的基础技能。
基础读取方式：使用IConfiguration接口
.Net Core内置了配置系统，默认会自动加载appsettings.json文件，我们可以通过注入IConfiguration接口来读取配置内容。首先来看最基础的读取方式，假设我们的appsettings.json内容如下：
{
"AppSettings": {
"SiteName": "测试站点",
"MaxUploadSize": 1024,
"AllowedFileTypes": ["jpg", "png", "gif"]
},
"ConnectionStrings": {
"Default": "Server=localhost;Database=test;Uid=root;Pwd=123456;"
}
}
在控制器中注入IConfiguration后，可以通过键路径的方式读取对应的值：
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
namespace ConfigDemo.Controllers
{
[ApiController]
[Route("api/[controller]")]
public class ConfigController : ControllerBase
{
private readonly IConfiguration _configuration;
// 构造函数注入IConfiguration
public ConfigController(IConfiguration configuration)
{
_configuration = configuration;
}
[HttpGet("basic")]
public IActionResult GetBasicConfig()
{
// 读取单层配置
var siteName = _configuration["AppSettings:SiteName"];
// 读取数值类型配置，需要手动转换类型
var maxUploadSize = int.Parse(_configuration["AppSettings:MaxUploadSize"]);
// 读取数组配置
var fileType1 = _configuration["AppSettings:AllowedFileTypes:0"];
var fileType2 = _configuration["AppSettings:AllowedFileTypes:1"];
// 读取连接字符串
var connStr = _configuration.GetConnectionString("Default");
return Ok(new
{
SiteName = siteName,
MaxUploadSize = maxUploadSize,
FileTypes = new[] { fileType1, fileType2 },
ConnectionString = connStr
});
}
}
}
这种方式的优点是简单直接，不需要额外定义配置类，但是读取复杂配置时需要手动拼接键路径，类型转换也需要自己处理，容易出现错误。
强类型绑定：使用IOptions接口
如果配置内容结构比较固定，推荐使用强类型绑定的方式，先定义和Json结构对应的实体类，再通过IOptions接口获取配置，这样可以避免手动处理键路径和类型转换的问题。
第一步：定义配置实体类
实体类的属性名需要和Json中的键名保持一致，支持嵌套结构：
namespace ConfigDemo.Models
{
public class AppSettings
{
public string SiteName { get; set; }
public int MaxUploadSize { get; set; }
public List<string> AllowedFileTypes { get; set; }
}
public class ConnectionStrings
{
public string Default { get; set; }
}
// 根配置类，对应整个appsettings.json的结构
public class RootConfig
{
public AppSettings AppSettings { get; set; }
public ConnectionStrings ConnectionStrings { get; set; }
}
}
第二步：注册配置服务
在Program.cs中，通过Configure<T>方法将配置绑定到实体类：
var builder = WebApplication.CreateBuilder(args);
// 将AppSettings节点绑定到AppSettings类
builder.Services.Configure<AppSettings>(builder.Configuration.GetSection("AppSettings"));
// 将ConnectionStrings节点绑定到ConnectionStrings类
builder.Services.Configure<ConnectionStrings>(builder.Configuration.GetSection("ConnectionStrings"));
// 也可以直接绑定根配置
builder.Services.Configure<RootConfig>(builder.Configuration);
builder.Services.AddControllers();
var app = builder.Build();
app.UseAuthorization();
app.MapControllers();
app.Run();
第三步：注入IOptions获取配置
在需要使用的类中注入对应的IOptions对象，通过Value属性获取配置实例：
using ConfigDemo.Models;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Options;
namespace ConfigDemo.Controllers
{
[ApiController]
[Route("api/[controller]")]
public class StrongTypeController : ControllerBase
{
private readonly AppSettings _appSettings;
private readonly ConnectionStrings _connectionStrings;
// 注入IOptions<AppSettings>和IOptions<ConnectionStrings>
public StrongTypeController(
IOptions<AppSettings> appSettingsOptions,
IOptions<ConnectionStrings> connStrOptions)
{
_appSettings = appSettingsOptions.Value;
_connectionStrings = connStrOptions.Value;
}
[HttpGet("strong")]
public IActionResult GetStrongConfig()
{
return Ok(new
{
SiteName = _appSettings.SiteName,
MaxUploadSize = _appSettings.MaxUploadSize,
AllowedFileTypes = _appSettings.AllowedFileTypes,
ConnectionString = _connectionStrings.Default
});
}
}
}
IOptions绑定的配置默认是单例的，在应用启动时就完成绑定，后续不会感知配置文件的变更。如果需要支持配置文件热更新，可以使用IOptionsSnapshot或者IOptionsMonitor接口。
支持配置文件热更新
如果希望修改Json配置文件后，应用可以自动加载最新的配置，不需要重启应用，可以使用IOptionsSnapshot接口，它会在每个请求作用域内重新读取配置。修改注入的代码即可：
using ConfigDemo.Models;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Options;
namespace ConfigDemo.Controllers
{
[ApiController]
[Route("api/[controller]")]
public class HotReloadController : ControllerBase
{
private readonly AppSettings _appSettings;
// 注入IOptionsSnapshot<AppSettings>
public HotReloadController(IOptionsSnapshot<AppSettings> appSettingsOptions)
{
_appSettings = appSettingsOptions.Value;
}
[HttpGet("hot")]
public IActionResult GetHotConfig()
{
return Ok(new
{
SiteName = _appSettings.SiteName,
MaxUploadSize = _appSettings.MaxUploadSize
});
}
}
}
注意：IOptionsSnapshot的生命周期是作用域级的，每个请求会重新读取一次配置，适合大部分需要热更新的场景。如果是单例服务需要使用热更新配置，可以使用IOptionsMonitor接口，它提供了OnChange事件来监听配置变更。
读取自定义路径的Json配置文件
默认情况下.Net Core只会加载appsettings.json和对应环境的appsettings.Environment.json文件，如果需要读取其他路径的Json配置文件，可以在Program.cs中添加配置源：
var builder = WebApplication.CreateBuilder(args);
// 添加自定义路径的Json配置文件，optional表示文件不存在时不报错，reloadOnChange表示支持热更新
builder.Configuration.AddJsonFile("customConfig.json", optional: true, reloadOnChange: true);
builder.Services.AddControllers();
var app = builder.Build();
app.UseAuthorization();
app.MapControllers();
app.Run();
添加之后就可以像读取默认配置一样，通过IConfiguration读取customConfig.json中的内容了。
两种读取方式对比
我们可以通过下面的表格对比两种常用读取方式的特点：
| 读取方式 | 优点 | 缺点 | 适用场景 |
|---|---|---|---|
| IConfiguration直接读取 | 简单灵活，不需要定义实体类，适合临时读取零散配置 | 需要手动处理键路径和类型转换，容易出错，没有强类型提示 | 读取少量、结构简单的配置项 |
| IOptions强类型绑定 | 有强类型提示，不需要手动处理键路径和类型转换，代码更规范 | 需要提前定义实体类，配置结构变更时需要同步修改实体类 | 读取结构固定、内容较多的配置模块 |
在实际开发中，可以根据配置的结构和使用场景选择合适的读取方式，大部分情况下推荐使用IOptions强类型绑定的方式，代码的可维护性会更好。
.Net_CoreJson配置文件IConfigurationIOptions依赖注入修改时间：2026-07-13 16:33:45