Web API技术咨询：如何正确提交包含文件的对象？

嘿，我来帮你搞定这个问题！你的核心问题在于不能用JSON来提交包含文件的对象——HttpPostedFileBase是一个包含文件流的类型，没办法直接序列化成JSON字符串，而且外部API也没法从JSON里解析出实际的文件内容。咱们一步步修正：

先说说你当前代码的问题 #

• 你把MediaModel序列化成JSON并用StringContent以application/json格式提交，这对带文件的场景完全不适用。HttpPostedFileBase里的文件流会被序列化成毫无意义的类型字符串，API那边根本拿不到真实的文件数据。
• 外部API的Upload方法直接接收MediaModel参数，在传统ASP.NET WebAPI里，默认的模型绑定没法从JSON里解析出HttpPostedFileBase类型的属性。

正确的实现方案 #

我们需要改用multipart/form-data格式提交请求，这是专门用来传输文件+普通表单字段的标准格式。

第一步：修改MVC控制器的提交逻辑 #

替换掉原来的JSON序列化逻辑，用MultipartFormDataContent构建请求：

[HttpPost]
[Authorize]
public async Task<ActionResult> Edit(ViewModels.Client client)
{
    var media = new MediaModel()
    {
        EntityId = client.Id,
        Image = client.Photo,
        AccountId = client.AccountId
    };

    string apiUrl = "http://localhost:11436/api/Client/Media/Upload";
    using (HttpClient httpClient = new HttpClient())
    {
        using (var content = new MultipartFormDataContent())
        {
            // 添加普通文本字段（名称要和API模型的属性名完全一致）
            content.Add(new StringContent(media.AccountId), "AccountId");
            content.Add(new StringContent(media.EntityId), "EntityId");

            // 添加文件部分
            if (media.Image != null && media.Image.ContentLength > 0)
            {
                var fileStreamContent = new StreamContent(media.Image.InputStream);
                fileStreamContent.Headers.ContentType = MediaTypeHeaderValue.Parse(media.Image.ContentType);
                // 第三个参数是文件名，第二个参数"Image"要和API接收的文件参数名一致
                content.Add(fileStreamContent, "Image", media.Image.FileName);
            }

            HttpResponseMessage response = await httpClient.PostAsync(apiUrl, content);
            if (response.IsSuccessStatusCode)
            {
                // 这里写请求成功后的逻辑
            }
        }
    }

    return View(client);
}

第二步：调整外部API的接收逻辑 #

根据你的WebAPI版本，有两种实现方式：

方式1：传统ASP.NET WebAPI（.NET Framework）

传统WebAPI没法直接绑定HttpPostedFileBase到模型，需要手动解析多部分表单数据：

[Route("Upload")]
[HttpPost]
public async Task<IHttpActionResult> Upload()
{
    // 创建临时文件提供者，用来保存上传的文件片段
    var tempProvider = new MultipartFormDataStreamProvider(Path.GetTempPath());
    await Request.Content.ReadAsMultipartAsync(tempProvider);

    // 读取普通表单字段
    string accountId = tempProvider.FormData.GetValues("AccountId")?.FirstOrDefault();
    string entityId = tempProvider.FormData.GetValues("EntityId")?.FirstOrDefault();

    // 读取上传的文件
    var fileEntry = tempProvider.FileData.FirstOrDefault(f => 
        f.Headers.ContentDisposition.Name.Replace("\"", "") == "Image");
    
    if (fileEntry != null)
    {
        // 这里可以读取临时文件的内容，比如保存到指定目录或数据库
        using (var fileStream = new FileStream(fileEntry.LocalFileName, FileMode.Open))
        {
            // 处理文件逻辑，例如：await fileStream.CopyToAsync(targetStream);
        }
        // 用完记得删除临时文件
        File.Delete(fileEntry.LocalFileName);
    }

    // 验证必填字段
    if (string.IsNullOrEmpty(accountId) || string.IsNullOrEmpty(entityId))
    {
        return BadRequest("AccountId和EntityId为必填项");
    }

    return Ok();
}

方式2：ASP.NET Core WebAPI（推荐）

如果是ASP.NET Core，直接用IFormFile类型接收文件，模型绑定会自动处理：

// 先更新MediaModel的Image属性类型
public class MediaModel
{
    [Required]
    public string AccountId{ get; set; } 
    [Required]
    public string EntityId { get; set; } 
    public IFormFile Image { get; set; } 
}

// 然后修改API方法
[Route("Upload")]
[HttpPost]
public async Task<IActionResult> Upload([FromForm] MediaModel media)
{
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }

    if (media.Image != null)
    {
        // 示例：保存文件到wwwroot目录
        var savePath = Path.Combine(Directory.GetCurrentDirectory(), "wwwroot", media.Image.FileName);
        using (var stream = new FileStream(savePath, FileMode.Create))
        {
            await media.Image.CopyToAsync(stream);
        }
    }

    return Ok();
}

关键注意事项 #

• 提交请求的格式必须是multipart/form-data，绝对不能用application/json传输文件
• 控制器中添加字段/文件时的名称（比如"AccountId"、"Image"）必须和API接收的名称完全一致
• 传统WebAPI和ASP.NET Core的文件接收逻辑差异较大，要根据自己的框架版本选择对应实现

内容的提问来源于stack exchange，提问作者D-W