ASP.NET Core中的配置管理：环境变量、JSON文件等

开场白

大家好，欢迎来到今天的ASP.NET Core配置管理讲座。我是你们的讲师Qwen，今天我们要聊一聊ASP.NET Core中如何优雅地管理配置。配置管理听起来可能有点枯燥，但其实它就像给你的应用程序穿上一件合身的衣服，让它在不同的环境中都能表现得恰到好处。

在ASP.NET Core中，配置管理是一个非常灵活且强大的功能。你可以使用多种方式来定义和读取配置，比如环境变量、JSON文件、XML文件、命令行参数，甚至是自定义的配置提供程序。今天我们就重点聊聊环境变量和JSON文件这两种最常用的方式。

1. 环境变量：让配置随环境而变

什么是环境变量？

环境变量是操作系统提供的一种机制，允许你在不同的环境中设置不同的值。比如说，你可以在开发环境中使用一个数据库连接字符串，在生产环境中使用另一个。这样做的好处是，你不需要修改代码或配置文件，只需要改变环境变量的值即可。

在ASP.NET Core中，环境变量可以通过EnvironmentVariablesConfigurationProvider类来读取。这个类会自动将环境变量映射到应用程序的配置系统中。

如何使用环境变量？

假设我们有一个简单的ASP.NET Core应用程序，我们想根据环境变量来设置数据库连接字符串。首先，我们需要在appsettings.json文件中定义一个默认的连接字符串：

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=localhost;Database=MyApp;Trusted_Connection=True;"
  }
}

接下来，我们可以在Program.cs或Startup.cs中通过环境变量来覆盖这个默认值。ASP.NET Core会按照优先级顺序读取配置源，环境变量的优先级高于JSON文件，所以如果环境变量中有相同的键，它会覆盖JSON文件中的值。

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureAppConfiguration((hostingContext, config) =>
            {
                // 从环境变量中读取配置
                config.AddEnvironmentVariables(prefix: "MYAPP_");
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

在这个例子中，我们使用了AddEnvironmentVariables方法，并指定了一个前缀MYAPP_。这意味着所有以MYAPP_开头的环境变量都会被读取到配置系统中。例如，如果你在命令行中设置了以下环境变量：

export MYAPP_ConnectionStrings__DefaultConnection="Server=prod-db;Database=MyApp;User Id=admin;Password=secret;"

那么这个值就会覆盖appsettings.json中的默认连接字符串。

环境变量的命名规则

ASP.NET Core的配置系统支持层级结构的键名，因此你可以使用双下划线__来表示嵌套的键。例如，ConnectionStrings__DefaultConnection会被解析为ConnectionStrings:DefaultConnection。这种命名规则使得环境变量可以与JSON文件中的结构保持一致。

小结

环境变量非常适合用于那些需要根据不同环境（如开发、测试、生产）动态变化的配置项。它的优点是简单易用，缺点是不太适合存储复杂的配置结构。对于简单的键值对配置，环境变量是非常好的选择。

2. JSON文件：结构化的配置管理

为什么选择JSON文件？

JSON文件是一种轻量级的数据交换格式，易于阅读和编写。在ASP.NET Core中，JSON文件是最常用的配置文件格式之一。它不仅可以存储简单的键值对，还可以存储复杂的嵌套对象，非常适合用来管理应用程序的配置。

如何使用JSON文件？

ASP.NET Core默认支持JSON配置文件。你可以在项目中创建一个appsettings.json文件，并在其中定义应用程序的配置项。例如：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "DefaultConnection": "Server=localhost;Database=MyApp;Trusted_Connection=True;"
  },
  "AppSettings": {
    "ApiKey": "1234567890",
    "MaxUsers": 100
  }
}

在Program.cs或Startup.cs中，ASP.NET Core会自动加载这个文件并将其解析为配置对象。你还可以根据不同的环境加载不同的JSON文件。例如，appsettings.Development.json和appsettings.Production.json可以分别用于开发和生产环境。

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureAppConfiguration((hostingContext, config) =>
        {
            var env = hostingContext.HostingEnvironment;

            // 加载默认的配置文件
            config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);

            // 根据环境加载特定的配置文件
            config.AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: true);
        })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

在这个例子中，CreateDefaultBuilder方法已经为我们做了很多工作，它会自动加载appsettings.json和appsettings.{EnvironmentName}.json文件。我们只需要根据需要添加额外的配置源即可。

动态刷新配置

有时候，你可能希望在应用程序运行时动态更新配置。ASP.NET Core提供了IOptionsSnapshot和IOptionsMonitor接口来实现这一点。IOptionsSnapshot会在每次请求时重新加载配置，而IOptionsMonitor则会在配置发生变化时通知你。

例如，假设我们有一个AppSettings类来封装应用程序的配置：

public class AppSettings
{
    public string ApiKey { get; set; }
    public int MaxUsers { get; set; }
}

我们可以在Startup.cs中注册这个类，并使用IOptionsMonitor来监听配置的变化：

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<AppSettings>(Configuration.GetSection("AppSettings"));
    services.AddSingleton<IHostedService, ConfigurationChangeHandler>();
}

public class ConfigurationChangeHandler : IHostedService
{
    private readonly IOptionsMonitor<AppSettings> _appSettings;

    public ConfigurationChangeHandler(IOptionsMonitor<AppSettings> appSettings)
    {
        _appSettings = appSettings;
    }

    public Task StartAsync(CancellationToken cancellationToken)
    {
        _appSettings.OnChange(settings =>
        {
            Console.WriteLine($"API Key changed to: {settings.ApiKey}");
            Console.WriteLine($"Max Users changed to: {settings.MaxUsers}");
        });

        return Task.CompletedTask;
    }

    public Task StopAsync(CancellationToken cancellationToken) => Task.CompletedTask;
}

在这个例子中，每当appsettings.json中的AppSettings部分发生变化时，ConfigurationChangeHandler都会收到通知，并输出新的配置值。

小结

JSON文件是一种非常灵活且强大的配置管理方式，特别适合存储复杂的、结构化的配置数据。通过结合环境变量和JSON文件，你可以轻松实现不同环境下的配置管理。

3. 组合使用：环境变量 + JSON文件

在实际项目中，通常我们会同时使用环境变量和JSON文件来管理配置。JSON文件用于存储大多数配置项，而环境变量则用于覆盖那些需要根据环境变化的敏感信息（如数据库连接字符串、API密钥等）。

配置源的优先级

ASP.NET Core的配置系统遵循“后进先出”的原则，即后添加的配置源会覆盖之前添加的配置源。因此，如果你想让环境变量覆盖JSON文件中的配置，应该先加载JSON文件，再加载环境变量。

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureAppConfiguration((hostingContext, config) =>
        {
            // 先加载JSON文件
            config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);
            config.AddJsonFile($"appsettings.{hostingContext.HostingEnvironment.EnvironmentName}.json", optional: true, reloadOnChange: true);

            // 再加载环境变量
            config.AddEnvironmentVariables(prefix: "MYAPP_");
        })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

小结

通过组合使用环境变量和JSON文件，你可以实现更加灵活和安全的配置管理。JSON文件用于存储大多数配置项，而环境变量则用于覆盖那些需要根据环境变化的敏感信息。这种方式不仅提高了配置的可维护性，还增强了应用程序的安全性。

4. 总结与展望

今天我们学习了ASP.NET Core中的配置管理，特别是如何使用环境变量和JSON文件来管理应用程序的配置。环境变量适合用于简单的键值对配置，而JSON文件则更适合存储复杂的、结构化的配置数据。通过组合使用这两种方式，你可以轻松实现不同环境下的配置管理。

当然，ASP.NET Core的配置系统还有很多其他的功能和扩展，比如XML文件、命令行参数、Azure Key Vault等。这些高级功能可以帮助你在更复杂的场景下管理配置。不过，今天我们先说到这里，希望你能通过今天的讲座对ASP.NET Core的配置管理有更深的理解。

感谢大家的聆听，如果有任何问题，欢迎随时提问！