0

0

fastapi 如何实现文件下载响应且设置 Content-Disposition

舞姬之光

舞姬之光

发布时间:2026-01-24 19:27:10

|

224人浏览过

|

来源于php中文网

原创

FileResponse是最稳妥的文件下载方式,需设media_type为"application/octet-stream"并用headers设置Content-Disposition;动态文件用StreamingResponse,注意编码、分块yield及中文名用filename*兼容RFC 5987。

fastapi 如何实现文件下载响应且设置 content-disposition

FastAPI 中用 FileResponse 实现文件下载并设置 Content-Disposition

直接用 FileResponse 是最稳妥的方式,它自动处理文件流、MIME 类型和缓存头,且支持通过 headers 参数注入 Content-Disposition。关键点是:必须显式指定 media_type"application/octet-stream"(除非你希望浏览器尝试内联打开),否则某些文件类型(如 .txt.json)可能被浏览器直接渲染而非下载。

示例:

from fastapi import FastAPI
from fastapi.responses import FileResponse
import pathlib

app = FastAPI()

@app.get("/download")
def download_file():
    file_path = pathlib.Path("report.pdf")
    return FileResponse(
        path=file_path,
        media_type="application/octet-stream",
        headers={"Content-Disposition": 'attachment; filename="report.pdf"'}
    )
  • filename 值建议用英文或 URL 编码过的字符串;中文名在部分客户端(如旧版 Safari)可能乱码或截断,可考虑用 filename*=UTF-8''report%E6%8A%A5%E5%91%8A.pdf 格式
  • 如果文件路径来自用户输入,务必做路径校验(如用 pathlib.Path.resolve() 防止目录遍历)
  • FileResponse 不支持动态生成的字节流——此时得换 StreamingResponse

StreamingResponse 下载动态生成的文件(如 ZIP 或 CSV 流)

当文件内容不落地、需边生成边传输时,FileResponse 不适用,必须用 StreamingResponse,手动构造响应体和头。此时 Content-Disposition 仍靠 headers 传入,但 MIME 类型和响应体流需自己把控。

示例(生成 CSV 流):

Higgsfield
Higgsfield

电影级AI视频生成工具

下载
from fastapi import FastAPI
from fastapi.responses import StreamingResponse
import io
import csv

app = FastAPI()

@app.get("/export-csv")
def export_csv():
    def iter_csv():
        output = io.StringIO()
        writer = csv.writer(output)
        writer.writerow(["id", "name"])
        writer.writerow([1, "Alice"])
        yield output.getvalue().encode("utf-8")

    return StreamingResponse(
        iter_csv(),
        media_type="text/csv",
        headers={"Content-Disposition": 'attachment; filename="data.csv"'}
    )
  • 注意编码:CSV 流推荐用 utf-8,并在 media_type 后加 ; charset=utf-8 更明确
  • 流函数必须是可迭代的(Generator 或返回迭代器),不能直接 return 字符串
  • 大文件流场景下,避免在内存中拼接全部内容,应分块 yield

Content-Disposition 的两种取值:inline vs attachment

这个响应头决定浏览器行为:inline 表示允许内联显示(如 PDF 在浏览器中打开),attachment 强制触发下载对话框。实际使用中,绝大多数“下载”需求都该用 attachment,否则用户可能看不到文件保存动作。

  • 错误写法:Content-Disposition: inline; filename="log.txt" → 用户看到的是页面里一堆文本,不是下载
  • 正确写法:Content-Disposition: attachment; filename="log.txt"
  • 如果想兼容内联预览又保留下载能力,现代做法是前端fetch + Blob + URL.createObjectURL 控制,后端统一用 attachment

常见问题:中文文件名乱码或被截断

HTTP 协议本身不支持 UTF-8 文件名,RFC 5987 规定了 filename* 扩展语法。FastAPI 不自动处理,需手动构造。

安全写法(兼容主流浏览器):

from urllib.parse import quote

filename = "报告2024.xlsx"
encoded_filename = quote(filename.encode("utf-8"))
headers = {
    "Content-Disposition": f'attachment; filename="{filename}"; filename*=UTF-8\'\'{encoded_filename}'
}
  • 两个 filename 字段同时存在是故意的:老客户端读第一个,新客户端读 filename*
  • 不要只写 filename*,IE 和部分旧版本 Chrome 会忽略它
  • quote(...) 用的是 urllib.parse.quote,不是 quote_plus(空格应编码为 %20,不是 +
实际部署时,Nginx 等反向代理可能覆盖或清空 Content-Disposition,记得检查其配置里是否禁用了自定义头。

相关专题

更多
nginx 重启
nginx 重启

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

231

2023.07.27

nginx 配置详解
nginx 配置详解

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

501

2023.08.04

nginx配置详解
nginx配置详解

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

498

2023.08.04

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

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

232

2024.02.23

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

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

336

2024.07.09

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

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

3510

2024.08.07

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

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

24

2026.01.13

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

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

27

2026.01.13

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

20

2026.01.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.5万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

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

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