深入理解Python中的装饰器：从基础到高级
在现代软件开发中，代码的复用性和可维护性是至关重要的。Python作为一种功能强大的编程语言，提供了许多工具来帮助开发者实现这些目标。其中，装饰器（Decorator）是一个非常有用的特性，它允许我们在不修改函数或类定义的情况下扩展其行为。本文将深入探讨Python装饰器的工作原理、使用场景以及一些高级技巧，并通过代码示例进行说明。
什么是装饰器？
装饰器是一种用于修改函数或方法行为的高级Python语法。简单来说，装饰器是一个以函数作为输入并返回一个新函数的函数。它可以帮助我们分离关注点，使代码更加简洁和模块化。
例如，如果我们希望为多个函数添加日志记录功能，而不是在每个函数中重复编写日志代码，可以使用装饰器来实现这一点。
基础装饰器
简单装饰器示例
以下是一个简单的装饰器示例，展示了如何为函数添加计时功能：
import timedef timer_decorator(func): def wrapper(*args, **kwargs): start_time = time.time() result = func(*args, **kwargs) end_time = time.time() print(f"Function {func.__name__} took {end_time - start_time:.4f} seconds to execute.") return result return wrapper@timer_decoratordef compute_sum(n): total = 0 for i in range(n): total += i return total# 调用被装饰的函数compute_sum(1000000)输出：
Function compute_sum took 0.0456 seconds to execute.在这个例子中，timer_decorator 是一个装饰器，它接收一个函数 func 并返回一个新的函数 wrapper。wrapper 在调用原始函数之前记录开始时间，在调用之后记录结束时间，并打印执行时间。
使用装饰器的常见场景
1. 日志记录
装饰器常用于为函数添加日志记录功能。以下是一个示例：
def log_decorator(func): def wrapper(*args, **kwargs): print(f"Calling function {func.__name__} with arguments {args} and keyword arguments {kwargs}") result = func(*args, **kwargs) print(f"Function {func.__name__} returned {result}") return result return wrapper@log_decoratordef multiply(a, b): return a * b# 调用被装饰的函数multiply(3, 5)输出：
Calling function multiply with arguments (3, 5) and keyword arguments {}Function multiply returned 152. 权限检查
在Web开发中，装饰器常用于检查用户是否有权限访问某个资源。以下是一个简单的权限检查装饰器示例：
def permission_required(role): def decorator(func): def wrapper(user, *args, **kwargs): if user.role != role: raise PermissionError(f"User does not have the required role: {role}") return func(user, *args, **kwargs) return wrapper return decoratorclass User: def __init__(self, name, role): self.name = name self.role = role@permission_required("admin")def delete_user(user): print(f"{user.name} has deleted a user.")# 创建用户实例user1 = User("Alice", "admin")user2 = User("Bob", "user")# 调用被装饰的函数delete_user(user1) # 正常执行delete_user(user2) # 抛出 PermissionError输出：
Alice has deleted a user.PermissionError: User does not have the required role: admin高级装饰器
1. 类装饰器
除了函数装饰器，Python还支持类装饰器。类装饰器通常用于增强类的功能或修改类的行为。以下是一个示例：
class SingletonDecorator: def __init__(self, cls): self.cls = cls self.instance = None def __call__(self, *args, **kwargs): if self.instance is None: self.instance = self.cls(*args, **kwargs) return self.instance@SingletonDecoratorclass DatabaseConnection: def __init__(self, db_name): self.db_name = db_name def connect(self): print(f"Connected to database: {self.db_name}")# 创建实例conn1 = DatabaseConnection("users_db")conn2 = DatabaseConnection("orders_db")print(conn1 is conn2) # 输出 True，表明两个实例实际上是同一个对象conn1.connect() # 输出 "Connected to database: users_db"在这个例子中，SingletonDecorator 确保 DatabaseConnection 类只有一个实例。
2. 带参数的装饰器
有时我们需要为装饰器传递额外的参数。可以通过创建一个返回装饰器的函数来实现这一点。以下是一个带参数的装饰器示例：
def retry_decorator(max_retries=3): def decorator(func): def wrapper(*args, **kwargs): retries = 0 while retries < max_retries: try: return func(*args, **kwargs) except Exception as e: print(f"Attempt {retries + 1} failed: {e}") retries += 1 raise Exception("All attempts failed.") return wrapper return decorator@retry_decorator(max_retries=5)def fetch_data(url): import requests response = requests.get(url) if response.status_code != 200: raise Exception(f"Failed to fetch data from {url}") return response.text# 调用被装饰的函数try: data = fetch_data("https://example.com/nonexistent")except Exception as e: print(e)在这个例子中，retry_decorator 接收一个参数 max_retries，并根据该参数控制重试次数。
3. 使用 functools.wraps
当使用装饰器时，原始函数的元信息（如名称、文档字符串等）可能会丢失。为了保留这些信息，可以使用 functools.wraps：
from functools import wrapsdef logging_decorator(func): @wraps(func) def wrapper(*args, **kwargs): print(f"Executing {func.__name__}") return func(*args, **kwargs) return wrapper@logging_decoratordef greet(name): """Greets the given name.""" return f"Hello, {name}!"print(greet.__name__) # 输出 "greet" 而不是 "wrapper"print(greet.__doc__) # 输出函数的文档字符串总结
装饰器是Python中一个强大且灵活的特性，能够帮助开发者编写更简洁、更模块化的代码。通过本文的介绍，我们了解了装饰器的基本概念、常见使用场景以及一些高级技巧。无论是日志记录、权限检查还是单例模式，装饰器都能为我们提供优雅的解决方案。
希望本文能帮助你更好地理解和应用Python装饰器！
