ASP.Net JSON 配置文件用数组转换

Question

我有一个基本配置文件，例如。

appsettings.json

{
    "Values": {
        "Test": ["one", "two"]
    }
}

和

appsettings.dev.json

{
    "Values": {
        "Test": ["three"]
    }
}

转换后数组为

["three", "two"]

如何确保转换后的数组缩小为更少的元素，而不是每个元素单独更改？

Answer 1

要了解覆盖数组设置的这种 'strange' 行为的原因，您需要了解这些设置是如何存储在配置提供程序中的。

实际情况是所有加载的设置都存储在字典中，每个配置提供程序都有自己的字典。键是根据设置路径构建的，其中嵌套部分用冒号分隔。数组设置与设置路径中的索引存储在同一字典中 (:0, :1, ...).

对于您描述的配置，您将有 2 个配置提供程序，它们具有以下设置集：

provider1[Values:Test:0] = "one"
provider1[Values:Test:1] = "two"

和

provider2[Values:Test:0] = "three"

现在明白为什么数组设置的最终值为["three", "two"]了。第二个提供商的 Values:Test:0 覆盖了第一个提供商的相同设置，并且 Values:Test:1 保持不变。

不幸的是，现在有一个内置的可能性来克服这个问题。幸运的是，.net 核心配置模型足够灵活，可以根据您的需要调整此行为。

思路如下：

以相反的顺序枚举配置提供程序。
为每个提供商获取其所有设置密钥。为此，您可以递归调用 IConfigurationProvider.GetChildKeys() 方法。请参阅以下代码段中的 GetProviderKeys()。
使用正则表达式检查当前键是否为数组条目。
如果是并且之前的一些提供者覆盖了这个数组，那么只需将其设置为 null 值来抑制当前数组条目。
如果它是看不见的数组，则当前提供者被标记为该数组值的唯一提供者。来自所有其他提供者的数组将被抑制（步骤 #4）。

为方便起见，您可以将所有这些逻辑包装到 IConfigurationRoot 上的扩展方法中。

这是一个工作示例：

public static class ConfigurationRootExtensions
{
    private static readonly Regex ArrayKeyRegex = new Regex("^(.+):\d+$", RegexOptions.Compiled);

    public static IConfigurationRoot FixOverridenArrays(this IConfigurationRoot configurationRoot)
    {
        HashSet<string> knownArrayKeys = new HashSet<string>();

        foreach (IConfigurationProvider provider in configurationRoot.Providers.Reverse())
        {
            HashSet<string> currProviderArrayKeys = new HashSet<string>();

            foreach (var key in GetProviderKeys(provider, null).Reverse())
            {
                //  Is this an array value?
                var match = ArrayKeyRegex.Match(key);
                if (match.Success)
                {
                    var arrayKey = match.Groups[1].Value;
                    //  Some provider overrides this array.
                    //  Suppressing the value.
                    if (knownArrayKeys.Contains(arrayKey))
                    {
                        provider.Set(key, null);
                    }
                    else
                    {
                        currProviderArrayKeys.Add(arrayKey);
                    }
                }
            }

            foreach (var key in currProviderArrayKeys)
            {
                knownArrayKeys.Add(key);
            }
        }

        return configurationRoot;
    }

    private static IEnumerable<string> GetProviderKeys(IConfigurationProvider provider,
        string parentPath)
    {
        var prefix = parentPath == null
                ? string.Empty
                : parentPath + ConfigurationPath.KeyDelimiter;

        List<string> keys = new List<string>();
        var childKeys = provider.GetChildKeys(Enumerable.Empty<string>(), parentPath)
            .Distinct()
            .Select(k => prefix + k).ToList();
        keys.AddRange(childKeys);
        foreach (var key in childKeys)
        {
            keys.AddRange(GetProviderKeys(provider, key));
        }

        return keys;
    }
}

最后就是在构建配置的时候调用它：

IConfigurationBuilder configurationBuilder = new ConfigurationBuilder();
configurationBuilder.AddJsonFile("AppSettings.json")
    .AddJsonFile("appsettings.dev.json");
var configuration = configurationBuilder.Build();
configuration.FixOverridenArrays();

Answer 2

我建议使用 appsettings.Development.json 和 appsettings.Production.json 来分隔环境。并在 appsettings.json 中保留两种环境的通用设置。

只需将您的 appsettings.dev.json 重命名为 appsettings.Development.json。 appsettings 添加Stage 或Prodaction 模式。{#mode}.json。并修改Startup.cs.

中的ConfigurationBuilder

.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
.AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)

我认为这是更常见的做法，可以从不必要的合并逻辑中节省您的时间

Answer 3

@Matt 在我看来这只是一个不必要的逻辑。流'KISS'。

appsettings.json 应仅包含常用设置。如果您的生产模式或开发模式必须在一个键中有一些相同的值，只需复制它们。喜欢appsettings.Development.json

"Values": {
        "Test": ["one", "two"]
    }

和appsettings.Production.json

"Values": {
        "Test": ["one", "two","three"]
    }

如果两种模式需要相同的值，则应将其放入 appsettings.json。

"SomeValues": {
        "Test": ["1", "2","3"]
    }

您将在最终设置中进行生产

"SomeValues": {
        "Test": ["1", "2","3"]
    },
"Values": {
        "Test": ["one", "two","three"]
    }

并用于开发

"SomeValues": {
        "Test": ["1", "2","3"]
    },
"Values": {
        "Test": ["one", "two"]
    }

anyway 如果前面的回答解决了你的问题也没关系，这只是我的意见。谢谢）

ASP.Net JSON 配置文件用数组转换

ASP.Net JSON configuration file transforms with arrays

c#

asp.net

appsettings

.net-core

asp.net-core