.NET Core 中的配置管理：读取 appsettings.json

在.NET Core应用程序中，配置信息是一个重要的组成部分。这些配置可能包括数据库连接字符串、API密钥、功能开关以及其他各种设置。为了管理和访问这些配置，.NET Core 提供了一个灵活的配置系统，它允许我们从多个来源（如appsettings.json、环境变量、命令行参数等）读取配置信息。

本文将重点介绍如何从appsettings.json文件中读取配置，并提供相应的代码示例。

创建 appsettings.json 文件

首先，我们需要在项目的根目录下创建一个appsettings.json文件。这个文件通常包含应用程序的配置信息，如数据库连接字符串、API密钥等。以下是一个示例appsettings.json文件的内容：

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=localhost;Database=myapp;User Id=myuser;Password=mypassword;"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AppSettings": {
    "ApiKey": "MyApiKey",
    "FeatureFlag": true
  }
}

在.NET Core项目中读取配置

为了在.NET Core项目中读取这些配置，我们需要使用Microsoft.Extensions.Configuration命名空间下的类。通常，在程序启动时，我们会构建一个IConfiguration对象，并将其注入到依赖注入容器中，以便在整个应用程序中使用。

以下是在.NET Core Web应用程序中读取appsettings.json配置的步骤：

1. 安装必要的NuGet包（如果尚未安装）：

   dotnet add package Microsoft.Extensions.Configuration
   dotnet add package Microsoft.Extensions.Configuration.Json

2. 在 Program.cs 或 Startup.cs 中配置：

   在ASP.NET Core 3.0及以上版本中，配置通常在Program.cs文件中进行。以下是一个示例，展示如何在Program.cs中加载appsettings.json文件：

   using Microsoft.AspNetCore.Hosting;
   using Microsoft.Extensions.Configuration;
   using Microsoft.Extensions.Hosting;
   using System.IO;
   
   public class Program
   {
       public static void Main(string[] args)
       {
           IConfiguration configuration = new ConfigurationBuilder()
               .SetBasePath(Directory.GetCurrentDirectory())
               .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
               .Build();
           
           CreateHostBuilder(args, configuration).Build().Run();
       }
       
       public static IHostBuilder CreateHostBuilder(string[] args, IConfiguration configuration) =>
           Host.CreateDefaultBuilder(args)
               .ConfigureWebHostDefaults(webBuilder =>
               {
                   webBuilder.UseStartup<Startup>();
                   webBuilder.UseConfiguration(configuration);
               });
   }

   在Startup.cs中，你现在可以通过构造函数注入IConfiguration来使用配置：

   public class Startup
   {
       public Startup(IConfiguration configuration)
       {
           Configuration = configuration;
       }
   
       public IConfiguration Configuration { get; }
       
       // ... 省略其他代码 ...
   }

3. 在控制器或服务中使用配置：

   一旦你在Startup中有了IConfiguration的实例，你就可以在控制器或服务中通过依赖注入来使用它。以下是一个如何在控制器中读取配置的示例：

   using Microsoft.AspNetCore.Mvc;
   using Microsoft.Extensions.Configuration;
   
   public class MyController : ControllerBase
   {
       private readonly IConfiguration _configuration;
       
       public MyController(IConfiguration configuration)
       {
           _configuration = configuration;
       }
       
       [HttpGet]
       public IActionResult Get()
       {
           string connectionString = _configuration.GetConnectionString("DefaultConnection");
           string apiKey = _configuration["AppSettings:ApiKey"];
           bool featureFlag = bool.Parse(_configuration["AppSettings:FeatureFlag"]);
           
           // ... 使用这些配置值 ...
           
           return Ok();
       }
   }

注意事项：

• 确保appsettings.json文件的路径正确，并且其属性设置为“始终复制”或“如果较新则复制”，以确保它会被复制到输出目录中。

• 如果配置发生更改并且你想要在运行时重新加载配置，可以设置reloadOnChange: true参数（如上述代码所示）。但请注意，这仅适用于文件系统上的物理文件更改；对于从环境变量或命令行参数等来源读取的配置，这不会生效。

• 避免在代码中硬编码配置键。最好将它们定义为常量或配置类，以便于管理和重构。

• 当处理敏感信息（如密码或API密钥）时，请确保不要将这些信息直接存储在源代码或版本控制系统中。使用环境变量或安全的配置管理工具来存储这些信息。