ASP.NET Core中表单数据绑定的JsonExtensionData等效方案及自定义绑定器

ASP.NET Core确实没有内置等效于JsonExtensionData的特性来处理表单数据中的未识别属性，但可以通过自定义模型绑定器实现相同功能，以下是具体步骤：

1. 定义带扩展属性的模型类 #

先创建包含常规属性和扩展字段字典的模型：

public class MyFormModel
{
    public string Name { get; set; }
    public int Age { get; set; }
    // 存储所有未匹配到常规属性的表单字段
    public Dictionary<string, string> ExtraFields { get; set; } = new Dictionary<string, string>();
}

2. 编写自定义模型绑定器 #

实现IModelBinder接口，遍历所有表单字段，将匹配常规属性的字段正常绑定，剩余字段存入扩展字典：

public class FormExtensionDataBinder : IModelBinder
{
    public Task BindModelAsync(ModelBindingContext bindingContext)
    {
        if (bindingContext == null)
            throw new ArgumentNullException(nameof(bindingContext));

        var formValues = bindingContext.HttpContext.Request.Form;
        var modelType = bindingContext.ModelType;
        var model = Activator.CreateInstance(modelType);

        var properties = modelType.GetProperties(BindingFlags.Public | BindingFlags.Instance);

        foreach (var formField in formValues)
        {
            // 查找匹配的常规属性
            var property = properties.FirstOrDefault(p => 
                string.Equals(p.Name, formField.Key, StringComparison.OrdinalIgnoreCase));
            
            if (property != null && property.CanWrite)
            {
                // 绑定常规属性，处理类型转换
                try
                {
                    var value = Convert.ChangeType(formField.Value, property.PropertyType);
                    property.SetValue(model, value);
                }
                catch
                {
                    bindingContext.ModelState.TryAddModelError(formField.Key, $"无法转换字段 {formField.Key} 的值");
                }
            }
            else
            {
                // 将未匹配字段存入扩展字典
                var extraFieldProperty = properties.FirstOrDefault(p => 
                    p.PropertyType == typeof(Dictionary<string, string>) && p.Name == "ExtraFields");
                
                if (extraFieldProperty != null && extraFieldProperty.CanWrite)
                {
                    var extraFields = (Dictionary<string, string>)extraFieldProperty.GetValue(model) ?? new Dictionary<string, string>();
                    extraFields[formField.Key] = formField.Value;
                    extraFieldProperty.SetValue(model, extraFields);
                }
            }
        }

        bindingContext.Result = ModelBindingResult.Success(model);
        return Task.CompletedTask;
    }
}

3. 关联绑定器与模型 #

有两种方式将绑定器绑定到目标模型：

方式一：用ModelBinder特性标注模型 #

直接在模型类上指定绑定器：

[ModelBinder(BinderType = typeof(FormExtensionDataBinder))]
public class MyFormModel
{
    // 模型属性...
}

方式二：全局注册绑定器 #

若多个模型需要复用该绑定器，可在Program.cs中全局配置：

builder.Services.AddControllers(options =>
{
    options.ModelBinderProviders.Insert(0, new FormExtensionDataBinderProvider());
});

// 配套的绑定器提供类
public class FormExtensionDataBinderProvider : IModelBinderProvider
{
    public IModelBinder GetBinder(ModelBinderProviderContext context)
    {
        if (context.Metadata.ModelType == typeof(MyFormModel))
        {
            return new BinderTypeModelBinder(typeof(FormExtensionDataBinder));
        }
        return null;
    }
}

4. 在控制器中使用模型 #

Action中直接接收模型，扩展字段会自动存入ExtraFields字典：

[HttpPost]
public IActionResult SubmitForm(MyFormModel model)
{
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }

    // 处理常规属性
    var name = model.Name;
    var age = model.Age;
    // 处理扩展字段
    foreach (var extra in model.ExtraFields)
    {
        // 自定义业务逻辑
    }

    return Ok();
}

额外说明 #

• 若表单存在重复键（如多选框），可将ExtraFields类型改为Dictionary<string, StringValues>以支持多值。
• 可根据需求扩展绑定器的错误处理逻辑，比如添加更详细的类型转换失败提示。
• 如需支持嵌套模型，可修改绑定器实现递归绑定逻辑。

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