.Net Core 5 控制台应用程序，在 Program.Main 中完成时不会为环境加载应用程序设置

Question

我希望我的 .Net Core 5 控制台应用程序根据 DOTNET_ENVIRONMENT 环境变量从相应的 appsettings 文件中选择设置。我正在通过在 Visual Studio 2019 调试器中运行它并从我的 launchSettings.json 文件中获取环境来对此进行测试。

在 .Net Core 5 控制台应用程序中，我有 4 个“appsettings”文件：

• appsettings.json
• appsettings.Development.json
• appsettings.Staging.json
• appsettings.Production.json

每个文件的属性都设置为 Build Action : Content 和 Copy to Output Directory: Copy if newer.

在我的 launchSettings.json 中，我将环境设置为“Staging”，如下所示：

 {
  "profiles": {
    "MyAppName": {
      "commandName": "Project",
      "dotnetRunMessages": "true",
      "environmentVariables": {
        "DOTNET_ENVIRONMENT": "Staging"
      }
    }
  }
}

我需要在 Program.cs 的“Main”方法中访问我的配置，因此在该类中，我在静态构造函数中设置了一个模块级字符串变量“_environment”：

_environment = Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT");

这行得通；值“Staging”被加载到变量 _environment。

然后我将我的配置加载到一个静态变量中，如下所示：（编辑——这是我的错误，假设这个静态属性在静态 ctor 之后加载。实际上它在静态 ctor 之前加载。这意味着 _environment 变量不是set，这意味着我的环境特定的 appsettings 文件从未加载）。

private static IConfiguration Configuration { get; } = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
    .AddJsonFile($"appsettings.{_environment}.json", optional: true, reloadOnChange: true)
    .AddEnvironmentVariables()
    .Build();

当我随后检查配置的内容时，我发现它只是从 appsettings.json 加载值。它没有从 appsettings.Staging.json 加载值。 我正在寻找的具体值是“ConnectionStrings”。这是 appsettings.json 中 ConnectionStrings 部分的外观：

"ConnectionStrings": {
    "ConnectionStringName": "Data Source=SqlDevelopment; Initial Catalog=MyTable; Integrated Security=SSPI;",
  }

这就是同一部分在 appsettings.Staging.json 中的外观：

"ConnectionStrings": {
    "ConnectionStringName": "Data Source=SqlStaging; Initial Catalog=MyTable; Integrated Security=SSPI;",
  }

但是当我从 Configuration 中读取 DataSource 时，它​​始终是“SqlDevelopment”，即使环境是 Staging。

尝试失败后，我尝试加载这4个Nuget包，但没有效果：

1. Microsoft.Extensions.Configuration
2. Microsoft.Extensions.Configuration.Binder
3. Microsoft.Extensions.Configuration.EnvironmentVariables
4. Microsoft.Extensions.Configuration.Json

我错过了什么？

Answer 1

控制台应用程序检查 DOTNET_ 环境变量，而不是 ASPNETCORE_ 变量。这不是一个新的变化。它至少可以追溯到 .NET Core 3.1。您需要改为设置DOTNET_ENVIRONMENT。

ASP.NET Core 应用程序使用除 DOTNET_ 变量之外的任何以 ASPNETCORE_ 为前缀的环境变量。

来自docs：

默认配置加载以 DOTNET_ 和 ASPNETCORE_ 为前缀的环境变量和命令行参数。 ASP.NET Core 将 DOTNET_ 和 ASPNETCORE_ 前缀用于主机和应用程序配置，但不用于用户配置。有关主机和应用配置的更多信息，请参阅 .NET 通用主机。

PS：就在 10 分钟前，我遇到了同样的问题，并意识到我设置了 DOTNETCORE_ENVIRONMENT 而不是 DOTNET_ENVIRONMENT

Answer 2

我需要在 Program.cs 的“Main”方法中访问我的配置，因此在该类中，我在静态构造函数中设置了一个模块级字符串变量“_environment”：

_environment = Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT");

这不是它的工作原理。您需要使用IHostEnvironment.EnvironmentName。如果您需要在 Main() 方法中访问您的配置，那么您做错了，读取环境变量是读取 (ASP).NET Core 环境名称的错误方式。

“(ASP).NET Core 环境名称”可以通过多种方式设置，一种方式是操作系统环境变量。但它们不是必须的，它们也可以通过命令行参数提供。

IHostEnvironment.EnvironmentName 是获取环境名称的正确方法。

Answer 3

感谢大家，尤其是 @CodeCaster 对我的帮助。

问题是设置静态配置时 _environment 变量是空字符串。我假设因为我在静态构造函数中设置它是可用的，但是静态ctor实际上在运行之后我设置了我的静态配置，所以 _environment 是一个空字符串，所以“暂存”配置从未加载过。

我更改了代码，这样运行时就不会以我没想到的顺序设置变量：

    private static IConfiguration Configuration { get; } = new ConfigurationBuilder()
        .SetBasePath(Directory.GetCurrentDirectory())
        .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
        .AddJsonFile($"appsettings.{Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT")}.json", optional: true, reloadOnChange: true)
        .Build();

许多海报基本上告诉我“你做错了”。我意识到在调用 Host.CreateDefaultBuilder() 之后运行时提供了一个依赖注入的配置。由于这个问题范围之外的原因，我碰巧在调用发生之前需要配置，在 Program.Main 中。如果我不需要 Program.Main 中的配置，在调用 Host.CreateDefaultBuilder 之前，这些都不是必需的。