如何将配置源放置到某个配置节以避免密钥冲突？

Question

我有两个配置文件：

users.json:

{
  "Alice" : { "Email": "alice@example.com" },
  "Bob" : { "Email": "bob@example.com" }
}

和connections.json

{
  "Database" : { "ConnectionString": "..." },
  "Gateway" : { "Url": "http://..." }
}

我正在尝试编写单个配置根：

var cfg = new ConfigurationBuilder()
    .AddJsonFile("users.json")
    .AddJsonFile("connections.json")
    .Build();

显然，我需要将每个配置源放入它的部分：Users 和 Connections - 以避免冲突。某种前缀包装器可以完成这项工作，但我不想实现自己的。

如果您无法修改配置文件结构（在实际项目中是有原因的），您将如何处理这种情况？

Answer 1

根据JsonConfigurationFileParser 和JsonConfigurationProvider 类的实现看起来你只能编写自己的FileConfigurationProvider 实现。

---

作为一种解决方法，您可以执行以下操作（逐步）：

• => 读取每个文件的配置
• => 然后将结果作为 KeyValuePair 项的集合获取
• => 然后为每个键名附加一些自定义前缀（在您的情况下基于文件名）
• => 合并：将最终集合作为 MemoryCollection 源附加到根配置

以下代码为idea实现，在prod中使用前可能需要修改：

public static class ConfigurationBuilderExtensions
{
    public static IConfigurationBuilder AddJsonFileWithPrefix(this IConfigurationBuilder configurationBuilder, string fileName, string prefix) 
    {
        var config = new ConfigurationBuilder()
            // you may need to set up base path again here
            // .SetBasePath(Directory.GetCurrentDirectory())
            .AddJsonFile(fileName).Build();

        var result = new List<KeyValuePair<string, string>>();

        foreach(var pair in config.AsEnumerable())
        {
            result.Add(new KeyValuePair<string, string>($"{prefix}:{pair.Key}", pair.Value));
        }

        return configurationBuilder.AddInMemoryCollection(result);
    }
} 

那么您可以创建配置根目录为：

var cfg = new ConfigurationBuilder()
    .AddJsonFileWithPrefix("users.json", "users")
    .AddJsonFileWithPrefix("connections.json", "connections")
    .Build();

Answer 2

您可以修改 json 文件以反映部分：

users.json:

{
    "Users": {
        "Alice" : { "Email": "alice@example.com" },
        "Bob" : { "Email": "bob@example.com" }
    }
}

和connections.json

{
    "Connections": {
        "Database" : { "ConnectionString": "..." },
        "Gateway" : { "Url": "http://..." }
    }
}