在ASP.NET Core Web API中上传文件和JSON

Question

如何使用多部分上载将文件（图像）列表和json数据上载到ASP.NET Core Web API控制器？

我可以成功接收文件列表，上载的文件类型为multipart/form-data，内容类型如下：

public async Task<IActionResult> Upload(IList<IFormFile> files)

当然，我可以使用默认的JSON格式化程序成功接收格式化为对象的HTTP请求主体，如下所示：

public void Post([FromBody]SomeObject value)

但是我如何在一个单独的控制器动作中组合这两个呢？如何上传图像和JSON数据并将它们绑定到对象？

Answer 1

有一个更简单的解决方案，受到安德里乌斯答案的强烈启发。通过使用modelbinderattribute，您不必指定模型或绑定程序提供程序。这节省了大量的代码。您的控制器操作如下所示：

public IActionResult Upload(
    [ModelBinder(BinderType = typeof(JsonModelBinder))] SomeObject value,
    IList<IFormFile> files)
{
    // Use serialized json object 'value'
    // Use uploaded 'files'
}

JsonModelBinder背后的代码（请参阅GitHub或使用NuGet包）：

using System;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc.ModelBinding;

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

        // Check the value sent in
        var valueProviderResult = bindingContext.ValueProvider.GetValue(bindingContext.ModelName);
        if (valueProviderResult != ValueProviderResult.None) {
            bindingContext.ModelState.SetModelValue(bindingContext.ModelName, valueProviderResult);

            // Attempt to convert the input value
            var valueAsString = valueProviderResult.FirstValue;
            var result = Newtonsoft.Json.JsonConvert.DeserializeObject(valueAsString, bindingContext.ModelType);
            if (result != null) {
                bindingContext.Result = ModelBindingResult.Success(result);
                return Task.CompletedTask;
            }
        }

        return Task.CompletedTask;
    }
}

下面是上面的控制器操作upload接受的原始http请求的示例。

绑定到IFormFile的文件还需要指定一个FileName,如请求的第二部分所示。content-type不是必需的。

另一个需要注意的是，json部分需要可以反序列化为controller操作中定义的参数类型。因此，在本例中，类型SomeObject应该具有类型为String的属性Key。

POST http://localhost:5000/home/upload HTTP/1.1
Host: localhost:5000
Content-Type: multipart/form-data; boundary=12345
Content-Length: 218

--12345
Content-Disposition: form-data; name="value"

{"key": "value"}
--12345
Content-Disposition: form-data; name="files"; filename="file.txt"
Content-Type: text/plain

This is a simple text file
--12345--

可以使用Postman调用操作并测试服务器端代码。这是相当简单的，主要是UI驱动的。创建一个新的请求并在Body-Tab中选择form-data。现在您可以为Reqeust的每个部分在text和file之间进行选择。