.NET Web API如何返回一个文件流

来源:这里教程网 时间:2026-02-21 17:29:08 作者:

在 .NET Web API 中返回文件流,通常用于提供文件下载功能,比如导出报表、下载图片或文档等。核心是使用 FileStreamResult 或其基类 FileResult,结合 ControllerBase.File 方法来实现。

1. 返回本地文件流

如果文件存储在服务器本地路径中,可以通过 FileStream 打开并返回:

[HttpGet("download")]
public IActionResult DownloadFile()
{
    var filePath = @"C:\uploads\example.pdf";
    var fileExists = System.IO.File.Exists(filePath);
<pre class='brush:php;toolbar:false;'>if (!fileExists)
    return NotFound("文件未找到");
var stream = new FileStream(filePath, FileMode.Open, FileAccess.Read);
var contentType = "application/pdf";
var fileName = "example.pdf";
return File(stream, contentType, fileName);

}

说明:
- File(stream, contentType, fileName) 是 ControllerBase 提供的便捷方法。
- 浏览器接收到响应后会根据文件名触发下载。
- contentType 决定浏览器如何处理该文件(如显示或下载)。

2. 返回内存中的文件流(MemoryStream)

适用于动态生成的文件,例如导出 Excel、PDF 或压缩包:

[HttpGet("export")]
public IActionResult ExportData()
{
    var memoryStream = new MemoryStream();
    // 模拟写入数据
    var data = "Hello, this is exported content.";
    var bytes = Encoding.UTF8.GetBytes(data);
    memoryStream.Write(bytes, 0, bytes.Length);
    memoryStream.Position = 0;
<pre class='brush:php;toolbar:false;'>return File(memoryStream, "text/plain", "data.txt");

}

注意:MemoryStream 必须将 Position 重置为 0,否则读取不到内容。

3. 设置响应头优化下载体验

可以手动控制响应行为,比如强制下载而不尝试在浏览器中打开:

实际效果由浏览器决定,但设置合适的 MIME 类型和文件扩展名能提高准确性。

常见 MIME 类型示例:
- .txt → text/plain
- .pdf → application/pdf
- .xlsx → application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
- .zip → application/zip

4. 异步方式返回文件流(推荐)

对于大文件或 I/O 密集操作,建议使用异步方法提升性能:

[HttpGet("download-async")]
public async Task<IActionResult> DownloadFileAsync()
{
    var filePath = @"C:\uploads\largefile.zip";
<pre class='brush:php;toolbar:false;'>if (!System.IO.File.Exists(filePath))
    return NotFound();
var stream = new FileStream(filePath, FileMode.Open, FileAccess.Read, 
                           FileShare.Read, 4096, useAsync: true);
return File(stream, "application/zip", "download.zip");

}

.NET 会自动管理流的释放,无需手动调用 Dispose()。

基本上就这些。只要正确使用 File() 方法传入流、MIME 类型和文件名,就能让 Web API 成功返回文件流。

相关推荐