C#的配置系统是什么?如何读取appsettings.json中的设置?

首先通过ConfigurationBuilder加载appsettings.json文件并构建IConfiguration实例,接着可直接读取配置值或使用IOptions模式实现强类型绑定,适用于.NET 6+控制台或ASP.NET Core应用。

C# 的配置系统是 .NET 提供的一套灵活、可扩展的机制,用于管理应用程序的配置数据。它支持多种配置源,比如 JSON 文件(如 appsettings.json)、环境变量、命令行参数、内存中的集合等,并能将这些来源的配置统一加载到一个 IConfiguration 接口中,供程序使用。

配置系统核心组件

IConfiguration 是主要接口,通过它可以读取任意层级的配置项。配置通常在程序启动时由 ConfigurationBuilder 构建,按优先级合并多个来源。

如何读取 appsettings.json 中的设置

以 ASP.NET Core 或普通 .NET 6+ 控制台应用为例,基本步骤如下:

1. 确保 appsettings.json 文件存在并正确配置

在项目根目录添加 appsettings.json,并设置“复制到输出目录”为“如果较新则复制”:

{ "ConnectionStrings": { "DefaultDb": "Server=localhost;Database=MyApp;Trusted_Connection=true" }, "Logging": { "LogLevel": { "Default": "Information" } }, "AppSettings": { "SiteName": "My Website", "PageSize": 10 } }

2. 安装必要 NuGet 包(控制台应用需要)

如果是控制台应用,需安装:

  • Microsoft.Extensions.Configuration
  • Microsoft.Extensions.Configuration.Json

3. 使用 ConfigurationBuilder 加载配置

示例代码:

using Microsoft.Extensions.Configuration;

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

IConfiguration config = builder.Build();

// 读取简单值 string siteName = config["AppSettings:SiteName"]; int pageSize = int.Parse(config["AppSettings:PageSize"]);

// 读取连接字符串 string connectionString = config.GetConnectionString("DefaultDb"); // 或等价写法:config["ConnectionStrings:DefaultDb"]

Console.WriteLine($"站点名称: {siteName}"); Console.WriteLine($"分页大小: {pageSize}"); Console.WriteLine($"数据库连接: {connectionString}");

4. 使用强类型配置(推荐方式)

定义一个 POCO 类:

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

注册并绑定配置(在控制台或 ASP.NET Core Program.cs 中):

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

在服务中注入 IOptions 使用:

public class MyService { private readonly AppSettings _appSettings;
public MyService(IOptions options)
{
    _appSettings = options.Value;
}

public void PrintSettings()
{
    Console.WriteLine($"站点名: {_appSettings.SiteName}, 大小: {_appSettings.PageSize}");
}

}

基本上就这些。配置系统设计得足够通用,无论是 Web 还是后台服务都能方便使用。关键是通过 ConfigurationBuilder 构建 IConfiguration 实例,然后按需读取。