.NET Core 中的 services.AddSingleton<IConfiguration> 用途

Question

我们需要根据本地与否读取多个应用设置。我们通过添加appsettings.local.json 实现了这一点。

但是我们看到，虽然我们添加了这个文件并设置了必要的配置，但我们无法从appsettings.local.json 读取配置数据，它一直看到appsettings.json。

让我通过代码告诉：

public static void Main(string[] args)
{
    var config = new ConfigurationBuilder()
        .SetBasePath(Directory.GetCurrentDirectory())
        .AddJsonFile("appsettings.json")
        .AddJsonFile("appsettings.local.json", optional: true)
        .AddEnvironmentVariables()
        .AddCommandLine(args)
        .Build();

    CreateWebHostBuilder(args, config).Build().Run();
}

public static IWebHostBuilder CreateWebHostBuilder(string[] args, IConfiguration config)
{
    var webHostBuilder = WebHost.CreateDefaultBuilder(args)
        .UseApplicationInsights()
        .ConfigureServices(services => services.AddSingleton<IConfiguration>(config))
        .UseStartup<Startup>();

    return webHostBuilder;
}

在CreateWebHostBuilder 中，如果我们不添加.ConfigureServices(services => services.AddSingleton<IConfiguration>(config))，我们将无法从appsettings.local.json 读取数据。添加后，我们可以阅读appsettings.local.json。所以我的问题是这里发生了什么？谁能给个合理的解释？

Answer 1

您所做的是创建一个单独的配置构建器来加载其自己的源。尽管默认 Web 主机构建器已经包含一些配置源，包括 appsettings.json 和 appsettings.<environment>.json 文件，但您还是这样做了。

通过说services.AddSingleton<IConfiguration>(config)，您实际上是在用您自己的配置替换默认配置。虽然这在大多数情况下可能会产生正确的效果，但我可以想象它可能会在以后导致一些问题，因为您的应用程序中实际上有两种不同的配置（尽管其中一种 - 默认配置 - 几乎无法访问）。

我通常建议您不要这样做，而是更改默认配置，以便它加载您所需的所有源。你可以拨打WebHostBuilder.ConfigureAppConfiguration：

public static IWebHostBuilder CreateWebHostBuilder(string[] args, IConfiguration config)
{
    var webHostBuilder = WebHost.CreateDefaultBuilder(args)
        .UseApplicationInsights()
        .ConfigureAppConfiguration(config =>
        {
            config.AddJsonFile("appsettings.local.json", optional: true);
        })
        .UseStartup<Startup>();

    return webHostBuilder;
}

现在这会将另一个 JSON 文件添加到默认配置生成器。因此默认的IConfiguration 也会从该源获取配置值。这样，您就不需要在您的 Program.cs 中创建 ConfigurationBuilder。

请注意，appsettings.local.json 现在是最后一个配置源，因此在那里配置的任何设置都将覆盖之前配置的设置。因此，如果您使用命令行参数或环境变量，请注意这一点。

最后请注意，如果您打算仅在特定的本地环境中使用 local 文件，那么您也可以在默认配置设置中仅使用 set the hosting environment to be local 自动加载 appsettings.local.json。这是因为默认主机生成器会自动选择appsettings.<environment>.json（如果存在）。