使用 FileStreamResult 可高效返回文件流,适用于下载场景。1. 通过 File() 方法返回 FileStreamResult,指定 MIME 类型和文件名;2. 推荐异步方式提升性能,FileStream 启用 useAsync: true;3. 内存生成文件可用 MemoryStream,适合小文件导出;4. 大文件应使用 PhysicalFile 并启用 enableRangeProcessing 支持断点续传。注意流释放与内存优化,合理选择流类型以平衡性能与资源消耗。

在 .NET Web API 中返回文件流,通常用于实现文件下载功能,比如导出报表、下载图片或文档等。核心目标是将文件以流的形式发送给客户端,避免加载整个文件到内存中造成性能问题。以下是几种常见的实现方式。
使用 FileStreamResult 返回文件流
这是最常用的方式,适用于从服务器磁盘或网络路径读取文件并返回给客户端。
示例代码:
[HttpGet]
public FileStreamResult DownloadFile()
{
var filePath = @"C:\temp\example.pdf";
var fileStream = new FileStream(filePath, FileMode.Open, FileAccess.Read);
var fileName = Path.GetFileName(filePath);
return File(fileStream, "application/pdf", fileName);
}
说明:
- File() 是 ControllerBase 提供的辅助方法,可创建 FileStreamResult。
- 第二个参数是 MIME 类型,如 application/pdf、image/jpeg、application/octet-stream(通用二进制流)。
- 第三个参数指定下载时的默认文件名。
异步返回文件流(推荐)
为提升响应性和吞吐量,建议使用异步方式处理文件流。
[HttpGet] public async TaskDownloadFileAsync() { var filePath = @"C:\temp\largefile.zip"; var stream = new FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.Read, 4096, useAsync: true); return File(stream, "application/zip", "download.zip"); }
注意:ASP.NET Core 会自动管理流的释放,但需确保 FileStream 正确打开且未被提前关闭。
从内存流返回数据
当文件内容在内存中生成(如导出 Excel、PDF 等),可使用 MemoryStream。
[HttpGet]
public IActionResult ExportData()
{
byte[] fileBytes = GeneratePdf(); // 假设这是一个生成 PDF 字节数组的方法
var stream = new MemoryStream(fileBytes);
return File(stream, "application/pdf", "report.pdf");
}
特点:
- MemoryStream 适合小文件(一般建议不超过几十 MB)。
- 大文件应避免全部加载到内存,优先使用 FileStream 或分块传输。
处理大文件与断点续传(高级场景)
对于大文件下载,可结合 Range 头支持 实现断点续传,但默认 FileStreamResult 不支持。需要使用 PhysicalFileResult 或自定义中间件。
简单示例:
[HttpGet]
public IActionResult DownloadLargeFile()
{
var filePath = @"C:\temp\bigdata.iso";
return PhysicalFile(filePath, "application/octet-stream", enableRangeProcessing: true);
}
enableRangeProcessing: true 启用范围请求支持,允许客户端断点续传。
基本上就这些。根据文件来源选择合适的流返回方式,注意资源释放和性能影响。使用 FileStream 处理大文件,MemoryStream 用于动态生成的小文件,生产环境建议启用异步和范围处理。不复杂但容易忽略细节。








