.NET 7配置加载多态数据失败问题求助

问题场景 #

需求：从appsettings加载多态数据，测试实现中单独反序列化PolySection能正确处理多态，但通过IOptions<PolyCfg>注入时，仅整数字段JustAnInt值正常（1000），多态列表Property计数为0。后续更新：.NET配置仅解析JSON为键值对而非直接反序列化对象，基于Json.Net的配置包已标记为废弃。

测试代码：

async Task Main()
{
    var cfg = new
    {
        PolySection = new PolyCfg
        {
            Property = new List<IPolyProperty> 
            {
                new PolyImplementationOne { Data = 100 },
                new PolyImplementationTwo { Data = 200.5 },
            },
            JustAnInt = 1000
        },
    };
    
    var jsonConfig = JsonSerializer.Serialize(cfg);
    
    // Test
    var jsonSection = JsonSerializer.Serialize(cfg.PolySection).Dump();
    JsonSerializer.Deserialize<PolyCfg>(jsonSection).Dump();
    
    var cfgstrm = new MemoryStream(Encoding.Default.GetBytes(jsonConfig));

    var host = Host.CreateDefaultBuilder()
            .ConfigureAppConfiguration(config => config.AddJsonStream(cfgstrm))         
            .ConfigureServices((builder, services) =>
            {
                services.Configure<PolyCfg>(builder.Configuration.GetSection("PolySection"));
                services.AddHostedService<Service>();
            })
            .Build()
            .RunAsync();
}

public class PolyCfg
{ 
    public IList<IPolyProperty> Property { get; set; } 
    public int JustAnInt { get; set; }
}

[JsonDerivedType(typeof(PolyImplementationOne), nameof(PolyImplementationOne))]
[JsonDerivedType(typeof(PolyImplementationTwo), nameof(PolyImplementationTwo))]
public interface IPolyProperty
{ 
    
}

public class PolyImplementationOne: IPolyProperty
{ 
    public int Data { get; set; }
}

public class PolyImplementationTwo: IPolyProperty
{
    public double Data { get; set; }
}

public class Service : BackgroundService
{
    public Service(IOptions<PolyCfg> opts, ILogger<Service> logger)
    {
        logger.LogInformation("The int is: {justanint}", opts.Value.JustAnInt); // OK: return 1000
        logger.LogInformation("Number of items: {items}", opts.Value.Property.Count); // NOK: return 0
    }
    
    protected override Task ExecuteAsync(CancellationToken stoppingToken)
    {
        return Task.CompletedTask;
    }
}

解决方案 #

1. 能否通过System.Text.Json解决该问题？ #

可以，但需绕开配置系统的默认绑定逻辑。因为.NET配置系统是将JSON解析为键值对结构，而非直接反序列化对象，无法识别多态类型的派生信息。具体做法：

• 直接读取配置节的原始JSON字符串，再用System.Text.Json手动反序列化，结合已有的[JsonDerivedType]特性完成多态解析。
• 修改服务实现示例：

public class Service : BackgroundService
{
    public Service(IConfiguration config, ILogger<Service> logger)
    {
        var polySectionJson = config.GetSection("PolySection").GetRawJson();
        var polyCfg = JsonSerializer.Deserialize<PolyCfg>(polySectionJson);
        
        logger.LogInformation("The int is: {justanint}", polyCfg.JustAnInt); // 输出1000
        logger.LogInformation("Number of items: {items}", polyCfg.Property.Count); // 输出2
    }
    
    protected override Task ExecuteAsync(CancellationToken stoppingToken)
    {
        return Task.CompletedTask;
    }
}

• 注意：GetRawJson()方法仅在.NET 6及以上版本可用。

2. 能否在配置管理中替换为Json.Net序列化器？ #

不行。官方基于Json.Net的Microsoft.Extensions.Configuration.Json.NET包已被标记为废弃，且.NET配置系统的核心设计是基于键值对的解析，并非依赖特定序列化库，替换序列化器无法解决多态类型的解析问题。

3. 能否在配置反序列化过程中注入自定义转换器？ #

无法直接在配置系统的解析流程中注入自定义转换器。因为配置系统并非通过序列化/反序列化机制处理对象，而是将JSON解析为IConfiguration键值对后，通过Bind方法映射到对象，该过程无法识别多态类型的派生信息，也不支持注入自定义转换器来处理多态。

替代方案：

• 采用问题1中的手动反序列化方式，利用System.Text.Json的自定义转换器或[JsonDerivedType]特性处理多态。
• 在配置JSON中显式添加类型标识字段（如"Type": "PolyImplementationOne"），绑定后手动遍历列表，根据类型标识创建对应实例并赋值。

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