ASP.NET Core Json 配置 - 缺少空数组的键值对

Question

给定如下json配置文件some_settings.json

{
    "AnEmptyArray": [],
    "APopulatedArray": [1, 2, 3]
}

作为源添加到 asp.net 核心配置系统并请求所有密钥时

var configuration = new ConfigurationBuilder()
    .AddJsonFile("some_settings.json")
    .Build();

var keys = configuration
    .AsEnumerable()
    .Select(c => c.Key);

结果是

APopulatedArray 
APopulatedArray:2 
APopulatedArray:1 
APopulatedArray:0 

由于某种原因，AnEmptyArray 没有密钥

如果我从 json 中完全删除 AnEmptyArray 键，结果是一样的

{
    "APopulatedArray": [1, 2, 3]
}

这意味着无法检测空数组和根本没有提供的数组之间的差异。

这对吗？

Answer 1

这意味着无法检测到 空数组并且根本没有提供数组。

这对吗？

如果很快 - 是的。

要了解原因，我们应该深入研究 .Net Core 配置加载机制。添加每个新源，例如AddJsonFile() 或AddEnvironmentVariables()，实际上将IConfigurationSource 的另一个实例广告到IConfigurationBuilder。当你最终调用IConfigurationBuilder.Build() 方法时，你会得到IConfigurationRoot 的实例，它本质上是一个已加载配置提供程序列表的持有者：

public interface IConfigurationRoot : IConfiguration
{
    IEnumerable<IConfigurationProvider> Providers { get; }
    void Reload();
}

更进一步，IConfigurationProvider 仅使用配置键值对操作：

public interface IConfigurationProvider
{
    IEnumerable<string> GetChildKeys(IEnumerable<string> earlierKeys, string parentPath);
    IChangeToken GetReloadToken();
    void Load();
    void Set(string key, string value);
    bool TryGet(string key, out string value);
}

IConfigurationProvider 根本不关心您设置的任何初始结构，例如数组或子部分：

这种机制有几个优点：

1. 您可以在不同的来源中拥有不同的配置部分（即使是一个部分）。
2. 您可以覆盖不同来源中某个部分的特定键值（保留部分的其他值）。

所以对您的问题的回答是“是”，您无法通过标准配置机制检测空数组和缺失数组之间的区别。初始 JSON 结构刚刚丢失，配置存储为键值对。空数组不会在IConfigurationProvider 中生成任何键值对。