Question

我正在尝试构建一个ASP.NET Core 1.1 Controller方法来处理如下所示的HTTP请求：

POST https://localhost/api/data/upload HTTP/1.1
Content-Type: multipart/form-data; boundary=--------------------------625450203542273177701444
Host: localhost
Content-Length: 474

----------------------------625450203542273177701444
Content-Disposition: form-data; name="file"; filename="myfile.txt"
Content-Type: text/plain

<< Contents of my file >>

----------------------------625450203542273177701444
Content-Disposition: form-data; name="text"
Content-Type: application/json

{"md5":"595f44fec1e92a71d3e9e77456ba80d0","sessionIds":["123","abc"]}
----------------------------625450203542273177701444--

这是multipart/form-data请求，其中一部分是（小）文件，另一部分是基于提供的规范的json blob。

理想情况下，我喜欢我的控制器方法：

[HttpPost]
public async Task Post(UploadPayload payload)
{
   // TODO
}

public class UploadPayload
{
    public IFormFile File { get; set; }

    [Required]
    [StringLength(32)]
    public string Md5 { get; set; }

    public List<string> SessionIds { get; set; }
}

但是，唉，这不是Just Work {TM}。如果我这样，IFormFile 会填充，但json字符串不会反序列化到其他属性。

我还尝试向Text添加UploadPayload属性，该属性具有IFormFile以外的所有属性，但也不接收数据。 E.g。

public class UploadPayload
{
    public IFormFile File { get; set; }

    public UploadPayloadMetadata Text { get; set; }
}

public class UploadPayloadMetadata
{
    [Required]
    [StringLength(32)]
    public string Md5 { get; set; }

    public List<string> SessionIds { get; set; }
}

我的解决方法是避免模型绑定并使用MultipartReader的行：

[HttpPost]
public async Task Post()
{
   ...

   var reader = new MultipartReader(Request.GetMultipartBoundary(), HttpContext.Request.Body);

   var section = await reader.ReadNextSectionAsync();
   var filePart = section.AsFileSection();

   // Do stuff & things with the file

   section = await reader.ReadNextSectionAsync();
   var jsonPart = section.AsFormDataSection();
   var jsonString = await jsonPart.GetValueAsync();

   // Use $JsonLibrary to manually deserailize into the model
   // Do stuff & things with the metadata

   ...
}

执行上述操作会绕过模型验证功能等。另外，我想也许我可以接受jsonString，然后以某种方式将其置于一个我可以调用await TryUpdateModelAsync(payloadModel, ...)但无法计算的状态如何到达那里 - 这似乎也不那么干净。

是否有可能像我的第一次尝试一样达到我想要的“透明”模型绑定状态？如果是这样，那怎么会这样呢？

Answer 1

这里的第一个问题是需要以稍微不同的格式从客户端发送数据。您的UploadPayload类中的每个属性都需要以自己的形式发送：

const formData = new FormData();
formData.append(`file`, file);
formData.append('md5', JSON.stringify(md5));
formData.append('sessionIds', JSON.stringify(sessionIds));

执行此操作后，您可以将[FromForm]属性添加到MD5属性以将其绑定，因为它是一个简单的字符串值。这不适用于SessionIds属性，因为它是一个复杂的对象。

可以使用自定义模型绑定器来完成从表单数据绑定复杂JSON：

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 UploadPayload
{
    public IFormFile File { get; set; }

    [Required]
    [StringLength(32)]
    [FromForm]
    public string Md5 { get; set; }

    [ModelBinder(BinderType = typeof(FormDataJsonBinder))]
    public List<string> SessionIds { get; set; }
}

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

Answer 2

我不是100％清楚这对于ASP.NET Core如何工作，而是对于Web API（所以我假设这里存在类似的路径）你想要走下Media Formatter的道路。这是一个例子（与您的问题非常相似）Github Sample with blog post

自定义格式化程序可能是票证？ https://docs.microsoft.com/en-us/aspnet/core/mvc/advanced/custom-formatters

ASP.NET Core 1.1中的multipart / form-data（File + JSON）帖子的模型绑定

2 个答案: