Python设计模式深度解析:装饰器模式(Decorator Pattern)完全指南
前言
在软件开发中,我们经常需要在不修改原有代码的情况下为对象添加新功能。传统的继承方式虽然可以实现功能扩展,但会导致类的数量急剧增加,且缺乏灵活性。装饰器模式(Decorator Pattern)为我们提供了一种更优雅的解决方案,它允许我们动态地为对象添加功能,而无需修改其结构。
本文将通过实际代码示例,深入讲解Python中装饰器模式的实现方式、应用场景以及与Python内置装饰器语法的关系。
什么是装饰器模式?
装饰器模式是一种结构型设计模式,它允许向一个现有的对象添加新的功能,同时又不改变其结构。这种模式创建了一个装饰类,用来包装原有的类,并在保持类方法签名完整性的前提下,提供了额外的功能。
装饰器模式的核心思想
- 组合优于继承:通过对象组合而非继承来扩展功能
- 透明性:装饰器与被装饰对象具有相同的接口
- 动态性:可以在运行时动态地添加或移除功能
- 可组合性:多个装饰器可以组合使用
Python函数装饰器:从基础到高级
基础函数装饰器
让我们从一个简单的函数装饰器开始:
def mathFunc(func):
"""基础装饰器函数"""
def wrapper(x):
print("b4 func") # 函数执行前
func(x) # 执行原函数
print("after func") # 函数执行后
return wrapper
# 方式1:手动应用装饰器
def sayMath(x):
print("math")
sayMath = mathFunc(sayMath) # 手动装饰
sayMath(12)
# 方式2:使用@语法糖
@mathFunc
def sayMath2(x):
print("math")
sayMath2(12)
这个例子展示了装饰器的基本工作原理:
- 装饰器函数接收一个函数作为参数
- 返回一个新的函数(wrapper)
- 新函数在调用原函数前后添加额外功能
高级函数装饰器实现
让我们实现一些更实用的装饰器:
import time
import functools
from typing import Any, Callable
def timer(func: Callable) -> Callable:
"""计时装饰器"""
@functools.wraps(func)
def wrapper(*args, **kwargs):
start_time = time.time()
result = func(*args, **kwargs)
end_time = time.time()
print(f"{func.__name__} 执行时间: {end_time - start_time:.4f}秒")
return result
return wrapper
def logger(func: Callable) -> Callable:
"""日志装饰器"""
@functools.wraps(func)
def wrapper(*args, **kwargs):
print(f"调用函数: {func.__name__}")
print(f"参数: args={args}, kwargs={kwargs}")
result = func(*args, **kwargs)
print(f"返回值: {result}")
return result
return wrapper
def retry(max_attempts: int = 3, delay: float = 1):
"""重试装饰器(参数化装饰器)"""
def decorator(func: Callable) -> Callable:
@functools.wraps(func)
def wrapper(*args, **kwargs):
for attempt in range(max_attempts):
try:
return func(*args, **kwargs)
except Exception as e:
if attempt == max_attempts - 1:
raise e
print(f"第{attempt + 1}次尝试失败: {e}")
time.sleep(delay)
return wrapper
return decorator
def cache(func: Callable) -> Callable:
"""缓存装饰器"""
cache_dict = {}
@functools.wraps(func)
def wrapper(*args, **kwargs):
# 创建缓存键
key = str(args) + str(sorted(kwargs.items()))
if key in cache_dict:
print(f"缓存命中: {func.__name__}")
return cache_dict[key]
result = func(*args, **kwargs)
cache_dict[key] = result
print(f"缓存存储: {func.__name__}")
return result
return wrapper
# 使用装饰器的示例
@timer
@logger
def calculate_sum(n: int) -> int:
"""计算1到n的和"""
return sum(range(1, n + 1))
@cache
@timer
def fibonacci(n: int) -> int:
"""计算斐波那契数列"""
if n <= 1:
return n
return fibonacci(n - 1) + fibonacci(n - 2)
@retry(max_attempts=3, delay=0.5)
def unreliable_network_call():
"""模拟不可靠的网络调用"""
import random
if random.random() < 0.7: # 70%失败率
raise Exception("网络连接失败")
return "数据获取成功"
# 测试装饰器
def test_decorators():
print("=== 计时和日志装饰器 ===")
result = calculate_sum(1000)
print("\n=== 缓存装饰器 ===")
print("第一次计算斐波那契:")
fib_result = fibonacci(10)
print("第二次计算斐波那契:")
fib_result = fibonacci(10) # 使用缓存
print("\n=== 重试装饰器 ===")
try:
result = unreliable_network_call()
print(f"网络调用成功: {result}")
except Exception as e:
print(f"网络调用最终失败: {e}")
if __name__ == "__main__":
test_decorators()
GUI装饰器模式:动态界面增强
Tkinter按钮装饰器
基于您的代码,让我们看看如何在GUI中应用装饰器模式:
from tkinter import *
class Decorator(Button):
"""按钮装饰器基类"""
def __init__(self, master, **kwargs):
super().__init__(master, **kwargs)
# 默认设置为平面样式
self.configure(relief=FLAT)
# 绑定鼠标事件
self.bind("<Enter>", self.on_enter)
self.bind("<Leave>", self.on_leave)
def on_enter(self, evt):
"""鼠标进入时的效果"""
self.configure(relief=RAISED)
def on_leave(self, evt):
"""鼠标离开时的效果"""
self.configure(relief=FLAT)
class HoverButton(Decorator):
"""悬停效果按钮"""
def __init__(self, master, text="按钮", **kwargs):
super().__init__(master, text=text, **kwargs)
class ClickCountButton(Decorator):
"""点击计数按钮装饰器"""
def __init__(self, master, text="按钮", **kwargs):
super().__init__(master, **kwargs)
self.click_count = 0
self.original_text = text
self.configure(text=f"{text} (0)")
self.configure(command=self.on_click)
def on_click(self):
"""点击事件处理"""
self.click_count += 1
self.configure(text=f"{self.original_text} ({self.click_count})")
class ColorChangeButton(Decorator):
"""颜色变化按钮装饰器"""
def __init__(self, master, text="按钮", **kwargs):
super().__init__(master, text=text, **kwargs)
self.colors = ['lightblue', 'lightgreen', 'lightcoral', 'lightyellow']
self.color_index = 0
self.configure(bg=self.colors[0])
self.configure(command=self.change_color)
def change_color(self):
"""改变按钮颜色"""
self.color_index = (self.color_index + 1) % len(self.colors)
self.configure(bg=self.colors[self.color_index])
# GUI应用示例
class DecoratorGUIDemo:
def __init__(self):
self.root = Tk()
self.root.title("装饰器模式GUI演示")
self.root.geometry("400x300")
self.create_widgets()
def create_widgets(self):
"""创建界面组件"""
Label(self.root, text="装饰器模式按钮演示",
font=("Arial", 16)).pack(pady=10)
# 基础悬停按钮
hover_btn = HoverButton(self.root, "悬停效果按钮")
hover_btn.pack(pady=5)
# 点击计数按钮
count_btn = ClickCountButton(self.root, "点击计数按钮")
count_btn.pack(pady=5)
# 颜色变化按钮
color_btn = ColorChangeButton(self.root, "颜色变化按钮")
color_btn.pack(pady=5)
# 组合装饰器按钮
combo_btn = self.create_combo_button()
combo_btn.pack(pady=5)
# 退出按钮
Button(self.root, text="退出", command=self.root.quit).pack(pady=20)
def create_combo_button(self):
"""创建组合装饰器按钮"""
class ComboButton(ClickCountButton, ColorChangeButton):
def __init__(self, master, text="组合按钮", **kwargs):
# 多重继承需要小心处理
Decorator.__init__(self, master, text=text, **kwargs)
self.click_count = 0
self.original_text = text
self.colors = ['lightblue', 'lightgreen', 'lightcoral', 'lightyellow']
self.color_index = 0
self.configure(text=f"{text} (0)", bg=self.colors[0])
self.configure(command=self.on_combo_click)
def on_combo_click(self):
"""组合点击事件"""
self.click_count += 1
self.color_index = (self.color_index + 1) % len(self.colors)
self.configure(
text=f"{self.original_text} ({self.click_count})",
bg=self.colors[self.color_index]
)
return ComboButton(self.root, "组合装饰器按钮")
def run(self):
"""运行应用"""
self.root.mainloop()
# 运行GUI演示
if __name__ == "__main__":
app = DecoratorGUIDemo()
app.run()
类装饰器:元编程的力量
数据类装饰器对比
让我们对比传统类定义和使用@dataclass
装饰器的区别:
# 传统类定义(基于您的dclasse.py)
class Employee:
def __init__(self, frname: str, lname: str, idnum: int,
town='Stamford', state='CT', zip='06820'):
self.frname = frname
self.lname = lname
self.idnum = idnum
self.town = town
self.state = state
self.zip = zip
def nameString(self):
return f"{self.frname} {self.lname} {self.idnum}"
def __repr__(self):
return f"Employee({self.frname}, {self.lname}, {self.idnum})"
def __eq__(self, other):
if not isinstance(other, Employee):
return False
return (self.frname == other.frname and
self.lname == other.lname and
self.idnum == other.idnum)
# 使用@dataclass装饰器(基于您的dclass.py)
from dataclasses import dataclass
@dataclass
class EmployeeDataClass:
frname: str
lname: str
idnum: int
town: str = "Stamford"
state: str = 'CT'
zip: str = '06820'
def nameString(self):
return f"{self.frname} {self.lname} {self.idnum}"
# 对比测试
def compare_implementations():
"""对比两种实现方式"""
print("=== 传统类实现 ===")
emp1 = Employee('Sarah', 'Smythe', 123)
emp2 = Employee('Sarah', 'Smythe', 123)
print(f"emp1: {emp1}")
print(f"emp1 == emp2: {emp1 == emp2}")
print(f"emp1.nameString(): {emp1.nameString()}")
print("\n=== @dataclass实现 ===")
emp3 = EmployeeDataClass('Sarah', 'Smythe', 123)
emp4 = EmployeeDataClass('Sarah', 'Smythe', 123)
print(f"emp3: {emp3}")
print(f"emp3 == emp4: {emp3 == emp4}") # 自动生成__eq__
print(f"emp3.nameString(): {emp3.nameString()}")
if __name__ == "__main__":
compare_implementations()
自定义类装饰器
让我们实现一些实用的类装饰器:
def singleton(cls):
"""单例装饰器"""
instances = {}
def get_instance(*args, **kwargs):
if cls not in instances:
instances[cls] = cls(*args, **kwargs)
return instances[cls]
return get_instance
def add_repr(cls):
"""添加__repr__方法的装饰器"""
def __repr__(self):
attrs = ', '.join(f'{k}={v!r}' for k, v in self.__dict__.items())
return f"{cls.__name__}({attrs})"
cls.__repr__ = __repr__
return cls
def validate_types(**type_validators):
"""类型验证装饰器"""
def decorator(cls):
original_setattr = cls.__setattr__
def new_setattr(self, name, value):
if name in type_validators:
expected_type = type_validators[name]
if not isinstance(value, expected_type):
raise TypeError(
f"{name} must be of type {expected_type.__name__}, "
f"got {type(value).__name__}"
)
original_setattr(self, name, value)
cls.__setattr__ = new_setattr
return cls
return decorator
def auto_property(*attr_names):
"""自动属性装饰器"""
def decorator(cls):
for attr_name in attr_names:
private_name = f"_{attr_name}"
def make_property(name, private):
def getter(self):
return getattr(self, private, None)
def setter(self, value):
setattr(self, private, value)
return property(getter, setter)
setattr(cls, attr_name, make_property(attr_name, private_name))
return cls
return decorator
# 使用类装饰器的示例
@singleton
@add_repr
class DatabaseConnection:
def __init__(self, host="localhost", port=5432):
self.host = host
self.port = port
self.connected = False
print(f"创建数据库连接: {host}:{port}")
def connect(self):
self.connected = True
print("连接到数据库")
@validate_types(name=str, age=int, salary=float)
@add_repr
class Person:
def __init__(self, name, age, salary):
self.name = name
self.age = age
self.salary = salary
@auto_property('name', 'age')
class Student:
def __init__(self, name, age):
self.name = name # 会调用setter
self.age = age # 会调用setter
# 测试类装饰器
def test_class_decorators():
print("=== 单例装饰器测试 ===")
db1 = DatabaseConnection()
db2 = DatabaseConnection("remote", 3306)
print(f"db1 is db2: {db1 is db2}") # True,单例模式
print(f"db1: {db1}")
print("\n=== 类型验证装饰器测试 ===")
try:
person = Person("Alice", 25, 50000.0)
print(f"person: {person}")
person.age = "invalid" # 会抛出TypeError
except TypeError as e:
print(f"类型验证失败: {e}")
print("\n=== 自动属性装饰器测试 ===")
student = Student("Bob", 20)
print(f"student.name: {student.name}")
print(f"student._name: {student._name}") # 私有属性
if __name__ == "__main__":
test_class_decorators()
装饰器模式 vs Python装饰器语法
相同点
- 功能增强:都用于为对象或函数添加额外功能
- 透明性:都保持原有接口不变
- 组合性:都可以组合使用
不同点
应用层面:
- 装饰器模式:主要用于对象级别的功能扩展
- Python装饰器:主要用于函数和类的元编程
实现方式:
- 装饰器模式:通过类的组合和继承
- Python装饰器:通过函数的高阶特性
运行时行为:
- 装饰器模式:可以在运行时动态添加/移除装饰器
- Python装饰器:在定义时就确定了装饰关系
实际应用场景
Web开发中的装饰器
# Flask风格的路由装饰器
def route(path):
def decorator(func):
# 注册路由
app.routes[path] = func
return func
return decorator
# 权限验证装饰器
def require_auth(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
if not current_user.is_authenticated:
raise PermissionError("需要登录")
return func(*args, **kwargs)
return wrapper
# 使用示例
@route('/api/users')
@require_auth
def get_users():
return {"users": ["Alice", "Bob"]}
性能监控装饰器
import psutil
import threading
def monitor_performance(func):
"""性能监控装饰器"""
@functools.wraps(func)
def wrapper(*args, **kwargs):
# 记录开始状态
start_memory = psutil.Process().memory_info().rss
start_time = time.time()
try:
result = func(*args, **kwargs)
return result
finally:
# 记录结束状态
end_memory = psutil.Process().memory_info().rss
end_time = time.time()
print(f"函数 {func.__name__} 性能报告:")
print(f" 执行时间: {end_time - start_time:.4f}秒")
print(f" 内存变化: {(end_memory - start_memory) / 1024 / 1024:.2f}MB")
return wrapper
@monitor_performance
def heavy_computation():
"""重计算任务"""
data = [i ** 2 for i in range(1000000)]
return sum(data)
最佳实践和注意事项
1. 保持接口一致性
# 好的做法:保持接口一致
class TextProcessor:
def process(self, text):
return text
class UpperCaseDecorator:
def __init__(self, processor):
self._processor = processor
def process(self, text): # 保持相同的方法签名
return self._processor.process(text).upper()
# 不好的做法:改变接口
class BadDecorator:
def __init__(self, processor):
self._processor = processor
def process_text(self, text): # 改变了方法名
return self._processor.process(text).upper()
2. 使用functools.wraps保持元数据
import functools
def good_decorator(func):
@functools.wraps(func) # 保持原函数的元数据
def wrapper(*args, **kwargs):
return func(*args, **kwargs)
return wrapper
def bad_decorator(func):
def wrapper(*args, **kwargs): # 丢失原函数的元数据
return func(*args, **kwargs)
return wrapper
@good_decorator
def example_function():
"""这是一个示例函数"""
pass
print(example_function.__name__) # 输出: example_function
print(example_function.__doc__) # 输出: 这是一个示例函数
3. 考虑装饰器的顺序
@timer
@logger
@cache
def complex_function(n):
"""复杂函数"""
# 执行顺序:cache -> logger -> timer -> complex_function
return sum(range(n))
# 等价于:
# complex_function = timer(logger(cache(complex_function)))
总结
装饰器模式是一种强大的设计模式,它提供了比继承更灵活的功能扩展方式。在Python中,我们既可以使用传统的面向对象方式实现装饰器模式,也可以利用Python的装饰器语法来实现类似的功能。
关键要点
- 组合优于继承:装饰器模式通过组合来扩展功能
- 透明性:装饰器与被装饰对象具有相同接口
- 灵活性:可以动态地添加、移除或组合装饰器
- Python特色:充分利用Python的装饰器语法和元编程特性
选择指南
- 对象功能扩展:使用传统的装饰器模式
- 函数功能增强:使用Python函数装饰器
- 类功能增强:使用Python类装饰器
- 元编程需求:结合使用多种装饰器技术
通过本文的学习,相信您已经掌握了装饰器模式的精髓。在实际开发中,请根据具体场景选择合适的实现方式,并始终考虑代码的可读性和可维护性。