12. 深入剖析 Python 装饰器：原理、应用与最佳实践

本文链接：https://blog.youkuaiyun.com/huaanxiang/article/details/143762224

Python 装饰器是一种函数或类的高级特性，用来修改或增强函数、方法和类的行为。它提供了一种简洁、优雅的语法来实现代码重用、日志记录、访问控制等功能。以下是对 Python 装饰器的详细介绍，包括其定义、使用场景和实际应用示例。

1. 装饰器的定义与基础概念

装饰器本质上是一个函数，它接受另一个函数作为参数并返回一个新的函数或原函数的增强版。

基础装饰器结构：

def my_decorator(func):
    def wrapper(*args, **kwargs):
        print("函数调用前的代码")
        result = func(*args, **kwargs)
        print("函数调用后的代码")
        return result
    return wrapper

@my_decorator
def my_function():
    print("被装饰的函数执行")

my_function()
# 输出:
# 函数调用前的代码
# 被装饰的函数执行
# 函数调用后的代码

2. 装饰器的应用场景与适用性

装饰器广泛用于以下场合：

日志记录：在函数调用前后记录日志信息。
访问控制：限制或控制用户访问某些功能。
性能测量：记录函数执行时间以进行性能分析。
缓存：避免重复计算，提高性能。
验证：在调用函数前进行参数检查。

2.1 日志记录装饰器

def log_decorator(func):
    def wrapper(*args, **kwargs):
        print(f"调用 {func.__name__} 函数")
        return func(*args, **kwargs)
    return wrapper

@log_decorator
def add(x, y):
    return x + y

print(add(2, 3))

适用场合：适用于需要追踪函数调用和排查问题的场合，例如调试代码或记录用户活动日志。

2.2 访问控制装饰器

def requires_authentication(func):
    def wrapper(*args, **kwargs):
        user_authenticated = True  # 模拟用户认证检查
        if not user_authenticated:
            raise PermissionError("用户未认证")
        return func(*args, **kwargs)
    return wrapper

@requires_authentication
def protected_resource():
    print("访问受保护的资源")

# 适用场合：用户权限管理和身份验证。

2.3 性能测量装饰器

import time

def timer_decorator(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_decorator
def compute_sum(n):
    return sum(range(n))

compute_sum(1000000)

适用场合：适用于需要监控代码性能的场合，比如优化算法或进行性能分析。

2.4 缓存装饰器

from functools import lru_cache

@lru_cache(maxsize=32)
def fib(n):
    if n < 2:
        return n
    return fib(n-1) + fib(n-2)

print(fib(10))

适用场合：适合计算量大且结果可重用的场合，如递归算法或耗时函数。

3. 装饰器的高级用法

装饰器不仅可以用于函数，还可以应用于类来增强其功能。

3.1 类装饰器

类装饰器可以用来修改或扩展类的行为。它是一个接受类并返回类的函数。

def class_decorator(cls):
    cls.is_decorated = True
    return cls

@class_decorator
class MyClass:
    pass

print(MyClass.is_decorated)  # 输出: True

适用场合：适用于需要修改类行为或添加类属性的场合，比如动态注入属性。

3.2 参数化装饰器

为了给装饰器传递参数，我们可以在外部再嵌套一层函数。

def repeat(times):
    def decorator(func):
        def wrapper(*args, **kwargs):
            for _ in range(times):
                func(*args, **kwargs)
        return wrapper
    return decorator

@repeat(3)
def say_hello():
    print("Hello!")

say_hello()

适用场合：当装饰器需要动态配置或接受参数时，如指定重复次数、日志级别等。

4. 多个装饰器的叠加使用

多个装饰器可以同时作用于一个函数，按从内到外的顺序依次应用。

def decorator1(func):
    def wrapper(*args, **kwargs):
        print("装饰器 1")
        return func(*args, **kwargs)
    return wrapper

def decorator2(func):
    def wrapper(*args, **kwargs):
        print("装饰器 2")
        return func(*args, **kwargs)
    return wrapper

@decorator1
@decorator2
def my_function():
    print("被装饰的函数")

my_function()
# 输出顺序:
# 装饰器 1
# 装饰器 2
# 被装饰的函数

5. 注意事项和最佳实践

functools.wraps：在装饰器中使用 functools.wraps(func)，保留原始函数的元数据。
调试友好：未使用 functools.wraps 时，装饰器会导致函数名和文档字符串丢失。
避免嵌套复杂：装饰器嵌套层次不宜过深，以免影响代码可读性。
用途明确：每个装饰器应单一、清晰地解决一个问题，避免冗余功能。

from functools import wraps

def my_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        print("调用前")
        result = func(*args, **kwargs)
        print("调用后")
        return result
    return wrapper