0

0

Python Starlette 中间件的编写规范

舞夢輝影

舞夢輝影

发布时间:2026-02-22 21:50:03

|

153人浏览过

|

来源于php中文网

原创

starlette中间件必须是接受app、scope、receive、send四参数的异步函数,且顺序不可错;需用工厂模式支持配置;修改请求/响应须流式处理并确保send调用完整;异常处理须先send再raise;调试宜用print(scope["path"])定位。

python starlette 中间件的编写规范

Starlette 中间件必须是 callable,且参数顺序不能错

Starlette 要求中间件必须是接受 appscopereceivesend 三参数的异步函数(或返回该函数的工厂),否则直接报 TypeError: middleware must be a callable 或运行时 RuntimeError: Expected scope to be a dict

常见错误是写成同步函数、漏掉 scope、或把 receive/send 放在错误位置。正确签名只有一种:

async def my_middleware(app, scope, receive, send):

如果需要配置参数(比如日志前缀),必须用工厂模式:

def make_logging_middleware(prefix="REQ"):  
    async def middleware(app, scope, receive, send):  
        # ...  
    return middleware
  • 不能写成 async def middleware(app, receive, send, scope) —— Starlette 按固定顺序解包
  • 不能省略 scope:它是 ASGI 生命周期的上下文入口,含 typepathheaders 等关键字段
  • 若在中间件里调用 await receive(),必须确保后续也调用 await send(...),否则连接挂起

修改请求/响应体需用 StreamingResponse 或重写 body 字段

Starlette 中间件无法像 Flask 那样直接改 request.bodyresponse.body —— 因为 ASGI 协议中 body 是通过 receive 流式接收、send 流式发送的。想篡改内容,得自己拼接完整 body 再构造新响应。

立即学习Python免费学习笔记(深入)”;

典型场景:统一添加响应头、记录原始请求体、过滤敏感字段。错误做法是试图给 scope["body"] 赋值(它根本不存在);正确路径是拦截 receive、缓存数据,再用 StreamingResponseResponse 重发。

阿里云AI平台
阿里云AI平台

阿里云AI平台

下载
  • 读取完整 body:需循环 await receive() 直到 message["type"] == "http.request""more_body": False
  • 若只读不改,记得把收到的每条 message 原样传给下游 await send(message),否则请求中断
  • 性能敏感场景慎用:读取全部 body 会阻塞整个流,大文件上传时可能 OOM;建议按需判断 scope["method"]scope["path"] 再决定是否缓冲

异常处理必须 await send() 后再 raise,否则 500 页面不显示

在中间件里捕获异常后,如果直接 raise,Starlette 默认异常处理器可能收不到完整 scope,导致返回空白响应或 500 但无 traceback。必须手动调用 send() 发送状态行和 headers,再抛出。

例如记录错误并返回 JSON 错误页:

try:  
    await self.app(scope, receive, send)  
except Exception as exc:  
    await send({  
        "type": "http.response.start",  
        "status": 500,  
        "headers": [(b"content-type", b"application/json")],  
    })  
    await send({  
        "type": "http.response.body",  
        "body": b'{"error": "Internal server error"}',  
        "more_body": False,  
    })  
    raise
  • 漏掉 await send(...) 就等于没发 HTTP 响应头,客户端一直等待
  • raise 必须在 send 之后,否则异常中断执行流,send 不会被执行
  • 不要在中间件里吞掉异常(如只 log 不 raise),否则上层异常处理器失效,debug 成本陡增

调试中间件顺序:用 print + scope["path"] 快速定位执行点

Starlette 的中间件是嵌套调用的,外层中间件的 send 实际是内层中间件的 send,容易搞不清哪一层在处理哪个请求。最轻量的调试方式是在每个中间件开头加一行 print(f"[{name}] {scope['path']}")

注意 scope["path"] 是原始路径(未被路由解析),而 scope.get("route") 通常为空——因为路由匹配发生在中间件之后。所以不能靠 route 判断是否命中某 endpoint。

  • 多个中间件共用同一份 scope 字典,但它是只读的;修改 scope["path"] 不会影响后续路由(Starlette 路由器用的是副本)
  • 测试时用 curl -v http://localhost:8000/api/v1/users 比看日志更直观:能立刻看到哪些中间件被触发、顺序是否符合预期
  • 生产环境禁用 print;替换为 structlog 或 logging.getLogger(__name__).debug(),且确保 level >= DEBUG

中间件不是万能胶,它看不到路由参数、拿不到依赖注入后的 request 对象,所有“业务逻辑级”操作(比如验证 JWT、获取当前用户)更适合放在 route handler 或依赖项里。强行塞进中间件,只会让 scope 变脏、调试变难、复用性归零。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
Python Flask框架
Python Flask框架

本专题专注于 Python 轻量级 Web 框架 Flask 的学习与实战,内容涵盖路由与视图、模板渲染、表单处理、数据库集成、用户认证以及RESTful API 开发。通过博客系统、任务管理工具与微服务接口等项目实战,帮助学员掌握 Flask 在快速构建小型到中型 Web 应用中的核心技能。

97

2025.08.25

Python Flask Web框架与API开发
Python Flask Web框架与API开发

本专题系统介绍 Python Flask Web框架的基础与进阶应用,包括Flask路由、请求与响应、模板渲染、表单处理、安全性加固、数据库集成(SQLAlchemy)、以及使用Flask构建 RESTful API 服务。通过多个实战项目,帮助学习者掌握使用 Flask 开发高效、可扩展的 Web 应用与 API。

75

2025.12.15

什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

181

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

224

2025.12.18

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

443

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

544

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

322

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

1030

2026.02.13

热门下载

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

精品课程

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

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.7万人学习

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

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