ASP.NET Core 和 formdata 与文件和 json 属性的绑定

Question

我有以下型号：

public class MyJson
{
 public string Test{get;set;}
}

public class Dto
{
 public IFormFile MyFile {get;set;}
 public MyJson MyJson {get;set;}
}

在客户端，我想发送一个文件和一个 json。所以我用以下键在 formData 中发送它：

var formData = new FormData();
formData["myFile"] = file//here is my file
formData["myJson"] = obj; // object to be serialized to json.

我的动作是这样的：

public void MyAction(Dto dto) // or with [FromForm], doesn't really matter
{
  //dto.MyJson is null here
  //dto.myFile is set correctly.
}

如果我将dto.MyJson 更改为字符串，那么它可以正常工作，但是我必须在操作中手动将其反序列化到我的对象中。将它作为字符串的第二个问题是我无法使用 swagger UI 来正确处理它，因为它会要求我输入 json 字符串而不是对象，无论如何将它作为字符串听起来并不正确。有没有一种本地方法可以在动作参数中正确处理 json 和文件，而不是使用 Request.Form 手动解析它？

Answer 1

这可以使用自定义模型绑定器来完成：

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

        // Fetch the value of the argument by name and set it to the model state
        string fieldName = bindingContext.FieldName;
        var valueProviderResult = bindingContext.ValueProvider.GetValue(fieldName);
        if(valueProviderResult == ValueProviderResult.None) return Task.CompletedTask;
        else bindingContext.ModelState.SetModelValue(fieldName, valueProviderResult);

        // Do nothing if the value is null or empty
        string value = valueProviderResult.FirstValue;
        if(string.IsNullOrEmpty(value)) return Task.CompletedTask;

        try
        {
            // Deserialize the provided value and set the binding result
            object result = JsonConvert.DeserializeObject(value, bindingContext.ModelType);
            bindingContext.Result = ModelBindingResult.Success(result);
        }
        catch(JsonException)
        {
            bindingContext.Result = ModelBindingResult.Failed();
        }

        return Task.CompletedTask;
    }
}

然后您可以在 DTO 类中使用 ModelBinder 属性来指示应该使用此绑定器来绑定 MyJson 属性：

public class Dto
{
    public IFormFile MyFile {get;set;}

    [ModelBinder(BinderType = typeof(FormDataJsonBinder))]
    public MyJson MyJson {get;set;}
}

请注意，您还需要在客户端中正确序列化您的 JSON 数据：

const formData = new FormData();
formData.append(`myFile`, file);
formData.append('myJson', JSON.stringify(obj));

上面的代码可以工作，但你也可以更进一步，定义一个自定义属性和一个自定义IModelBinderProvider，这样你就不需要每次都使用更冗长的ModelBinder属性。 .请注意，我为此重新使用了现有的 [FromForm] 属性，但您也可以定义自己的属性来代替。

public class FormDataJsonBinderProvider : IModelBinderProvider
{
    public IModelBinder GetBinder(ModelBinderProviderContext context)
    {
        if(context == null) throw new ArgumentNullException(nameof(context));

        // Do not use this provider for binding simple values
        if(!context.Metadata.IsComplexType) return null;

        // Do not use this provider if the binding target is not a property
        var propName = context.Metadata.PropertyName;
        var propInfo = context.Metadata.ContainerType?.GetProperty(propName);
        if(propName == null || propInfo == null) return null;

        // Do not use this provider if the target property type implements IFormFile
        if(propInfo.PropertyType.IsAssignableFrom(typeof(IFormFile))) return null;

        // Do not use this provider if this property does not have the FromForm attribute
        if(!propInfo.GetCustomAttributes(typeof(FromForm), false).Any()) return null;

        // All criteria met; use the FormDataJsonBinder
        return new FormDataJsonBinder();
    }
}

您需要将此模型绑定器提供程序添加到您的启动配置中，然后才会被拾取：

services.AddMvc(options =>
{
    // add custom model binders to beginning of collection
    options.ModelBinderProviders.Insert(0, new FormDataJsonBinderProvider())
});

那么你的 DTO 可以简单一点：

public class Dto
{
    public IFormFile MyFile {get;set;}

    [FromForm]
    public MyJson MyJson {get;set;}
}

您可以在 ASP.NET Core 文档中阅读有关自定义模型绑定的更多信息：https://docs.microsoft.com/en-us/aspnet/core/mvc/advanced/custom-model-binding