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

时间:2017-11-30 01:29:55

标签: c# asp.net asp.net-core .net-core appsettings

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

appsettings.json

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

appsettings.dev.json

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

并且在转换之后,数组将是

["three", "two"]

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

3 个答案:

答案 0 :(得分:6)

了解这种奇怪的原因'重写数组设置的行为,您需要了解这些设置如何存储在配置提供程序中。

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

对于您所描述的配置,您将拥有2个配置提供程序,其中包含以下几组设置:

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

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

Values in configuration providers

现在很清楚为什么数组设置的最终值是["three", "two"]。来自第二个提供商的Values:Test:0会覆盖第一个提供商的相同设置,并且Values:Test:1保持不变。

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

想法如下:

  1. 以相反的顺序枚举配置提供程序。
  2. 为每个提供商获取其所有设置键。为此,您可以递归调用IConfigurationProvider.GetChildKeys()方法。请参阅以下代码段中的GetProviderKeys()
  3. 使用正则表达式检查当前密钥是否为数组条目。
  4. 如果是,并且某些先前的提供程序会覆盖此数组,则只需通过将当前数组输入设置为null值来禁止当前数组输入。
  5. 如果它是未看到的数组,则当前提供程序被标记为此数组的唯一值提供程序。将抑制来自所有其他提供者的数组(步骤#4)。
  6. 为方便起见,您可以将所有这些逻辑包装在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();
    

答案 1 :(得分:2)

@Matt在我看来,这只是一个不必要的逻辑。 Flow&#39; KISS&#39;。

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"]
    }

无论如何如果以前的答案可以解决你的问题,那么这只是我的意见。感谢)

答案 2 :(得分:1)

我建议使用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)

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