想说爱你不容易 | 使用最小 WEB API 实现文件上传

Posted 2022-02-22 dotNET跨平台

前言

在 .NET 6 之前，实现文件上传功能十分简单：

[HttpPost("upload")]
public async Task<IActionResult> Upload(IFormFile file)

    //对file执行操作

    return Ok(file.FileName);

但是，当使用 .NET 6 的最小 WEB API 来实现相同功能时，却意外地遇到了不少坑。

实现代码

转换为最小 WEB API 来实现后，代码是这样的：

app.MapPost("/upload", async (IFormFile file) =>

    return Results.Ok(file.FileName);
)；

但是，在使用相同的客户端代码调用时，却返回了 HTTP 415 错误:

允许 Content Type

这是由于上传文件时，使用的 Content-Type 不是默认的 application/json，而是 multipart/form-data

在 dotnet/aspnetcore 的 issues 中，我们找到了相关解决方案（https://github.com/dotnet/aspnetcore/issues/35082）：

修改代码如下：

app.MapPost("/upload", async (IFormFile file) =>

    return Results.Ok(file.FileName);
).Accepts<IFormFile>("multipart/form-data");

结果，还是返回了415错误。更奇怪的是，多出来了一堆错误堆栈信息:

惊现 BUG

于是，想通过查看代码方式找到问题。

使用错误信息“Expected a supported JSON media type but got”，我们定位到了源代码文件 Http/Http.Extensions/src/RequestDelegateFactory.cs:

但是，发现 master 分支和 v6.0.0 分支的代码，差别巨大。比如，master 分支有 IFormFile 相关代码，而 v6.0.0 上完全没有：

查看该文件的提交历史，我们找到了这样一条提交：

根据提交，我们找到了对应的 issue（https://github.com/dotnet/aspnetcore/issues/34303）：

看来，要想支持 IFormFile 参数，我们得等到2022年11月（.NET 7 预计发布日期）！！！

解决方案

幸好，该 issue 也提供了变通的解决方案，传入 HttpRequest 参数:

app.MapPost("/upload",
    async (HttpRequest request) =>
    
        var form = await request.ReadFormAsync();

        return Results.Ok(form.Files.First().FileName);
    );

验证成功。

结论

后面，我也尝试过在 .NET 6 中用以前的 Controller 方式实现，完全没问题。

看来最小 WEB API 是不同的实现机制，不确定还有不有其他的坑。

建议：最小 WEB API 暂时不要用于生产项目。