引言
装饰器(Decorator)是Python中最优雅且强大的特性之一。它允许我们在不修改原函数代码的情况下,为函数添加新的功能。本文将深入探讨装饰器的工作原理、常见应用场景以及最佳实践,帮助您全面掌握这一重要特性。
一、装饰器基础
1.1 什么是装饰器
装饰器本质上是一个接受函数作为参数并返回一个新函数的可调用对象(通常是函数)。它遵循了设计模式中的装饰器模式,允许我们动态地为对象添加功能。
1.2 为什么需要装饰器
在实际开发中,我们经常需要为多个函数添加相同的功能,比如:
- 日志记录
- 性能测试
- 权限验证
- 缓存结果
- 事务处理
如果在每个函数中都重复编写这些代码,不仅繁琐,而且违反了DRY(Don't Repeat Yourself)原则。装饰器正是解决这个问题的优雅方案。
二、装饰器的工作原理
2.1 函数是一等公民
理解装饰器的前提是理解Python中"函数是一等公民"的概念。这意味着:
# 函数可以赋值给变量
def greet():
return "Hello!"
say_hello = greet
print(say_hello()) # 输出: Hello!
# 函数可以作为参数传递
def call_function(func):
return func()
print(call_function(greet)) # 输出: Hello!
# 函数可以作为返回值
def create_greeter():
def greet():
return "Hello from inner function!"
return greet
greeter = create_greeter()
print(greeter()) # 输出: Hello from inner function!
2.2 简单装饰器的实现
让我们从最简单的装饰器开始:
def my_decorator(func):
def wrapper():
print("装饰器:函数执行前")
func()
print("装饰器:函数执行后")
return wrapper
def say_hello():
print("Hello!")
# 手动装饰
say_hello = my_decorator(say_hello)
say_hello()
输出:
装饰器:函数执行前
Hello!
装饰器:函数执行后
2.3 使用@语法糖
Python提供了更简洁的语法来应用装饰器:
def my_decorator(func):
def wrapper():
print("装饰器:函数执行前")
func()
print("装饰器:函数执行后")
return wrapper
@my_decorator
def say_hello():
print("Hello!")
say_hello()
@my_decorator等价于say_hello = my_decorator(say_hello)。
三、装饰器进阶技巧
3.1 处理函数参数
实际应用中,被装饰的函数通常有参数。我们需要使用*args和**kwargs来处理:
def my_decorator(func):
def wrapper(*args, **kwargs):
print(f"调用函数: {func.__name__}")
print(f"位置参数: {args}")
print(f"关键字参数: {kwargs}")
result = func(*args, **kwargs)
print(f"返回值: {result}")
return result
return wrapper
@my_decorator
def add(a, b):
return a + b
@my_decorator
def greet(name, greeting="Hello"):
return f"{greeting}, {name}!"
add(3, 5)
greet("Alice", greeting="Hi")
3.2 保留函数元信息
装饰器会改变函数的元信息(如__name__、__doc__等)。使用functools.wraps可以保留原函数的元信息:
from functools import wraps
def my_decorator(func):
@wraps(func) # 保留原函数的元信息
def wrapper(*args, **kwargs):
"""wrapper的文档字符串"""
return func(*args, **kwargs)
return wrapper
@my_decorator
def example():
"""这是example函数的文档"""
pass
print(example.__name__) # 输出: example
print(example.__doc__) # 输出: 这是example函数的文档
3.3 带参数的装饰器
有时我们需要为装饰器传递参数,这需要再增加一层函数嵌套:
from functools import wraps
def repeat(times):
"""让函数重复执行指定次数的装饰器"""
def decorator(func):
@wraps(func)
def wrapper(*args, **kwargs):
results = []
for _ in range(times):
result = func(*args, **kwargs)
results.append(result)
return results
return wrapper
return decorator
@repeat(times=3)
def greet(name):
print(f"Hello, {name}!")
return f"Greeted {name}"
results = greet("Alice")
print(f"返回值: {results}")
3.4 类装饰器
除了函数,我们也可以使用类来实现装饰器:
from functools import wraps
class CountCalls:
"""统计函数调用次数的装饰器"""
def __init__(self, func):
wraps(func)(self)
self.func = func
self.call_count = 0
def __call__(self, *args, **kwargs):
self.call_count += 1
print(f"调用次数: {self.call_count}")
return self.func(*args, **kwargs)
@CountCalls
def say_hello():
print("Hello!")
say_hello()
say_hello()
say_hello()
3.5 多个装饰器的叠加
一个函数可以被多个装饰器装饰,执行顺序是从下到上:
def decorator1(func):
def wrapper(*args, **kwargs):
print("装饰器1: 开始")
result = func(*args, **kwargs)
print("装饰器1: 结束")
return result
return wrapper
def decorator2(func):
def wrapper(*args, **kwargs):
print("装饰器2: 开始")
result = func(*args, **kwargs)
print("装饰器2: 结束")
return result
return wrapper
@decorator1
@decorator2
def say_hello():
print("Hello!")
say_hello()
输出:
装饰器1: 开始
装饰器2: 开始
Hello!
装饰器2: 结束
装饰器1: 结束
四、装饰器的实际应用
4.1 性能计时器
import time
from functools import wraps
def timer(func):
"""测量函数执行时间的装饰器"""
@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
@timer
def slow_function():
time.sleep(1)
return "完成"
result = slow_function()
4.2 缓存装饰器
from functools import wraps
def memoize(func):
"""缓存函数结果的装饰器"""
cache = {}
@wraps(func)
def wrapper(*args):
if args not in cache:
cache[args] = func(*args)
return cache[args]
return wrapper
@memoize
def fibonacci(n):
"""计算斐波那契数列"""
if n < 2:
return n
return fibonacci(n-1) + fibonacci(n-2)
print(fibonacci(100)) # 快速返回结果
注:Python标准库提供了更强大的functools.lru_cache装饰器。
4.3 权限验证
from functools import wraps
def require_auth(func):
"""验证用户是否已登录的装饰器"""
@wraps(func)
def wrapper(*args, **kwargs):
# 假设从某处获取当前用户
current_user = get_current_user()
if not current_user or not current_user.is_authenticated:
raise PermissionError("需要登录才能访问")
return func(*args, **kwargs)
return wrapper
@require_auth
def delete_user(user_id):
print(f"删除用户 {user_id}")
# 执行删除操作
4.4 重试机制
import time
from functools import wraps
def retry(max_attempts=3, delay=1):
"""在函数失败时自动重试的装饰器"""
def decorator(func):
@wraps(func)
def wrapper(*args, **kwargs):
attempts = 0
while attempts < max_attempts:
try:
return func(*args, **kwargs)
except Exception as e:
attempts += 1
if attempts >= max_attempts:
raise
print(f"尝试 {attempts} 失败: {e}, {delay}秒后重试...")
time.sleep(delay)
return wrapper
return decorator
@retry(max_attempts=3, delay=2)
def unreliable_function():
import random
if random.random() < 0.7:
raise Exception("随机错误")
return "成功"
4.5 日志记录
import logging
from functools import wraps
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)
def log_calls(func):
"""记录函数调用的装饰器"""
@wraps(func)
def wrapper(*args, **kwargs):
logger.info(f"调用函数 {func.__name__}")
logger.info(f"参数: args={args}, kwargs={kwargs}")
try:
result = func(*args, **kwargs)
logger.info(f"返回值: {result}")
return result
except Exception as e:
logger.error(f"函数执行异常: {e}")
raise
return wrapper
@log_calls
def divide(a, b):
return a / b
divide(10, 2)
divide(10, 0) # 会记录异常
4.6 参数验证
from functools import wraps
def validate_types(**expected_types):
"""验证函数参数类型的装饰器"""
def decorator(func):
@wraps(func)
def wrapper(*args, **kwargs):
# 获取函数的参数名
import inspect
sig = inspect.signature(func)
bound_args = sig.bind(*args, **kwargs)
bound_args.apply_defaults()
# 验证类型
for arg_name, expected_type in expected_types.items():
if arg_name in bound_args.arguments:
value = bound_args.arguments[arg_name]
if not isinstance(value, expected_type):
raise TypeError(
f"参数 {arg_name} 应该是 {expected_type.__name__}, "
f"但得到了 {type(value).__name__}"
)
return func(*args, **kwargs)
return wrapper
return decorator
@validate_types(name=str, age=int)
def create_user(name, age):
print(f"创建用户: {name}, 年龄: {age}")
create_user("Alice", 25) # 正常
create_user("Bob", "30") # 抛出TypeError
五、装饰器最佳实践
5.1 始终使用functools.wraps
这确保装饰后的函数保留原函数的元信息:
from functools import wraps
def my_decorator(func):
@wraps(func) # 总是添加这一行
def wrapper(*args, **kwargs):
return func(*args, **kwargs)
return wrapper
5.2 让装饰器通用化
编写装饰器时,尽量让它能够处理各种函数:
from functools import wraps
def universal_decorator(func):
@wraps(func)
def wrapper(*args, **kwargs):
# 使用*args和**kwargs来处理任意参数
return func(*args, **kwargs)
return wrapper
5.3 装饰器应该是可选的
装饰器不应该改变函数的基本行为,只是增强功能:
# 好的做法:装饰器只是增加了日志功能
@log_calls
def calculate(x, y):
return x + y
# 不好的做法:装饰器改变了函数的返回值类型
def bad_decorator(func):
def wrapper(*args, **kwargs):
result = func(*args, **kwargs)
return str(result) # 强制转换为字符串
return wrapper
5.4 考虑装饰器的可配置性
使用带参数的装饰器来提供灵活性:
def configurable_cache(max_size=128, ttl=3600):
"""可配置的缓存装饰器"""
def decorator(func):
@wraps(func)
def wrapper(*args, **kwargs):
# 使用max_size和ttl参数
return func(*args, **kwargs)
return wrapper
return decorator
@configurable_cache(max_size=256, ttl=7200)
def expensive_operation():
pass
5.5 处理异常
装饰器应该妥善处理被装饰函数可能抛出的异常:
from functools import wraps
def safe_decorator(func):
@wraps(func)
def wrapper(*args, **kwargs):
try:
return func(*args, **kwargs)
except Exception as e:
# 记录异常但不隐藏它
print(f"函数 {func.__name__} 发生异常: {e}")
raise # 重新抛出异常
return wrapper
5.6 文档化装饰器
为装饰器编写清晰的文档说明:
def my_decorator(func):
"""
这个装饰器的作用是...
参数:
func: 被装饰的函数
返回:
装饰后的函数
示例:
@my_decorator
def example():
pass
"""
@wraps(func)
def wrapper(*args, **kwargs):
return func(*args, **kwargs)
return wrapper
六、常见陷阱与解决方案
6.1 装饰器中的闭包问题
# 错误示例
def create_multipliers():
multipliers = []
for i in range(5):
def multiplier(x):
return x * i
multipliers.append(multiplier)
return multipliers
# 所有函数都会使用最后的i值(4)
funcs = create_multipliers()
print(funcs[0](2)) # 期望0, 实际得到8
# 正确做法:使用默认参数捕获值
def create_multipliers_correct():
multipliers = []
for i in range(5):
def multiplier(x, i=i): # i=i捕获当前的i值
return x * i
multipliers.append(multiplier)
return multipliers
funcs = create_multipliers_correct()
print(funcs[0](2)) # 正确输出0
6.2 装饰器顺序问题
多个装饰器的执行顺序容易混淆:
# 装饰顺序: @a @b @c
# 等价于: a(b(c(func)))
# 执行顺序: a的前置 -> b的前置 -> c的前置 -> func -> c的后置 -> b的后置 -> a的后置
6.3 装饰类方法
装饰类方法时需要注意self参数:
from functools import wraps
def method_decorator(func):
@wraps(func)
def wrapper(self, *args, **kwargs): # 注意需要self参数
print(f"调用 {self.__class__.__name__}.{func.__name__}")
return func(self, *args, **kwargs)
return wrapper
class MyClass:
@method_decorator
def method(self):
print("方法执行")
6.4 装饰器与描述符的冲突
使用@property、@staticmethod、@classmethod时要注意顺序:
class MyClass:
# 正确: @property应该在最内层
@some_decorator
@property
def value(self):
return self._value
# 错误: @property在外层会导致问题
# @property
# @some_decorator
# def value(self):
# return self._value
七、高级主题
7.1 使用装饰器实现单例模式
from functools import wraps
def singleton(cls):
"""单例模式装饰器"""
instances = {}
@wraps(cls)
def get_instance(*args, **kwargs):
if cls not in instances:
instances[cls] = cls(*args, **kwargs)
return instances[cls]
return get_instance
@singleton
class Database:
def __init__(self):
print("初始化数据库连接")
db1 = Database()
db2 = Database()
print(db1 is db2) # True
7.2 装饰器工厂函数
创建可以生成不同装饰器的工厂函数:
def create_validator(validation_func):
"""装饰器工厂: 根据验证函数创建装饰器"""
def decorator(func):
@wraps(func)
def wrapper(*args, **kwargs):
if not validation_func(*args, **kwargs):
raise ValueError("验证失败")
return func(*args, **kwargs)
return wrapper
return decorator
# 创建不同的验证装饰器
positive_validator = create_validator(lambda x: x > 0)
even_validator = create_validator(lambda x: x % 2 == 0)
@positive_validator
def process_positive(x):
return x * 2
@even_validator
def process_even(x):
return x / 2
7.3 基于上下文的装饰器
from contextlib import contextmanager
from functools import wraps
@contextmanager
def timing_context():
import time
start = time.time()
yield
end = time.time()
print(f"耗时: {end - start:.4f}秒")
def with_timing(func):
@wraps(func)
def wrapper(*args, **kwargs):
with timing_context():
return func(*args, **kwargs)
return wrapper
@with_timing
def slow_operation():
import time
time.sleep(1)
八、总结
装饰器是Python中一个强大而优雅的特性,掌握装饰器可以让我们的代码更加简洁、可维护。关键要点包括:
- 理解本质: 装饰器是返回函数的高阶函数
- 灵活应用: 从简单装饰器到带参数的装饰器,再到类装饰器
- 遵循最佳实践: 使用
functools.wraps,保持装饰器的通用性和可选性 - 实际应用: 日志、缓存、验证、性能监控等场景
- 避免陷阱: 注意闭包、执行顺序、类方法装饰等问题
通过合理使用装饰器,我们可以写出更加Pythonic的代码,提高代码的可读性和可维护性。装饰器不仅是一种语法特性,更是一种编程思想的体现。
1060

被折叠的 条评论
为什么被折叠?



