Можете ли вы предварительно просмотреть переопределения среды appsettings.json в ASP.NET Core?

Я понял, что вы можете выполнить предварительный просмотр с помощью функции слияния Json.NET после загрузки файлов настроек приложения в JObjects.

Вот простое консольное приложение, демонстрирующее это. Укажите ему путь к файлам настроек приложения, и он выдаст предварительный просмотр того, как они будут выглядеть в каждой среде.

    static void Main(string[] args)
    {
        string targetPath = @"C:\path\to\my\app";

        // Parse appsettings.json
        var baseConfig = ParseAppSettings($@"{targetPath}\appsettings.json");

        // Find all appsettings.{env}.json's
        var regex = new Regex(@"appsettings\..+\.json");
        var environmentConfigs = Directory.GetFiles(targetPath, "*.json")
            .Where(path => regex.IsMatch(path));

        foreach (var env in environmentConfigs)
        {
            // Parse appsettings.{env}.json
            var transform = ParseAppSettings(env);

            // Clone baseConfig since Merge is a void operation
            var result = (JObject)baseConfig.DeepClone();

            // Merge the two, making sure to overwrite arrays
            result.Merge(transform, new JsonMergeSettings
            {
                MergeArrayHandling = MergeArrayHandling.Replace
            });

            // Write the preview to file
            string dest = $@"{targetPath}\preview-{Path.GetFileName(env)}";
            File.WriteAllText(dest, result.ToString());
        }
    }

    private static JObject ParseAppSettings(string path)
        => JObject.Load(new JsonTextReader(new StreamReader(path)));

Хотя это не гарантирует, что какой-либо другой источник конфигурации не переопределит их после развертывания, это, по крайней мере, позволит вам убедиться, что взаимодействие между этими двумя файлами будет обрабатываться правильно.

На самом деле нет способа сделать это, но я думаю, что немного о том, как это на самом деле работает, поможет вам понять, почему.

С преобразованиями конфигурации произошла буквальная модификация файла, поэтому достаточно легко «предварительно просмотреть» это, показав результирующий файл. Система конфигурации в ASP.NET Core совершенно другая.

По сути, это просто словарь. Во время запуска каждый зарегистрированный поставщик конфигурации запускается в том порядке, в котором он был зарегистрирован. Поставщик считывает свой источник конфигурации, будь то файл JSON, системные переменные среды, аргументы командной строки и т. д., и создает пары ключ-значение, которые затем добавляются в основной «словарь» конфигурации. «Переопределение», такое как appsettings.{environment}.json, на самом деле просто еще один поставщик JSON, зарегистрированный после поставщика appsettings.json, который, очевидно, использует другой источник (файл JSON). Поскольку он регистрируется после того, как встречается существующий ключ, его значение перезаписывается, что характерно для всего, что добавляется в словарь.

Другими словами, «предварительный просмотр» будет завершенным объектом конфигурации (словарем), который состоит из ряда различных источников, а не только этих файлов JSON, и такие вещи, как переменные среды или аргументы командной строки, будут переопределять даже специфичный для среды JSON. (поскольку они зарегистрированы после этого), поэтому вы все равно технически не знаете, применяется ли JSON для конкретной среды или нет, потому что значение может исходить из другого источника, который отменяет это.