Python装饰器简介

需要重新演唱

于 2024-10-03 10:52:37 发布

阅读量531

点赞数 19

文章标签： python 开发语言

本文链接：https://blog.csdn.net/xycxycooo/article/details/142689887

版权

引言：Python装饰器的魔力

在Python的世界里，装饰器（Decorator）是一种强大且优雅的工具，它允许我们在不修改函数或方法源代码的情况下，动态地为其添加功能。装饰器是Python中元编程（Metaprogramming）的一种形式，通过它，我们可以实现代码的重用、功能的扩展以及代码的可读性提升。本文将深入探讨Python装饰器的工作原理、使用场景以及如何在实际项目中应用它们。

前置知识：函数是一等公民

在深入了解装饰器之前，我们需要理解Python中一个重要的概念：函数是一等公民（First-Class Citizen）。这意味着函数可以像其他对象一样被传递、赋值给变量、作为参数传递给其他函数，甚至可以从函数中返回。

def greet(name):
    return f"Hello, {name}!"

# 将函数赋值给变量
say_hello = greet

# 调用变量指向的函数
print(say_hello("Alice"))  # 输出: Hello, Alice!

在这个例子中，我们将greet函数赋值给变量say_hello，然后通过say_hello调用greet函数。这种灵活性是装饰器的基础。

什么是装饰器？

装饰器本质上是一个函数，它接受另一个函数作为参数，并返回一个新的函数。这个新函数通常会在原函数的基础上添加一些额外的功能，而不会改变原函数的定义。

简单的装饰器示例

下面是一个简单的装饰器示例，它会在函数执行前后打印日志信息：

def log_decorator(func):
    def wrapper(*args, **kwargs):
        print(f"Calling function: {func.__name__}")
        result = func(*args, **kwargs)
        print(f"Function {func.__name__} finished")
        return result
    return wrapper

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

# 调用被装饰的函数
print(add(3, 5))

代码解释

log_decorator：这是一个装饰器函数，它接受一个函数func作为参数。
wrapper：这是一个内部函数，它会在func执行前后打印日志信息。
@log_decorator：这是装饰器的语法糖，等价于add = log_decorator(add)。

当我们调用add(3, 5)时，装饰器会在函数执行前后打印日志信息，最终输出结果为：

Calling function: add
Function add finished
8

装饰器的工作原理

装饰器的工作原理可以分为以下几个步骤：

定义装饰器函数：装饰器函数接受一个函数作为参数，并返回一个新的函数。
定义内部函数：内部函数（通常称为wrapper）会在原函数执行前后添加额外的功能。
返回内部函数：装饰器函数返回内部函数，这个内部函数将替代原函数。
应用装饰器：通过@decorator语法糖，将装饰器应用到目标函数上。

带参数的装饰器

有时我们需要为装饰器传递参数，这时我们可以定义一个带参数的装饰器。带参数的装饰器实际上是一个返回装饰器的高阶函数。

示例：带参数的装饰器

下面是一个带参数的装饰器示例，它允许我们指定日志的级别：

def log_level(level):
    def log_decorator(func):
        def wrapper(*args, **kwargs):
            print(f"[{level}] Calling function: {func.__name__}")
            result = func(*args, **kwargs)
            print(f"[{level}] Function {func.__name__} finished")
            return result
        return wrapper
    return log_decorator

@log_level("INFO")
def multiply(x, y):
    return x * y

# 调用被装饰的函数
print(multiply(4, 6))

代码解释

log_level：这是一个高阶函数，它接受一个参数level，并返回一个装饰器函数log_decorator。
log_decorator：这是一个装饰器函数，它接受一个函数func作为参数，并返回一个新的函数wrapper。
wrapper：这是一个内部函数，它会在func执行前后打印带有指定日志级别的日志信息。

当我们调用multiply(4, 6)时，装饰器会在函数执行前后打印带有指定日志级别的日志信息，最终输出结果为：

[INFO] Calling function: multiply
[INFO] Function multiply finished
24

装饰器的实际应用

装饰器在实际开发中有广泛的应用，以下是一些常见的场景：

日志记录：如上例所示，装饰器可以用于在函数执行前后记录日志。
权限验证：装饰器可以用于检查用户是否有权限执行某个操作。
缓存：装饰器可以用于缓存函数的返回值，避免重复计算。
性能监控：装饰器可以用于记录函数的执行时间，帮助优化性能。

示例：权限验证装饰器

下面是一个权限验证装饰器的示例：

def require_admin(func):
    def wrapper(*args, **kwargs):
        if not is_admin():
            raise PermissionError("Admin access required")
        return func(*args, **kwargs)
    return wrapper

@require_admin
def delete_user(user_id):
    print(f"Deleting user with ID: {user_id}")

# 模拟权限检查函数
def is_admin():
    return False  # 假设当前用户不是管理员

# 调用被装饰的函数
try:
    delete_user(123)
except PermissionError as e:
    print(e)