ASP.NET Core中XmlConfigurationSource绑定自定义键字典至模型问题

问题根源 #

你遇到的问题是因为ASP.NET Core的XML配置提供程序默认会将同级重复节点识别为数组，而非字典，所以会生成0、1这类索引键。要绑定到Dictionary<string, Client>，需要调整XML结构或配置解析选项。

方案1：用节点名称作为字典键（无需额外配置） #

直接将字典的键作为<Clients>的子节点名称，XML结构如下：

<configuration>
  <Clients>
    <110>
      <Name>客户A</Name>
      <ApiUrl>https://client-a.example.com</ApiUrl>
    </110>
    <120>
      <Name>客户B</Name>
      <ApiUrl>https://client-b.example.com</ApiUrl>
    </120>
  </Clients>
</configuration>

这种写法无需修改配置加载代码，绑定后Clients字典的键就是110、120。

方案2：用key属性指定字典键（需配置解析选项） #

如果偏好使用key属性标记键，需要在加载XML配置时指定解析规则：

1. 编写XML配置：

<configuration>
  <Clients>
    <Client key="110">
      <Name>客户A</Name>
      <ApiUrl>https://client-a.example.com</ApiUrl>
    </Client>
    <Client key="120">
      <Name>客户B</Name>
      <ApiUrl>https://client-b.example.com</ApiUrl>
    </Client>
  </Clients>
</configuration>

2. 在Program.cs中配置XML解析选项：

builder.Configuration.AddXmlFile("config.xml", 
    optional: true, 
    reloadOnChange: true,
    config => 
    {
        config.XmlParserOptions = new XmlParserOptions
        {
            // 指定字典项的元素名称
            ElementName = "Client",
            // 指定用作字典键的属性名
            AttributeName = "key"
        };
    });

关于appsettings.json的正确写法 #

你提到切换JSON也未解决，大概率是JSON结构错误。正确的JSON字典结构应该是键值对形式，而非数组：

{
  "Clients": {
    "110": {
      "Name": "客户A",
      "ApiUrl": "https://client-a.example.com"
    },
    "120": {
      "Name": "客户B",
      "ApiUrl": "https://client-b.example.com"
    }
  }
}

如果写成数组（"Clients": [{"Key":"110", ...}]），绑定后依然会生成索引键，这是配置绑定的规则。

绑定代码示例 #

确保配置模型的属性名称与配置节点匹配（大小写不敏感）：

public class AppConfig
{
    public Dictionary<string, Client> Clients { get; set; }
}

public class Client
{
    public string Name { get; set; }
    public string ApiUrl { get; set; }
}

绑定方式（两种任选其一）：

// 方式1：直接绑定到实例
var appConfig = new AppConfig();
builder.Configuration.Bind(appConfig);

// 方式2：注入到服务容器
builder.Services.Configure<AppConfig>(builder.Configuration);

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