.NET如何读取appsettings.json中的配置信息_appsettings.json配置读取方法

.NET 项目中读取 appsettings.json 配置信息是开发中的常见需求，尤其是在 ASP.NET Core 或 .NET 6+ 的控制台应用中。正确加载和使用配置能提升项目的可维护性和灵活性。

appsettings.json 文件结构

在项目根目录下创建 appsettings.json 文件，内容通常如下：

<font face="Courier New">
{
  "ConnectionStrings": {
    "DefaultConnection": "Server=localhost;Database=MyDb;Trusted_Connection=true;"
  },
  "AppSettings": {
    "SiteName": "My Website",
    "PageSize": 10
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information"
    }
  }
}
</font>

确保该文件的“复制到输出目录”属性设置为“始终复制”或“如果较新则复制”。

使用 IConfiguration 读取配置

在 .NET 中推荐使用 IConfiguration 接口来读取配置，它由内置依赖注入容器提供。

例如，在 ASP.NET Core 的控制器中使用：

IConfiguration

GetSection

<font face="Courier New">
public class HomeController : Controller
{
    private readonly IConfiguration _configuration;
<pre class='brush:php;toolbar:false;'>public HomeController(IConfiguration configuration)
{
    _configuration = configuration;
}
public IActionResult Index()
{
    var siteName = _configuration["AppSettings:SiteName"];
    var pageSize = _configuration.GetValue<int>("AppSettings:PageSize");
    return View();
}

}

绑定配置到强类型对象

更优雅的方式是将配置节映射为一个 C# 类。

定义类：

<font face="Courier New">
public class AppSettings
{
    public string SiteName { get; set; }
    public int PageSize { get; set; }
}
</font>

在

Program.cs

Startup.cs

<font face="Courier New">
// 在 Program.cs (.NET 6+)
builder.Services.Configure<AppSettings>(builder.Configuration.GetSection("AppSettings"));
</font>

然后在需要的地方通过

IOptions<t></t>

<font face="Courier New">
public class SomeService
{
    private readonly AppSettings _appSettings;
<pre class='brush:php;toolbar:false;'>public SomeService(IOptions<AppSettings> options)
{
    _appSettings = options.Value;
}
public void DoWork()
{
    Console.WriteLine(_appSettings.SiteName);
}

}

在非注入上下文中读取配置

某些场景如静态方法或早期初始化阶段无法使用 DI，可手动构建 ConfigurationBuilder：

<font face="Courier New">
var configuration = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
    .Build();
<p>var connectionString = configuration.GetConnectionString("DefaultConnection");
var siteName = configuration["AppSettings:SiteName"];
</font>

这种方式适合控制台应用或单元测试环境。

基本上就这些。只要配置文件路径正确、结构清晰，并合理使用 IConfiguration 或 IOptions 模式，就能稳定读取 appsettings.json 中的内容。