.NET配置绑定appsettings时KeyValuePair类型属性无法取值问题

.NET 配置绑定系统无法正常绑定 KeyValuePair<TKey,TValue> 类型的属性，核心原因有两个：

1. KeyValuePair 是值类型，其 Key、Value 属性均为只读属性，没有公共 setter，配置系统无法直接为这两个属性赋值
2. 配置系统默认仅对包含公共无参构造函数、可写公共属性的类做自动递归绑定，不会主动匹配构造函数参数完成 KeyValuePair 的初始化，因此最终拿到的 ApiKey 就是默认初始化的空结构体，Key 和 Value 均为 null。而 ApiUrl 是可写的字符串属性，符合绑定规则，因此可以正常取值。

方案1：自定义配置类（最推荐） #

放弃使用 KeyValuePair，自定义一个包含可写 Key、Value 属性的配置类即可，改动最小且符合配置绑定的最佳实践：

// 新增自定义ApiKey配置类
public class ApiKeySettings
{
    public string? Key { get; set; }
    public string? Value { get; set; }
}

// 修改Messages类的ApiKey属性类型
public class Messages
{
    public string ApiUrl { get; set; } = null!;
    public ApiKeySettings ApiKey { get; set; } = null!;
}

修改完成后不需要改动其他注册逻辑，即可正常通过 _settings.Messages.ApiKey.Key 和 _settings.Messages.ApiKey.Value 取值。

方案2：手动绑定保留KeyValuePair #

如果业务要求必须使用 KeyValuePair 类型，可以在注册配置时手动读取节点完成赋值：

// 以ASP.NET Core为例，在Program.cs注册配置时替换默认的自动绑定
builder.Services.Configure<CPSSettings>(opt =>
{
    var msgSection = builder.Configuration.GetSection("Messages");
    opt.Messages = new Messages
    {
        ApiUrl = msgSection.GetValue<string>("ApiUrl")!,
        ApiKey = new KeyValuePair<string?, string?>(
            msgSection.GetValue<string>("ApiKey:Key"),
            msgSection.GetValue<string>("ApiKey:Value")
        )
    };
});

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