Python装饰器本质上是一个接收函数作为参数并返回新函数的高阶函数,核心依托于闭包特性实现,能够在保持原函数逻辑不变的情况下为其添加额外的功能。装饰器的常见应用场景包括函数执行前后的日志记录、接口访问的权限校验、函数执行耗时的统计等,能够大幅减少重复代码的编写。

装饰器的核心原理
要理解装饰器的实现,首先需要了解闭包的概念。闭包指的是在一个内部函数中访问了外部函数的变量,并且外部函数返回了这个内部函数。装饰器就是利用闭包的特性,将原函数作为参数传入装饰器函数,在装饰器内部定义一个新的函数来包装原函数的逻辑,同时添加新的功能,最后返回这个新函数。
比如我们有一个简单的加法函数:
def add(a, b):
return a + b
如果我们想要在不修改add函数代码的情况下,在函数执行前后打印日志,就可以使用装饰器来实现。
无参数装饰器的实现
无参数装饰器是最基础的装饰器形式,不需要接收额外的参数,只需要接收被装饰的函数即可。下面是一个实现日志记录功能的无参数装饰器示例:
# 定义装饰器函数,接收被装饰的函数func作为参数
def log_decorator(func):
# 定义内部包装函数,接收原函数的所有参数
def wrapper(*args, **kwargs):
# 原函数执行前打印日志
print(f"函数 {func.__name__} 开始执行,参数:args={args}, kwargs={kwargs}")
# 调用原函数并获取返回值
result = func(*args, **kwargs)
# 原函数执行后打印日志
print(f"函数 {func.__name__} 执行结束,返回值:{result}")
# 返回原函数的返回值
return result
# 返回包装函数
return wrapper
# 使用装饰器装饰add函数,等价于 add = log_decorator(add)
@log_decorator
def add(a, b):
return a + b
# 调用被装饰后的函数
print(add(3, 5))
上述代码的执行流程如下:
- 当Python解释器执行到
@log_decorator时,会自动将下方的add函数作为参数传入log_decorator函数,得到返回的wrapper函数,并将其赋值给add变量,此时add变量指向的就是wrapper函数。 - 调用
add(3,5)时,实际执行的是wrapper(3,5),先打印执行前的日志,再调用原add函数得到结果8,打印执行后的日志,最后返回结果8。
执行上述代码后,输出结果如下:
函数 add 开始执行,参数:args=(3, 5), kwargs={}
函数 add 执行结束,返回值:8
8
带参数装饰器的实现
有时候我们需要装饰器能够接收额外的参数,比如指定日志的级别、是否开启日志等,这时候就需要实现带参数的装饰器。带参数装饰器相比无参数装饰器多了一层函数嵌套,最外层函数接收装饰器的参数,中间层函数接收被装饰的函数,最内层函数还是包装原函数的逻辑。
下面是一个支持指定日志前缀的带参数装饰器示例:
# 最外层函数接收装饰器的参数
def log_decorator_with_param(prefix=""):
# 中间层函数接收被装饰的函数
def decorator(func):
# 最内层函数是包装函数
def wrapper(*args, **kwargs):
print(f"{prefix}函数 {func.__name__} 开始执行")
result = func(*args, **kwargs)
print(f"{prefix}函数 {func.__name__} 执行结束")
return result
return wrapper
return decorator
# 使用带参数的装饰器,等价于 add = log_decorator_with_param(prefix="[INFO]")(add)
@log_decorator_with_param(prefix="[INFO]")
def add(a, b):
return a + b
print(add(2, 4))
上述代码的执行逻辑是:先调用log_decorator_with_param(prefix="[INFO]"),得到中间的decorator函数,再将add函数传入decorator函数,得到wrapper函数,最终add变量指向wrapper函数。
执行上述代码后,输出结果如下:
[INFO]函数 add 开始执行 [INFO]函数 add 执行结束 6
装饰器的注意事项
使用装饰器时需要注意一个问题:被装饰后的函数的元信息(比如函数名、文档字符串)会变成内部包装函数的元信息,这可能会影响调试或者一些依赖函数元信息的场景。我们可以通过functools模块的wraps装饰器来解决这个问题,它会将原函数的元信息复制到包装函数上。
修改后的无参数装饰器示例如下:
import functools
def log_decorator(func):
# 使用functools.wraps装饰包装函数,复制func的元信息
@functools.wraps(func)
def wrapper(*args, **kwargs):
print(f"函数 {func.__name__} 开始执行")
result = func(*args, **kwargs)
print(f"函数 {func.__name__} 执行结束")
return result
return wrapper
@log_decorator
def add(a, b):
return a + b
# 此时add的函数名还是原来的add,而不是wrapper
print(add.__name__)
执行上述代码后,输出结果为add,说明函数的元信息已经被正确保留。
类装饰器的实现
除了使用函数实现装饰器,还可以使用类来实现装饰器。类装饰器的核心是实现__call__方法,让类的实例可以像函数一样被调用。下面是一个类装饰器的示例:
class LogDecorator:
def __init__(self, func):
# 保存被装饰的函数
self.func = func
# 复制函数的元信息
functools.update_wrapper(self, func)
def __call__(self, *args, **kwargs):
print(f"函数 {self.func.__name__} 开始执行")
result = self.func(*args, **kwargs)
print(f"函数 {self.func.__name__} 执行结束")
return result
@LogDecorator
def add(a, b):
return a + b
print(add(1, 2))
类装饰器的执行逻辑是:当使用@LogDecorator装饰add函数时,会创建LogDecorator的实例,将add函数传入__init__方法,之后调用add(1,2)时,实际是调用实例的__call__方法,执行内部的包装逻辑。
装饰器是Python中非常灵活的语法特性,掌握其实现原理后,可以根据实际需求编写各类功能的装饰器,有效提升代码的复用性和可维护性。