使用最小 WEB API 實現文件上傳會遇到的坑

Posted on by

前言：

在 .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 暫時不要用於生產項目。

到此這篇關於使用最小 WEB API 實現文件上傳會遇到的坑的文章就介紹到這瞭,更多相關最小 WEB API 實現文件上傳內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：