Starlette如何处理文件上传

冬杰吖_5823

冬杰吖_5823

2026-11-18

206人浏览

原创

starlette 处理文件上传的核心机制是依赖 asgi 服务器(如 uvicorn)将请求体解析为 multipart/form-data 格式,并通过 request 对象的 form() 方法提取数据。开发者只需在路由中接收 starlette.requests.request 实例,调用其 await request.form() 即可获取包含文件的字典对象,随后通过 file.file.read() 读取内容或 file.filename 获取文件名。需要注意的是,如果上传的文件较大,必须使用异步流式读取以避免阻塞事件循环,且务必对文件名进行安全校验以防止路径遍历攻击。

Starlette如何处理文件上传

如何从 Request 对象中提取上传的文件

要从 HTTP 请求中获取上传的文件,必须在路由函数中声明参数类型为 Request,并在函数体内调用 await request.form()。该方法会返回一个类似字典的对象,其中键对应表单字段名,值可能是字符串(普通文本)或 UploadFile 对象(文件)。只有当请求的 Content-Type 为 multipart/form-data 时,此方法才有效;若为 application/json 或其他类型,则无法提取文件。提取后,可以通过检查值的类型是否为 UploadFile 来区分普通输入和文件输入。

Starlette如何处理文件上传

from starlette.applications import Starlette
from starlette.responses import JSONResponse
from starlette.routing import Route
from starlette.requests import Request
import os

async def upload_file(request: Request):
    # 1. 解析 multipart 表单数据
    form = await request.form()
    
    # 2. 获取名为 'avatar' 的文件
    file = form.get('avatar')
    
    if not file:
        return JSONResponse({"status": "error", "message": "No file uploaded"})
    
    # 3. 读取文件内容并保存
    contents = await file.read()
    filename = file.filename or "unknown"
    save_path = f"/tmp/uploads/{filename}"
    
    with open(save_path, "wb") as f:
        f.write(contents)
        
    return JSONResponse({
        "status": "success",
        "filename": filename,
        "size": len(contents)
    })

app = Starlette(routes=[Route("/upload", upload_file, methods=["POST"])])

上述代码展示了完整的提取流程:首先调用 request.form() 解析请求体,然后通过键名 'avatar' 获取 UploadFile 实例。接着使用 await file.read() 将文件内容全部读入内存,最后写入本地磁盘。对于小文件,这种全量读取方式是简单有效的。但如果需要处理大文件,应改用 await file.seek(0) 配合循环读取,或者直接使用 shutil.copyfileobj(file.file, dest) 进行流式拷贝,以节省内存。

如何处理大文件上传以避免内存溢出

当上传的文件体积较大时,直接调用 await file.read() 会将整个文件加载到内存中,可能导致进程 OOM(Out of Memory)。正确的做法是利用 UploadFile.file 属性提供的底层文件对象,该对象支持异步迭代或分块读取。通过创建一个目标文件句柄,并使用 shutil.copyfileobj 或手动循环读取固定大小的块(如 8KB),可以将数据从上传缓冲区逐步写入磁盘,而无需一次性占用大量内存。此外,还可以设置 max_size 限制来拒绝过大的文件。

Starlette 1.5.1
Starlette 1.5.1

Starlette 1.5.1 是轻量级 Python ASGI 框架与工具集,提供路由、请求响应、中间件、WebSocket 和后台任务等组件,适合构建异步 Web 服务。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理依赖;运行应用时还需配置 ASGI 服务器。

下载
import shutil
from starlette.applications import Starlette
from starlette.responses import JSONResponse
from starlette.routing import Route
from starlette.requests import Request

async def upload_large_file(request: Request):
    form = await request.form()
    file = form.get('large_video')
    
    if not file:
        return JSONResponse({"status": "error", "message": "No file"})
    
    # 安全检查:验证文件名
    safe_filename = file.filename.replace('/', '_').replace('\', '_')
    save_path = f"/tmp/uploads/{safe_filename}"
    
    try:
        # 使用流式拷贝,避免全量加载到内存
        with open(save_path, 'wb') as f_out:
            # file.file 是底层的可读流
            shutil.copyfileobj(file.file, f_out)
            
        return JSONResponse({
            "status": "success",
            "filename": safe_filename,
            "method": "streaming_copy"
        })
    except Exception as e:
        return JSONResponse({"status": "error", "message": str(e)})

app = Starlette(routes=[Route("/upload/stream", upload_large_file, methods=["POST"])])

在这段代码中,我们不再使用 read(),而是访问 file.file 获取底层的 IO 流。通过 shutil.copyfileobj,数据以小块形式从上传流复制到磁盘文件。这种方式在处理 GB 级别的视频或镜像文件时非常关键,因为它保持了恒定的内存占用。同时,代码中对文件名进行了清理,移除了可能引起路径遍历的斜杠字符,确保存储安全。

如何防止恶意用户上传危险文件

在处理文件上传时,安全性至关重要。攻击者可能上传可执行脚本、Webshell 或利用路径遍历漏洞覆盖系统文件。因此,必须实施多重防护:第一,严格校验文件扩展名和 MIME 类型,只允许预期的类型(如 image/jpeg, application/pdf);第二,对文件名进行 sanitization(净化),去除路径分隔符,并使用随机生成的 ID 重命名文件,避免直接使用用户提供的文件名;第三,设置文件大小上限,防止 DoS 攻击。Starlette 本身不自动执行这些安全检查,开发者需要在业务逻辑中显式实现。

import uuid
import mimetypes
from starlette.applications import Starlette
from starellite.responses import JSONResponse
from starlette.routing import Route
from starlette.requests import Request

ALLOWED_EXTENSIONS = {'.jpg', '.jpeg', '.png', '.pdf'}
MAX_FILE_SIZE = 5 * 1024 * 1024  # 5MB

async def secure_upload(request: Request):
    form = await request.form()
    file = form.get('document')
    
    if not file:
        return JSONResponse({"status": "error", "message": "Missing file"})
    
    # 1. 检查文件大小
    content = await file.read()
    if len(content) > MAX_FILE_SIZE:
        return JSONResponse({"status": "error", "message": "File too large"})
    
    # 2. 检查扩展名
    ext = mimetypes.guess_extension(file.content_type) or ''
    # 简化处理:直接检查后缀
    _, ext = os.path.splitext(file.filename or '')
    if ext.lower() not in ALLOWED_EXTENSIONS:
        return JSONResponse({"status": "error", "message": "Invalid extension"})
    
    # 3. 生成唯一文件名并保存
    unique_name = f"{uuid.uuid4().hex}{ext}"
    save_path = f"/secure_uploads/{unique_name}"
    
    with open(save_path, 'wb') as f:
        f.write(content)
        
    return JSONResponse({"status": "success", "filename": unique_name})

app = Starlette(routes=[Route("/upload/secure", secure_upload, methods=["POST"])])

该示例展示了完整的安全策略:首先读取内容以检查大小,然后结合 mimetypes 和用户提供的文件名扩展名进行双重验证。最关键的是,即使文件名合法,我们也使用 uuid.uuid4() 生成一个新的随机文件名进行存储,彻底消除了路径遍历的风险。这种“白名单+随机重命名”的模式是生产环境中处理文件上传的标准实践。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

starlette

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

2025.12.22

119

5

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

2026.02.06

594

18

Python Web框架FastAPI 全栈开发教程合集
Python Web框架FastAPI 全栈开发教程合集

以 FastAPI 为核心,讲解现代 Python Web API 的高效开发方式,涵盖路由定义与路径参数/查询参数/请求体绑定、Pydantic 模型的数据校验与序列化、依赖注入(Depends)系统的分层设计、中间件与 CORS 配置、OAuth2 + JWT 认证流程、后台任务(BackgroundTasks)、WebSocket 实时通信、SQLAlchemy 异步 ORM 集成、自动生成 OpenAPI/Swagger 交互文

2026.05.09

796

23

Python FastAPI异步微服务与高性能接口设计
Python FastAPI异步微服务与高性能接口设计

本专题聚焦 Python FastAPI 框架在高性能接口与微服务开发中的应用,讲解异步请求处理、依赖注入机制、路由设计、数据库异步操作以及接口性能优化策略。结合实际项目案例,帮助开发者构建高并发、低延迟的现代化后端服务架构。

2026.06.16

679

12

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

140

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

100

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

100

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

160

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

140

13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程