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

星瑶君_3073

星瑶君_3073

2026-07-06

295人浏览

原创

非侵入式织入日志的核心是用装饰器作用于类方法而非类本身,封装执行过程实现调用前后自动日志记录且不修改原方法逻辑。一、单方法装饰最常用;二、按命名规则批量装饰;三、类装饰器支持配置化;四、需注意@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_ 开头的方法都需日志:

Yellow.ai
Yellow.ai

Yellow.ai是一款面向客户体验和员工体验自动化的企业级 Agentic AI 平台。

下载
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 显式控制。

不复杂但容易忽略细节。

相关文章

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

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

下载

相关标签:

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

相关专题

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

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

2023.06.20

4306

5

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

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

2023.07.04

1089

3

js四舍五入
js四舍五入

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

2023.07.04

4224

6

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

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

2023.09.01

860

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

3125

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4053

6

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

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

2023.09.20

2600

5

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

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

2023.09.20

848

7

热门下载

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

精品课程

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

共6课时 | 54.6万人学习

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

共89课时 | 133.3万人学习