ASP.NET Core Web API中FromBody DTO绑定及子类转换问题

问题分析 #

你的核心问题有两个：

1. 传入SourceUrlDto未定义的额外字段时，默认JSON序列化会因不允许未知字段导致绑定失败；
2. 即使绑定成功，方法参数接收的是父类SourceUrlDto实例，无法直接转换为子类BasicSourceUrlDto访问额外字段。

下面是具体的解决方案：

步骤1：配置JSON序列化允许忽略未知字段 #

首先解决绑定失败的问题，在Program.cs中配置JSON选项，让序列化器忽略未知字段：

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        // 忽略未知字段，避免因传入额外字段导致绑定失败
        options.JsonSerializerOptions.IgnoreUnknownFields = true;
        // 可选：开启属性名大小写不敏感，适配前端不同命名风格
        options.JsonSerializerOptions.PropertyNameCaseInsensitive = true;
    });

步骤2：动态反序列化为对应子类 #

直接接收父类SourceUrlDto时，额外字段会被忽略，无法通过类型转换获取，需要根据请求中的标识（比如AuthenticationType）动态反序列化为子类。这里提供两种常用方案：

方案一：直接接收JSON原始数据后动态反序列化 #

修改控制器方法，接收JsonElement类型参数，解析后根据AuthenticationType选择对应DTO类型反序列化：

using System.Text.Json;

[HttpPost]
[Route("GetUrlData")]
public async Task<IActionResult> GetUrlData([FromBody] JsonElement jsonElement)
{
    // 提取AuthenticationType判断要使用的DTO类型
    if (jsonElement.TryGetProperty("AuthenticationType", out var authTypeElement) &&
        authTypeElement.GetString() == "Basic") // 假设Basic认证对应BasicSourceUrlDto
    {
        var basicDto = JsonSerializer.Deserialize<BasicSourceUrlDto>(jsonElement);
        // 访问Basic特有的Username和Password字段
        return Ok($"Basic认证用户：{basicDto.Username}");
    }
    else
    {
        var sourceDto = JsonSerializer.Deserialize<SourceUrlDto>(jsonElement);
        // 处理普通SourceUrlDto逻辑
        return Ok(sourceDto);
    }
}

方案二：使用自定义模型绑定器（保持原有方法签名） #

如果想保留原有的方法签名（接收SourceUrlDto），可以通过自定义模型绑定器实现动态实例化子类：

1. 创建模型绑定器和绑定器提供程序：

using Microsoft.AspNetCore.Mvc.ModelBinding;
using System.Text.Json;

public class SourceUrlDtoModelBinderProvider : IModelBinderProvider
{
    public IModelBinder GetBinder(ModelBinderProviderContext context)
    {
        // 只处理SourceUrlDto类型的绑定
        if (context.Metadata.ModelType == typeof(SourceUrlDto))
        {
            return new SourceUrlDtoModelBinder();
        }
        return null;
    }
}

public class SourceUrlDtoModelBinder : IModelBinder
{
    public async Task BindModelAsync(ModelBindingContext bindingContext)
    {
        // 读取请求原始JSON
        using var reader = new StreamReader(bindingContext.HttpContext.Request.Body);
        var jsonContent = await reader.ReadToEndAsync();
        var jsonDoc = JsonDocument.Parse(jsonContent);

        // 根据AuthenticationType判断实例化哪个子类
        if (jsonDoc.RootElement.TryGetProperty("AuthenticationType", out var authTypeElement) &&
            authTypeElement.GetString() == "Basic")
        {
            var basicDto = JsonSerializer.Deserialize<BasicSourceUrlDto>(jsonContent);
            bindingContext.Result = ModelBindingResult.Success(basicDto);
        }
        else
        {
            var sourceDto = JsonSerializer.Deserialize<SourceUrlDto>(jsonContent);
            bindingContext.Result = ModelBindingResult.Success(sourceDto);
        }
    }
}

2. 在Program.cs中注册模型绑定器：

builder.Services.AddControllers(options =>
{
    // 将自定义绑定器添加到最前面，优先使用
    options.ModelBinderProviders.Insert(0, new SourceUrlDtoModelBinderProvider());
})
.AddJsonOptions(options =>
{
    options.JsonSerializerOptions.IgnoreUnknownFields = true;
    options.JsonSerializerOptions.PropertyNameCaseInsensitive = true;
});

3. 保持原有控制器方法不变，此时sourceUrlDto会根据AuthenticationType被实例化为对应子类，类型转换会成功：

[HttpPost]
[Route("GetUrlData")]
public async Task<IActionResult> GetUrlData([FromBody] SourceUrlDto sourceUrlDto)
{
    if (sourceUrlDto is BasicSourceUrlDto basicDto)
    {   
        // 直接访问basicDto的Username和Password字段
        return Ok($"Basic账号：{basicDto.Username}，密码：{basicDto.Password}");
    }

    return Ok(sourceUrlDto);
}

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