如何用装饰器模式在不修改原代码前提下增加埋点功能

夜磊酱_8333

夜磊酱_8333

2026-04-01

314人浏览

原创

functools.wraps是必选项,否则原函数的__name__、__doc__、__annotations__丢失,导致日志、监控、openapi工具无法识别真实函数;埋点需用try-except兜底,禁用同步http请求;带参装饰器须冻结参数避免闭包污染;annotated仅作类型提示,无法替代运行时埋点逻辑。

如何用装饰器模式在不修改原代码前提下增加埋点功能

装饰器加埋点时,为什么 functools.wraps 不是可选项而是必选项

不加 functools.wraps 会导致原函数的 __name__、__doc__、__annotations__ 全部丢失,日志、监控系统或 OpenAPI 自动生成工具会拿不到真实函数信息,埋点打上去也查不到归属。

  • 典型现象:logger.info(f"calling {func.__name__}") 打出的是 "wrapper" 而不是真实函数名
  • 调试时 help(my_func) 显示空文档,IDE 自动补全失效
  • FastAPI/Flask 的路由注册可能失败,因为框架依赖 __name__ 做唯一标识
  • 必须写成:@functools.wraps(func),不能只导入不调用

埋点装饰器里怎么安全处理异常,避免拖垮主逻辑

埋点本身是旁路行为,一旦出错(比如网络超时、JSON 序列化失败)绝对不能让原函数跟着抛异常或卡住。

  • 所有埋点逻辑必须包在 try...except Exception: 里,且 except 中不做 raise
  • 别用 logging.exception,它会打完整 traceback,高频调用下 I/O 压力大;改用 logging.debug + 简短错误描述
  • 异步场景下禁用同步 HTTP 请求埋点;可用 asyncio.create_task 发 fire-and-forget 请求,但要设 timeout
  • 示例关键行:try: send_to_monitoring(...); except Exception as e: logger.debug("track failed: %s", type(e).__name__)

带参数的埋点装饰器怎么避免闭包变量污染

写成 @track(category="api") 这种带参装饰器时,最容易踩的坑是外层函数返回的 wrapper 捕获了循环变量或上层局部变量,导致所有被装饰函数共享同一份参数。

  • 常见错误:用 for category in ["a", "b"]: 动态生成装饰器,结果所有函数都记成最后一个 category
  • 正确做法:参数必须通过装饰器工厂的闭包「冻结」,即 def decorator(category=...): def wrapper(...): ... return wrapper
  • 验证方式:打印 wrapper.__closure__[0].cell_contents,确认值是你传进去的那个,不是引用或 None
  • 如果用了类装饰器,确保 __init__ 存的是不可变值(如 str、int),别存 dict 或 list 后续被意外修改

Python 3.9+ 的 typing.Annotated 能替代装饰器埋点吗

不能。虽然 Annotated 可以附着元数据,但它只是类型提示的一部分,运行时不执行、不触发任何逻辑,对埋点这种需要副作用的操作完全无效。

  • def foo() -> Annotated[str, Track("login")]: ... 这行代码在运行期和普通 def foo() -> str: 完全等价
  • 类型检查器(mypy/pyright)可能读到注解,但不会调用你的埋点函数
  • 想靠它自动注入逻辑,得配合第三方库如 beartype 或自定义 AST 重写——成本远高于写个装饰器
  • 真要减少装饰器侵入,可以考虑 AOP 框架如 aspectlib,但小项目没必要,反而增加部署复杂度
埋点装饰器看着简单,最麻烦的其实是跨服务调用时上下文透传——比如 Flask 请求里埋点了 trace_id,下游 gRPC 调用却没带上,这时候光靠装饰器不够,得配合中间件或 contextvars 配合使用。
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4386

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1109

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4304

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

880

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1756

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3165

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4113

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2660

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

868

7

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习