如何在Uvicorn中使用中间件

风静小哥_2062

风静小哥_2062

2026-10-19

466人浏览

原创

uvicorn不处理中间件注册,必须通过fastapi/starlette的app.add_middleware()或@app.middleware("http")注册;自定义中间件需严格遵循asgi 3协议签名,且注意uvicorn自动注入的proxyheadersmiddleware等外层中间件影响。

如何在uvicorn中使用中间件

中间件必须通过 FastAPI/Starlette 注册,Uvicorn 本身不提供 add_middleware 方法

Uvicorn 是纯 ASGI 服务器,它只负责接收请求、调用 ASGI 应用、转发响应,**不处理中间件注册逻辑**。所谓“在 Uvicorn 中使用中间件”,实际是指把中间件注册到 FastAPI(或 Starlette)应用实例上,再由 Uvicorn 运行该应用。

常见错误是试图在 uvicorn.run() 调用里传入中间件参数,或直接调用 uvicorn.add_middleware() —— 这个函数根本不存在。

  • ✅ 正确路径:定义 app = FastAPI() → 调用 app.add_middleware(...) 或 @app.middleware("http")
  • ❌ 错误操作:uvicorn.add_middleware(...)、uvicorn.run(..., middleware=[...])(无此参数)
  • ⚠️ 注意:uvicorn.Config 类虽有 middleware 属性,但它仅用于内部构造 ASGI app 包装链(如 ProxyHeadersMiddleware),**不开放给用户直接配置业务中间件**

app.add_middleware() 与 @app.middleware("http") 的行为差异

两者最终都注册到 Starlette 的中间件栈,但执行时机和封装粒度不同:

  • @app.middleware("http"):装饰器形式,接收 request: Request 和 call_next,适合轻量拦截(如日志、头信息修改);每个装饰器生成一个独立中间件类实例
  • app.add_middleware(MiddlewareClass, **kwargs):显式传入中间件类(需符合 ASGI 协议),适合复用已有中间件(如 CORSMiddleware、自定义类),支持传参初始化
  • 执行顺序:所有 @app.middleware 按代码顺序注册,排在 app.add_middleware() 之前;即先运行装饰器中间件,再运行 add_middleware 注册的

示例中若同时用了两个 @app.middleware 和一个 app.add_middleware(CORSMiddleware),CORS 头会最后写入响应,可能覆盖前面中间件设置的同名 header。

Uvicorn 0.52.1
Uvicorn 0.52.1

Uvicorn 0.52.1 是 Python ASGI Web 服务器,提供异步应用服务及 WebSocket 支持,常用于 FastAPI、Starlette 等应用的开发和部署。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理所需依赖。

下载

自定义中间件类必须实现 ASGI 3 协议签名

手动写中间件类时,最容易出错的是函数签名不匹配。Uvicorn 运行时严格校验 __call__ 方法是否符合 ASGIApp 类型:

  • ❌ 错误写法:async def __call__(self, scope, receive, send) 缺少类型注解或参数名不一致
  • ✅ 正确签名:async def __call__(self, scope: Scope, receive: ASGIReceiveCallable, send: ASGISendCallable) -> None
  • ⚠️ Scope、ASGIReceiveCallable 等类型需从 starlette.types 或 typing 导入,否则运行时可能不报错但逻辑异常
  • 性能提示:中间件内避免阻塞调用(如同步 DB 查询、time.sleep()),否则拖垮整个异步 pipeline

一个最小可用中间件类:

from starlette.types import ASGIApp, Scope, Receive, Send

class SimpleLogMiddleware:
    def __init__(self, app: ASGIApp):
        self.app = app

    async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
        print(f"Request: {scope['method']} {scope['path']}")
        await self.app(scope, receive, send)

Uvicorn 启动时自动注入的中间件会影响你的调试

当你启用 --proxy-headers 或开启 debug 日志(--log-level trace),Uvicorn 会在底层自动包装你的 ASGI app:

  • ProxyHeadersMiddleware:重写 scope["client"] 和 scope["scheme"],若你中间件依赖原始 client IP,需注意它已被替换
  • MessageLoggerMiddleware:在 trace 级别下打印完整 ASGI message 流,可能干扰你自己的日志格式或造成大量输出
  • 这些中间件位于你注册的中间件**之外层**(即最先被调用),所以它们看到的是最原始的请求,而你的中间件看到的是已被代理头处理过的 scope

调试时若发现 client IP 总是 127.0.0.1,先检查是否漏配 --proxy-headers 或 --forwarded-allow-ips,而不是怀疑自己中间件写错了。

相关文章

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

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

下载

相关标签:

uvicorn

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系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

554

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

596

23

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

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

2026.06.16

499

12

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

2026.10.16

60

10

OpenJDK怎么配置Java开发环境
OpenJDK怎么配置Java开发环境

怎样用OpenJDK搭建开发环境?本专题介绍版本选择、下载安装、环境变量配置和编译运行验证,帮助你理清JDK的作用及基本配置流程,并通过简单程序检查环境是否可用,为后续项目开发做好准备。

2026.10.16

20

10

OpenJDK怎么部署Java应用
OpenJDK怎么部署Java应用

Java项目开发完成后,怎样部署到目标环境并正常运行?本专题介绍OpenJDK应用部署流程,涵盖运行环境准备、版本兼容检查、应用打包、启动参数配置和日志查看,帮助你理清部署前后的操作顺序,减少环境差异造成的运行问题。

2026.10.16

20

10

Revel框架模板渲染与表单验证
Revel框架模板渲染与表单验证

本专题围绕Revel框架视图层开发,介绍模板语法、变量输出、布局复用、表单提交、参数绑定与验证规则,帮助开发者完成安全规范的页面交互。

2026.10.16

20

15

Revel框架MVC路由与控制器
Revel框架MVC路由与控制器

本专题聚焦Revel框架MVC核心机制,讲解路由定义、控制器Action、参数绑定、请求响应和反向路由,并结合常见场景梳理接口请求处理流程。

2026.10.16

20

15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方部署指南
Uvicorn官方部署指南

共0课时 | 0人学习

Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习