.NET7中如何默认启用AppSettings的多态反序列化？

问题原因 #

.NET配置系统的ConfigurationBinder默认绑定集合时，不会启用基于$type的多态反序列化——它会直接创建基类实例并绑定公共属性，忽略类上标记的JsonDerivedType特性，导致所有对象都被反序列化为BaseAction基类。

解决方案 #

要让多态反序列化生效，需要手动使用System.Text.Json的序列化器（并启用多态支持）来解析配置的原始JSON，而不是依赖默认的ConfigurationBinder绑定逻辑。以下是两种可行方案：

方案1：自定义IOptions绑定逻辑 #

在Program.cs中配置IOptions时，手动读取配置节的原始JSON，用带多态支持的JsonSerializerOptions反序列化：

// 先确保基类已正确标记JsonDerivedType
[JsonDerivedType(typeof(EmailAction), "Email")]
[JsonDerivedType(typeof(SmsAction), "Sms")]
public class BaseAction
{
    public string Name { get; set; } = string.Empty;
}

public class EmailAction : BaseAction
{
    public string To { get; set; } = string.Empty;
}

public class SmsAction : BaseAction
{
    public string PhoneNumber { get; set; } = string.Empty;
}

// Program.cs中的配置代码
builder.Services.Configure<List<BaseAction>>("Actions", (config) =>
{
    // 读取配置节的原始JSON
    var rawJson = config.GetRawJson();
    if (string.IsNullOrEmpty(rawJson))
        return new List<BaseAction>();

    // 配置Json序列化选项，自动识别JsonDerivedType标记启用多态
    var jsonOptions = new JsonSerializerOptions
    {
        PropertyNameCaseInsensitive = true,
        TypeInfoResolver = new DefaultJsonTypeInfoResolver()
    };

    return JsonSerializer.Deserialize<List<BaseAction>>(rawJson, jsonOptions) ?? new List<BaseAction>();
});

之后即可正常注入IOptions<List<BaseAction>>，获取到正确类型的派生类实例。

方案2：直接反序列化并注册为服务 #

如果不需要IOptions的动态重载特性，可以直接读取配置并反序列化后注册为单例/作用域服务：

// Program.cs中的配置代码
var actionsSection = builder.Configuration.GetSection("Actions");
var rawJson = actionsSection.GetRawJson();

var jsonOptions = new JsonSerializerOptions
{
    PropertyNameCaseInsensitive = true,
    TypeInfoResolver = new DefaultJsonTypeInfoResolver()
};

var actions = string.IsNullOrEmpty(rawJson) 
    ? new List<BaseAction>() 
    : JsonSerializer.Deserialize<List<BaseAction>>(rawJson, jsonOptions) ?? new List<BaseAction>();

// 注册为单例服务
builder.Services.AddSingleton(actions);

在需要使用的地方直接注入List<BaseAction>即可：

public class MyService
{
    private readonly List<BaseAction> _actions;

    public MyService(List<BaseAction> actions)
    {
        _actions = actions;
    }

    public void ProcessActions()
    {
        foreach (var action in _actions)
        {
            switch (action)
            {
                case EmailAction email:
                    // 处理邮件动作
                    break;
                case SmsAction sms:
                    // 处理短信动作
                    break;
            }
        }
    }
}

注意事项 #

• 确保appsettings.json中的$type值与JsonDerivedType的typeDiscriminator完全匹配（默认大小写敏感）。
• DefaultJsonTypeInfoResolver会自动读取类上的JsonDerivedType特性，无需手动添加派生类型映射。
• 若使用Newtonsoft.Json，需替换为JsonConvert.DeserializeObject并配置TypeNameHandling.Auto，但.NET7默认推荐使用System.Text.Json。

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