讲师中心 微信公众号
AI工具推荐 视频效率加速

怎么利用修饰器 Decorator 模式非侵入式织入类方法日志

星瑶君_3073

星瑶君_3073

发布时间:2026-07-06 12:04:43

|

295人浏览过

|

来源于php中文网

原创

非侵入式织入日志的核心是用装饰器作用于类方法而非类本身,封装执行过程实现调用前后自动日志记录且不修改原方法逻辑。一、单方法装饰最常用;二、按命名规则批量装饰;三、类装饰器支持配置化;四、需注意@wraps、类方法处理及避免直接装饰类。

怎么利用修饰器 decorator 模式非侵入式织入类方法日志

直接用装饰器给类方法加日志,不需要改原有方法逻辑,也不用继承或重写类——这就是非侵入式织入的核心。

关键在于:装饰器作用于方法,而非类本身;它封装执行过程,在调用前后自动插入日志,原方法体完全不动。


一、给单个方法加日志(最常用)

适用于想对特定方法(比如 save()、fetch_data())精准打点:

import logging
from functools import wraps

logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')

def log_method_call(func):
    @wraps(func)
    def wrapper(self, *args, **kwargs):
        logging.info(f"[{self.__class__.__name__}.{func.__name__}] 开始执行,参数: {args}, {kwargs}")
        try:
            result = func(self, *args, **kwargs)
            logging.info(f"[{self.__class__.__name__}.{func.__name__}] 执行成功,返回: {result}")
            return result
        except Exception as e:
            logging.error(f"[{self.__class__.__name__}.{func.__name__}] 执行失败: {e}")
            raise
    return wrapper

# 使用示例
class UserService:
    @log_method_call
    def get_user(self, user_id):
        return {"id": user_id, "name": "Alice"}

    def update_user(self, user_id, data):  # 不加装饰器,无日志
        return True

# 调用
svc = UserService()
svc.get_user(123)  # 自动输出日志

✅ 特点:只影响被装饰的方法;self 参数自然传递;支持异常捕获与耗时可扩展(加 time.time() 即可)。


二、批量装饰类中所有方法(按命名规则)

适合统一规范,比如所有以 do_ 或 handle_ 开头的方法都需日志:

def auto_log_methods(cls):
    for attr_name in dir(cls):
        attr = getattr(cls, attr_name)
        if callable(attr) and not attr_name.startswith('_') and attr_name not in ['__init__', '__str__']:
            setattr(cls, attr_name, log_method_call(attr))
    return cls

@auto_log_methods
class OrderProcessor:
    def validate(self):
        return "valid"

    def submit(self):
        return "submitted"

⚠️ 注意:__init__ 通常不建议自动加日志(可能干扰实例化),显式排除更安全;也可改为白名单模式(如只装饰 ['validate', 'submit', 'cancel'])。


三、用类装饰器统一管理(更结构化)

把日志策略封装成类,支持开关、级别、输出目标等配置:

class MethodLogger:
    def __init__(self, level=logging.INFO, include_args=True):
        self.level = level
        self.include_args = include_args

    def __call__(self, func):
        @wraps(func)
        def wrapper(self, *args, **kwargs):
            class_name = self.__class__.__name__
            msg = f"{class_name}.{func.__name__}"
            if self.include_args:
                msg += f"({args}, {kwargs})"
            logging.log(self.level, f"[START] {msg}")

            result = func(self, *args, **kwargs)

            logging.log(self.level, f"[END] {class_name}.{func.__name__}")
            return result
        return wrapper

# 使用
class PaymentService:
    @MethodLogger(level=logging.DEBUG)
    def charge(self, amount):
        return f"charged ${amount}"

✅ 优势:复用性强;不同类可配不同日志级别;未来扩展(如加 trace_id、用户 ID)只需改 MethodLogger。


四、避免常见陷阱

  • 别漏掉 @wraps(func):否则 help()、func.__name__ 会变成 wrapper,影响调试和框架反射(如 Flask、FastAPI 路由识别)。
  • 类方法/静态方法要单独处理:@classmethod 和 @staticmethod 的装饰顺序很重要,日志装饰器应放在最外层:
    @log_method_call
    @classmethod
    def from_config(cls, cfg): ...
  • 不建议直接装饰整个类:Python 没有原生“类装饰器织入所有方法”的语法糖;强行遍历 __dict__ 可能干扰描述符、@property 等,稳妥做法仍是方法级或用 auto_log_methods 显式控制。

不复杂但容易忽略细节。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

相关专题

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

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

4286

2023.06.20

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

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

1089

2023.07.04

js四舍五入
js四舍五入

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

4204

2023.07.04

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

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

860

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

1756

2023.09.04

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

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

3125

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

4053

2023.09.12

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

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

2600

2023.09.20

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

160

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel框架内核源码分析
Laravel框架内核源码分析

共26课时 | 4.2万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn