FastAPI怎么自定义中间件统计接口请求耗时

夜明小哥_1100

夜明小哥_1100

2026-10-28

112人浏览

原创

最稳妥方式是继承BaseHTTPMiddleware并重写dispatch方法:在call_next前用time.perf_counter()记录起始时间,call_next后计算差值,将结果以X-Process-Time头写入Response并返回;必须确保返回Response实例且避免同名header覆盖。

fastapi怎么自定义中间件统计接口请求耗时

用 BaseHTTPMiddleware 写耗时统计中间件最稳妥

直接继承 BaseHTTPMiddleware 是当前 FastAPI(v0.112+)推荐方式,比旧的 @app.middleware("http") 装饰器更清晰、类型更安全,也方便复用和单元测试。

关键点在于:必须调用 call_next(request) 才能让请求继续往下走;耗时计算要包住它;响应头写入必须在 call_next 之后。

  • start_time 放在 call_next 前,别漏了
  • 别用 time.time() 测微秒级差异,改用 time.perf_counter()
  • 返回的 response 必须是 Response 实例,不能是 dict 或其他类型,否则会报 TypeError: object of type 'dict' has no len()
from fastapi import Request
from starlette.middleware.base import BaseHTTPMiddleware
from starlette.responses import Response
import time
<p>class TimingMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request: Request, call_next) -> Response:
start_time = time.perf_counter()
response = await call_next(request)
process_time = time.perf_counter() - start_time
response.headers["X-Process-Time"] = f"{process_time:.6f}"
return response
</p>

注册中间件时顺序影响耗时结果

中间件是洋葱模型,越早注册的越外层。如果你同时用了日志、鉴权、压缩等中间件,TimingMiddleware 的位置决定了它测的是“纯业务耗时”还是“全链路耗时”。

  • 想测真实业务逻辑耗时 → 把 TimingMiddleware 放在鉴权、日志之后,靠近路由层
  • 想测端到端延迟(含鉴权、反向代理开销等)→ 放最外层,第一个注册
  • Uvicorn 默认有 TimeoutMiddleware,如果它在 TimingMiddleware 外层,超时错误的耗时也会被统计进去

注册示例:

app.add_middleware(TimingMiddleware)  # 最外层
app.add_middleware(AuthMiddleware)   # 第二层
app.add_middleware(LoggingMiddleware) # 第三层

dispatch 方法里不能直接 return dict 或 str

这是新手最容易踩的坑:看到示例里返回 response 就以为可以随便 return,结果一加中间件整个服务就崩了。

FastAPI Flask Proxy
FastAPI Flask Proxy

FastAPI + Flask 混合部署最佳实践,解决路由定义、API 代理等常见问题,适用于同时运行 FastAPI API 与 Flask 前端的场景。

下载
  • 所有中间件的 dispatch 方法签名都要求返回 Response 类型
  • 如果你在中间件里想提前终止请求(比如鉴权失败),必须手动构造 JSONResponse 或 PlainTextResponse,不能写 return {"detail": "unauthorized"}
  • 耗时中间件一般不拦截,所以不用构造新响应,但一旦和其他中间件组合,就得注意返回值类型是否一致

错误写法:

# ❌ 这会导致 TypeError
if not is_valid_token(request):
    return {"error": "Unauthorized"}  # 不是 Response 实例

生产环境要注意 header 值精度和日志落盘开销

X-Process-Time 头默认只对调试友好,真上生产得考虑两点:

  • 精度太高(如 .9f)可能暴露内部调度细节,建议用 .6f 足够,单位是秒
  • 如果同时开启详细日志(比如打印 query_params 或 body),记得加 LOG_LEVEL != "DEBUG" 判断,避免大请求体拖慢整个链路
  • 高 QPS 场景下,频繁调用 time.perf_counter() 几乎无开销,但拼接字符串 + 写 header 有微量成本,实测单次增加约 0.02ms,可忽略

真正容易被忽略的是:当多个中间件都往 response.headers 写同名 key 时,后写的会覆盖前写的 —— 所以如果你自定义了多个耗时中间件,别都用 X-Process-Time,改用不同 key,比如 X-Auth-Time、X-DB-Time。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

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

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

下载

相关标签:

fastapi

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

656

23

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

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

2026.06.16

559

12

pycharm怎么改成中文
pycharm怎么改成中文

PyCharm是一种Python IDE(Integrated Development Environment,集成开发环境),带有一整套可以帮助用户在使用Python语言开发时提高其效率的工具,比如调试、语法高亮、项目管理、代码跳转、智能提示、自动完成、单元测试、版本控制。此外,该IDE提供了一些高级功能,以用于支持Django框架下的专业Web开发。php中文网给大家带来了pycharm相关的教程以及文章,欢迎大家前来学习和阅读。

2023.07.25

3129

3

pycharm安装教程
pycharm安装教程

PyCharm是一款由JetBrains开发的Python集成开发环境(IDE),它提供了许多方便的功能和工具。本专题为大家带来pycharm安装教程,帮助大家解决问题。

2023.08.21

5897

4

如何解决pycharm找不到模块
如何解决pycharm找不到模块

解决pycharm找不到模块的方法:1、检查python解释器;2、安装缺失的模块;3、检查项目结构;4、检查系统路径;5、使用虚拟环境;6、重启PyCharm或电脑。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.12.04

738

5

如何安装pycharm
如何安装pycharm

安装pycharm的步骤:1、访问PyCharm官方网站下载最新版本的PyCharm;2、下载完成后,打开安装文件;3、安装完成后,打开PyCharm;4、在PyCharm的主界面中等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

914

5

python和pycharm的区别
python和pycharm的区别

Python和PyCharm是两个不同的概念,它们的区别如下:1、Python是一种编程语言,而PyCharm是一款Python集成开发环境;2、Python可以运行在各种不同的开发环境中,而PyCharm是专门为Python开发而设计的IDE等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

527

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
FastAPI SQL数据库实战文档
FastAPI SQL数据库实战文档

共0课时 | 0人学习

FastAPI官方教程文档
FastAPI官方教程文档

共0课时 | 0人学习