在 ASP.NET Core Web API 中处理文件下载

尝试从 ASP.NET Web API 控制器返回文件时，您可能会遇到以下问题：响应被视为 JSON。要解决此问题，了解在 ASP.NET Core 中下载文件的正确方法至关重要。

要在 ASP.NET Core Web API 中返回文件，您需要返回派生的 IActionResult 而不是 HttpResponseMessage。该框架会将 HttpResponseMessage 解释为模型，从而导致 JSON 响应问题。

下面是更新的代码示例，演示如何使用 IActionResult 返回文件：

[Route("api/[controller]")]
public class DownloadController : Controller
{
    // GET api/download/12345abc
    [HttpGet("{id}")]
    public async Task Download(string id)
    {
        Stream stream = await GetStreamBasedOnIdAsync(id);

        if (stream == null)
            return NotFound(); // Returns a NotFoundResult with Status404NotFound response

        return File(stream, "application/octet-stream", $"{FileName}.{FileExtension}"); // Returns a FileStreamResult
    }
}

注意： 不要对流使用 using 语句；否则，它将在发送响应之前被丢弃，从而导致异常或损坏的响应。当响应完成时，框架将自动处理流处理。