怎样使用Python编写自定义装饰器来记录Web请求日志?

千浩酱_5928

千浩酱_5928

2026-07-28

829人浏览

原创

装饰器需显式获取request对象:flask用from flask import request,fastapi须依赖注入或函数参数传入;必须用functools.wraps保留原函数元信息,通过包裹调用捕获响应状态码与耗时,并避免直接读取request body或敏感头信息。

怎样使用python编写自定义装饰器来记录web请求日志?

装饰器怎么接收请求对象并记录日志

Web框架(如Flask、FastAPI)中,装饰器本身不自动获得request对象,必须显式从当前上下文获取。Flask用from flask import request,FastAPI则需通过依赖注入或在路由函数内部传入——装饰器不能直接“抓取”参数,只能拦截已定义的函数签名。

常见错误是写成这样:@log_request 然后在装饰器里直接访问request,却没确认当前是否在请求上下文中,结果抛出RuntimeError: Working outside of application context

  • Flask:确保装饰器在app.app_context()app.request_context()内运行,或仅用于已注册的路由函数(此时request可用)
  • FastAPI:装饰器无法直接读Request,应改用Depends或中间件;若坚持用装饰器,需让被装饰函数显式声明request: Request参数,并在装饰器中通过*args/**kwargs提取
  • 日志内容建议至少包含:request.methodrequest.url.pathrequest.headers.get("User-Agent")、响应状态码(需捕获返回值或异常)

如何在装饰器里拿到响应状态码和耗时

状态码和耗时不是装饰器一进来就能知道的——它们取决于被装饰函数的执行结果和返回值。必须包裹函数调用,并在try/except中捕获返回值或异常,再统一记录。

例如,Flask路由返回Response对象或字符串,其status_code属性不一定存在(字符串没有),而FastAPI可能返回JSONResponse或普通dict。硬编码取resp.status_code会报AttributeError

Shadows Python Sensei
Shadows Python Sensei

Python 最佳实践助手——代码规范、设计模式、性能优化、测试与类型注解。适用于编写或审查 Python 代码。

下载
  • 推荐做法:统一用time.time()测耗时,用try获取返回值,except捕获HTTPException或通用异常,从中提取状态码
  • 对Flask,可检查返回值类型:if hasattr(resp, "status_code"),否则默认200;对FastAPI,更稳妥的是让装饰器只作用于明确返回Response子类的函数
  • 别在装饰器里调用logging.info()前拼接长字符串——先用f-string生成消息,再传入logger,避免不必要的格式化开销

为什么用functools.wraps而不是裸函数

不用@functools.wraps(func)会导致被装饰函数的__name____doc____annotations__全变成装饰器内部函数的,这在Flask注册路由、FastAPI生成OpenAPI文档时会出问题:路由名变成wrapper,接口描述丢失,甚至健康检查端点/docs加载失败。

  • 必须在装饰器内层函数上加@functools.wraps(func),且该内层函数要真正返回原函数的执行结果(不能漏掉return
  • 如果装饰器带参数(比如@log_request(level="DEBUG")),functools.wraps要套在最内层函数上,不是中间那层闭包
  • 检查是否生效:打印your_route.__name__,如果不是原函数名,说明wraps没用对

生产环境要注意哪些日志性能陷阱

高频接口每请求都打完整日志(含body、headers)会迅速拖慢服务,尤其当request.get_data()被多次调用时,Flask会抛RuntimeError: Cannot stream response after the response has been started

  • 避免记录request.get_data()request.json——前者消耗流、后者可能触发重复解析;如真需要body,应在装饰器外由业务逻辑主动传入
  • 敏感字段(如AuthorizationCookie)必须脱敏,不能只靠日志级别控制;建议用正则预处理headers字典
  • 异步框架(如FastAPI + uvicorn)下,不要在装饰器里用logging.basicConfig()——它会干扰uvicorn自己的日志配置;应复用logging.getLogger(__name__)并提前配置好handler

真正麻烦的从来不是写个能跑的日志装饰器,而是它在并发场景下不偷偷吃掉内存、不泄露token、不把调试日志打到生产磁盘满。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1551

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

3624

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1549

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

20637

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2567

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2607

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1063

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

576

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2023

5

热门下载

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

精品课程

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