0

0

fastapi 如何实现 StreamingResponse 的分块传输大文件

舞夢輝影

舞夢輝影

发布时间:2026-01-23 20:04:02

|

839人浏览过

|

来源于php中文网

原创

StreamingResponse适合大文件传输,因其采用HTTP分块编码边读边发,避免内存溢出和延迟;需用生成器逐块yield字节流,禁用Nginx缓冲并设置正确headers。

fastapi 如何实现 streamingresponse 的分块传输大文件

StreamingResponse 为什么适合大文件传输

因为 StreamingResponse 不会把整个文件读进内存,而是边读边发,避免 OOM 和响应延迟。它底层用的是 HTTP chunked transfer encoding,客户端(比如浏览器curl)能边收边处理,对视频、日志、导出 CSV 等场景很实用。

但注意:FastAPI 默认不启用 gzip 压缩,且中间件(如 GZipMiddleware)可能干扰分块;Nginx 等反向代理默认会缓冲响应,必须显式关闭缓冲才能看到实时分块效果。

如何正确构造 StreamingResponse 返回文件流

核心是传一个可迭代对象(如生成器),每次 yield 一个 bytes 块。不能用 open(...).read(),否则全量加载就失去流的意义。

  • open(file_path, "rb") 配合 .read(chunk_size) 循环 yield,推荐 chunk_size=8192(8KB)——太小增加 syscall 开销,太大削弱“流感”
  • 必须设置 media_type(如 "application/octet-stream"),否则浏览器可能无法识别下载行为
  • 建议加 headers={"Content-Disposition": 'attachment; filename="xxx.bin"'} 触发下载而非内嵌预览
  • 别在生成器里做耗时操作(如数据库查询、网络请求),否则阻塞整个流
from fastapi import FastAPI
from fastapi.responses import StreamingResponse

app = FastAPI()

def file_stream(path: str):
    with open(path, "rb") as f:
        while chunk := f.read(8192):
            yield chunk

@app.get("/download")
def download_file():
    return StreamingResponse(
        file_stream("/path/to/big.zip"),
        media_type="application/zip",
        headers={"Content-Disposition": 'attachment; filename="big.zip"'}
    )

为什么 Nginx 会吞掉 chunk,怎么破

默认配置下,Nginx 会等整个响应结束才转发给客户端,导致“卡住几秒后突然下载完成”。这不是 FastAPI 的问题,而是反向代理的缓冲策略。

  • 在 location 块中加 proxy_buffering off;
  • 同时禁用缓存相关头:proxy_cache off;proxy_http_version 1.1;chunked_transfer_encoding on;
  • 如果用了 proxy_redirectproxy_set_header,确保没覆盖 Transfer-Encoding

验证是否生效:用 curl -v http://your-domain/download,看响应头是否有 Transfer-Encoding: chunked,且 body 是分段打印的(不是一次性吐完)。

Magic AI Avatars
Magic AI Avatars

神奇的AI头像,获得200多个由AI制作的自定义头像。

下载

异步文件读取能否提升性能

不能直接用 asyncio.open()(标准库不支持),但可用 anyio.Pathaiopath 实现真正异步 IO。不过对单个大文件流来说,同步 read() + yield 已足够——瓶颈通常在磁盘或网络,不是 Python 线程阻塞。

真正需要异步的场景是:多个并发流共享同一文件句柄、或需在读取过程中穿插其他 await 操作(如权限校验、审计日志)。这时建议用 starlette.background.BackgroundTasks 或拆成独立任务,而不是强行套 async def + 同步 open

容易忽略的一点:如果文件路径来自用户输入,务必做路径净化(如 pathlib.Path(file_param).resolve().relative_to(allowed_root)),否则 ../ 可能导致任意文件读取。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

246

2023.07.27

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

522

2023.08.04

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

610

2023.08.04

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

244

2024.02.23

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

693

2024.07.09

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

3618

2024.08.07

nginx部署php项目教程汇总
nginx部署php项目教程汇总

本专题整合了nginx部署php项目教程汇总,阅读专题下面的文章了解更多详细内容。

54

2026.01.13

nginx配置文件详细教程
nginx配置文件详细教程

本专题整合了nginx配置文件相关教程详细汇总,阅读专题下面的文章了解更多详细内容。

72

2026.01.13

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号