在 .NET 应用程序中读取 appsettings.json 中的配置信息,主要依赖于 IConfiguration 接口。以下是具体实现步骤和常用方法。
1. 确保 appsettings.json 正确配置
首先,在项目根目录下创建或确认存在 appsettings.json 文件,并设置“复制到输出目录”为“如果较新则复制”。示例内容如下:
{
"ConnectionStrings": {
"DefaultConnection": "Server=localhost;Database=MyDb;Trusted_Connection=true"
},
"AppSettings": {
"SiteName": "My Website",
"PageSize": 20
},
"Logging": {
"LogLevel": {
"Default": "Information"
}
}
}
2. 在 Program.cs 或 Startup 中注入配置服务
.NET 6 及以上版本使用最小 API 模式,Program.cs 自动构建配置。你无需手动加载,IConfiguration 已经可用。
例如:
var builder = WebApplication.CreateBuilder(args);
// 直接通过 builder.Configuration 使用配置
var connectionString = builder.Configuration.GetConnectionString("DefaultConnection");
var siteName = builder.Configuration["AppSettings:SiteName"];
var app = builder.Build();
如果你使用的是早期版本(如 .NET Core 3.1),在 Startup.cs 的构造函数中接收 IConfiguration 实例:
public class Startup
{
public IConfiguration Configuration { get; }
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
}
3. 读取配置值的常用方式
你可以通过多种方式从 IConfiguration 获取值:
获取连接字符串:string conn = Configuration.GetConnectionString("DefaultConnection");
通过冒号分隔键读取层级配置:string name = Configuration["AppSettings:SiteName"];
int pageSize = int.Parse(Configuration["AppSettings:PageSize"]);绑定到强类型对象:
创建一个类来映射配置结构:
public class AppSettings
{
public string SiteName { get; set; }
public int PageSize { get; set; }
}
然后在 Program.cs 或 Startup.cs 中绑定:
builder.Services.Configure<AppSettings>(builder.Configuration.GetSection("AppSettings"));
在控制器或其他服务中通过 IOptions
public class HomeController : Controller
{
private readonly AppSettings _appSettings;
public HomeController(IOptions<AppSettings> appSettings)
{
_appSettings = appSettings.Value;
}
public IActionResult Index()
{
ViewBag.SiteName = _appSettings.SiteName;
return View();
}
}
