appsettings.json空数组绑定后属性为Null问题的解决方案问询

解决方案 #

以下是4种可落地的处理方案，可根据项目场景选择：

方案1：给Options属性设置默认值（最简便）

直接在Options类的属性上初始化默认空集合，就算绑定结果为null也不会触发空引用：

public sealed class MyOptions
{
  public IEnumerable<string> Values { get; set; } = Enumerable.Empty<string>();
}

如果需要允许后续修改集合，也可以初始化为new List<string>()。

方案2：使用PostConfigure全局兜底（最稳妥）

在注册Options后追加后置配置逻辑，强制将null的集合属性替换为空集合，适配所有绑定场景，包括配置显式设为null的情况：

services.Configure<MyOptions>(_configuration.GetSection(nameof(MyOptions)));
// 追加后置处理
services.PostConfigure<MyOptions>(opt => 
{
    opt.Values ??= Enumerable.Empty<string>();
});

方案3：使用时做空兼容处理

不需要修改配置或Options定义，在消费的地方做空判断即可：

public MyService(IOptions<MyOptions> options)
{
  // 直接兜底为空集合
  var values = options.Value.Values ?? Enumerable.Empty<string>();

  foreach (var val in values)
  {
    // Do something
  }
}

方案4：将属性改为具体集合类型

避免使用抽象的IEnumerable<T>作为属性类型，改为绑定器可直接实例化的具体类型，比如List<string>、string[]，空数组会直接绑定为空集合，不会出现null：

public sealed class MyOptions
{
  public List<string> Values { get; set; }
  // 或者 public string[] Values { get; set; }
}

原因说明 #

该行为是官方设计的预期行为：配置绑定器无法确定抽象接口IEnumerable<T>的具体实现类型，因此遇到空数组时不会主动实例化集合，直接返回null。而具体集合类型有明确的无参构造函数，绑定器可以直接初始化，因此不会返回null。

内容的提问来源于stack exchange，提问作者Chris Pickford