前言:在昨天,我们已经详细的了解了关于函数的装饰器的基本定义以及其用法,今天我们将主要来讨论一下关于类的装饰器的基本用法。
point1 给出装饰器的基本框架
示例代码:
python
def class_logger(cls): # 接受一个类作为参数
# 装饰器逻辑
return cls # 返回修改后的类
point2 初始化方面:创建新的初始化方法
示例代码:
python
def new_init(self, *args, **kwargs):
# 新增实例化日志
print(f"[LOG] 实例化对象: {cls.__name__}")
original_init(self, *args, **kwargs) # 调用原始构造方法
这里创建了一个包装函数,它在调用原始 __init__之前添加了日志输出。
point3 替换构造方法
示例代码:
python
cls.__init__ = new_init
将类的 __init__方法替换为新版本。
----------------------------------------------以上为对类的初始化的一些修改-----------------------------------------
point4 添加新方法
示例代码:
python
def log_message(self, message):
print(f"[LOG] {message}")
cls.log = log_message
为类添加一个新的 log方法。所有实例都可以调用此方法输出日志。
point5 装饰器的等价形式
示例代码:
python
@class_logger
class SimplePrinter:
...
这实际上是语法糖,等价于:
python
class SimplePrinter:
...
SimplePrinter = class_logger(SimplePrinter)
------------------------------以上为分步的解析,下面将呈现完整代码和使用方法------------------------------
示例代码:
python
# 定义类装饰器:为类添加日志功能
def class_logger(cls):
# 保存原始的 __init__ 方法
original_init = cls.__init__
def new_init(self, *args, **kwargs):
# 新增实例化日志
print(f"[LOG] 实例化对象: {cls.__name__}")
original_init(self, *args, **kwargs) # 调用原始构造方法
# 将类的 __init__ 方法替换为新方法
cls.__init__ = new_init
# 为类添加一个日志方法(示例)
def log_message(self, message):
print(f"[LOG] {message}")
cls.log = log_message # 将方法绑定到类,这是一种将外部函数添加为类的属性的方法
return cls
# 定义简单打印类,应用装饰器
# 同样是语法糖的写法
@class_logger
class SimplePrinter:
def __init__(self, name):
self.name = name # 构造方法:初始化名称
def print_text(self, text):
"""简单打印方法"""
print(f"{self.name}: {text}")
# 使用示例
printer = SimplePrinter("A") # 实例化时触发装饰器的日志
printer.print_text("Hello, World!") # 调用普通方法
printer.log("这是装饰器添加的日志方法") # 调用装饰器新增的方法
关于使用的一些注解:
1. 实例化时触发装饰器修改过的 init
printer = SimplePrinter("A")
输出: [LOG] 实例化对象: SimplePrinter
2. 调用原始类的方法
printer.print_text("Hello, World!")
输出: A: Hello, World!
3. 调用装饰器添加的方法
printer.log("这是装饰器添加的日志方法")
输出: [LOG] 这是装饰器添加的日志方法
小结:
关于类的实例化我们可以看出,其主要作用有1、修改一些初始化参数 2、调用原先类拥有的方法3、增加一些新的方法。
PS:关于类的继承与类的装饰器的选取规则:
-
如果需要表达 "是一个" 的关系,用继承
-
如果需要添加 辅助功能 (日志、缓存、验证等),用装饰器
-
如果需要运行时灵活配置 ,用装饰器
-
如果需要修改第三方代码 ,用装饰器
-
如果需要构建类层次结构 ,用继承