FastAPI/FastUI 文件下载功能实现详解

背景介绍

在现代Web应用中，文件下载是一个常见的功能需求。本文将以FastAPI和FastUI框架为例，详细介绍如何实现高效、安全的文件下载功能，包括动态生成文件和静态文件下载两种场景。

核心实现方案

1. 基础文件下载实现

FastAPI提供了两种主要的文件下载方式：

1. 静态文件下载：使用FileResponse返回服务器上的物理文件
2. 动态流式下载：使用StreamingResponse返回动态生成的文件内容

from fastapi.responses import FileResponse, StreamingResponse
import io
import tempfile

# 静态文件下载示例
@app.get("/download/static")
async def download_static():
    with tempfile.NamedTemporaryFile(delete=False) as temp_file:
        temp_file.write(b"Sample file content")
    return FileResponse(temp_file.name, filename="example.txt")

# 流式下载示例
@app.get("/download/stream")
async def download_stream():
    file_bytes = io.BytesIO(b"Dynamic file content")
    async def iterfile():
        yield file_bytes.getvalue()
    return StreamingResponse(iterfile(), headers={"Content-Disposition": "attachment; filename=dynamic.txt"})

2. 与FastUI组件集成

在FastUI框架中，可以通过Link组件配合GoToEvent事件来实现文件下载链接：

from fastui import components as c
from fastui.events import GoToEvent

download_links = [
    c.Link(
        components=[c.Text(text="下载静态文件")],
        on_click=GoToEvent(url="/download/static", target="_blank")
    ),
    c.Link(
        components=[c.Text(text="下载动态文件")],
        on_click=GoToEvent(url="/download/stream", target="_blank")
    )
]

3. 高级功能实现

动态文件名设置

可以通过URL参数动态设置下载文件的名称：

@app.get("/download/custom")
async def download_custom(filename: str = "default.txt"):
    file_bytes = io.BytesIO(b"File with custom name")
    async def iterfile():
        yield file_bytes.getvalue()
    return StreamingResponse(
        iterfile(),
        headers={"Content-Disposition": f"attachment; filename={filename}"}
    )

文件内容动态生成

可以结合业务逻辑动态生成文件内容：

def generate_report(user_id: int) -> tuple[io.BytesIO, str]:
    # 模拟从数据库获取数据
    data = f"Report for user {user_id}\nGenerated at {datetime.now()}"
    file_bytes = io.BytesIO(data.encode())
    return file_bytes, f"user_{user_id}_report.txt"

@app.get("/download/report/{user_id}")
async def download_report(user_id: int):
    file_bytes, filename = generate_report(user_id)
    # 返回流式响应...

最佳实践建议

1. 安全性考虑：

   • 验证用户权限后再允许下载
   • 对文件名进行安全过滤，防止路径遍历攻击
   • 设置适当的Content-Type和Content-Disposition头

2. 性能优化：

   • 对于大文件，务必使用流式传输
   • 考虑实现断点续传功能
   • 可以添加缓存控制头

3. 用户体验：

   • 提供明确的下载进度指示
   • 考虑在UI中添加文件大小信息
   • 处理下载失败时的友好提示

常见问题解决方案

1. 认证问题： 如果需要认证后才能下载，确保下载端点也受到保护。可以使用FastAPI的依赖注入系统：

from fastapi import Depends
from fastapi.security import OAuth2PasswordBearer

oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

@app.get("/protected-download")
async def protected_download(token: str = Depends(oauth2_scheme)):
    # 验证token逻辑...
    # 返回文件...

2. 大文件处理： 对于超大文件，建议使用分块传输：

async def file_sender(file_path: str):
    with open(file_path, "rb") as f:
        while chunk := f.read(65536):  # 64KB chunks
            yield chunk

@app.get("/download/large")
async def download_large():
    return StreamingResponse(
        file_sender("large_file.iso"),
        media_type="application/octet-stream"
    )

总结

本文详细介绍了在FastAPI和FastUI框架中实现文件下载功能的多种方法。通过合理选择静态文件响应或流式响应，开发者可以满足不同场景下的文件下载需求。结合FastUI的组件系统，可以轻松构建用户友好的下载界面。在实际应用中，还需要考虑安全性、性能和用户体验等因素，才能打造出完善的下载功能。