.NET Core 使用配置绑定到带数组的选项

Question

使用 .NET Core Microsoft.Extensions.Configuration是否可以将 Configuration 绑定到包含数组的对象？

ConfigurationBinder有一个BindArray方法，所以我认为它会起作用。

但是当我尝试时，我得到了一个例外：

System.NotSupportedException: ArrayConverter cannot convert from System.String.

这是我的精简代码：

public class Test
{
   private class ExampleOption
   { 
      public int[] Array {get;set;}
   }

   [Test]
   public void CanBindArray()
   {
       // ARRANGE
       var config =
            new ConfigurationBuilder()
            .AddInMemoryCollection(new List<KeyValuePair<string, string>>
            {
                new KeyValuePair<string, string>("Array", "[1,2,3]")
            })
            .Build();

        var exampleOption= new ExampleOption();

        // ACT
        config.Bind(complexOptions); // throws exception

       // ASSERT
       exampleOption.ShouldContain(1);
   }
}

Answer 1

错误在您的输入定义中。 该示例将键“Array”设置为字符串值“[1,2,3]”（在基于 C# 的 InMemoryCollection 中），并假设它是解析的 JSON 样式。 那是错误的。 它只是没有被解析。

配置系统中数组值的编码约定是通过用冒号和后面的索引重复键。 以下示例的工作方式与您打算做的一样：

var config = new ConfigurationBuilder()
        .AddInMemoryCollection(new List<KeyValuePair<string, string>>
        {
            new KeyValuePair<string, string>("Array:0", "1"),
            new KeyValuePair<string, string>("Array:1", "2"),
            new KeyValuePair<string, string>("Array:2", "3")
        })
        .Build();

如果使用 JSON 文件（此处通过对 AddJsonFile 的附加调用），也会发生冒号键重复方案......

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

生成的组合配置将包含遵循与上述内存使用相同模式的键：

Count = 8
[0]: {[mySecondArray, ]}
[1]: {[mySecondArray:2, 3]}
[2]: {[mySecondArray:1, 2]}
[3]: {[mySecondArray:0, 1]}
[4]: {[Array, ]}
[5]: {[Array:2, 3]}
[6]: {[Array:1, 2]}
[7]: {[Array:0, 1]}

配置系统与 JSON/INI/XML/... 等存储格式无关，本质上只是一个 string->string 字典，其中冒号在 key 内构成层次结构。

然后绑定能够通过约定解释一些层次结构，因此也绑定数组、集合、对象和字典。 有趣的是，对于数组，它并不关心冒号后面的数字，而只是迭代配置部分的子项（此处为“数组”）并获取子项的值。 该分拣再次孩子，需要的数量考虑，而且排序字符串作为第二个选项（OrdinalIgnoreCase）。

Answer 2

随着最近对 C# 语言的添加，使用更新的语法更清晰：

var config = new ConfigurationBuilder()
    .AddInMemoryCollection(new Dictionary<string, string>
    {
        { "Array:0", "1" },
        { "Array:1", "2" },
        { "Array:2", "3" },
    })
    .Build();

Answer 3

您可以使用ConfigureServices方法中的代码配置ExampleOption ：

 public void ConfigureServices(IServiceCollection services)
 {
      services.Configure<ExampleOption>(myOptions =>
      {
          myOptions.Array = new int[] { 1, 2, 3 };
      });
 }

或者如果你想使用 json 配置文件

appsettings.json ：

{
  "ExampleOption": {
     "Array": [1,2,3]
  }
}

ConfigureServices ：

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<ExampleOption>(Configuration.GetSection("ExampleOption"));
}