精通Python装饰器（Decorator）：提升代码灵活性与可维护性

原创

疯狂的KK

发布于 2023-10-08 14:33:28

3981

发布于 2023-10-08 14:33:28

引言

在Python编程中，装饰器（Decorator）是一项强大的工具，用于修改或扩展函数和方法的行为，而无需修改它们的源代码。本文将深入讨论什么是Python中的装饰器以及如何使用它们。通过示例和详细解释，您将能够充分理解装饰器的工作原理，并将其应用于提高代码的灵活性和可维护性。

1. 什么是装饰器？

装饰器是Python的一种高级功能，它允许您动态修改函数或方法的行为，而无需修改它们的原始定义。装饰器通常用于以下情况：

添加额外的功能或逻辑，如日志记录、性能分析、权限检查等。
保持原始函数的封装性，使代码更干净和可维护。
避免代码的重复，将通用的功能逻辑从多个地方抽取出来。

装饰器本质上是一个函数，它接受一个函数或方法作为参数，并返回一个新的函数或方法。这个新的函数通常包装了原始函数，并在执行前后执行一些额外的代码。

2. 如何使用装饰器？

为了更好地理解装饰器，让我们通过示例来演示如何创建和使用装饰器。

2.1 简单的装饰器示例

假设我们有一个简单的函数，用于打印一条欢迎消息：

def welcome():
    print("欢迎访问我们的网站！")

现在，我们想要创建一个装饰器，用于在欢迎消息前后添加时间戳：

import datetime

def add_timestamp(func):
    def wrapper():
        print(f"访问时间：{datetime.datetime.now()}")
        func()
        print(f"欢迎访问我们的网站！")
    return wrapper

上面的add_timestamp装饰器接受一个函数 func 作为参数，并返回一个新的函数 wrapper，在 func 前后添加时间戳信息。接下来，我们将这个装饰器应用于我们的欢迎函数：

welcome = add_timestamp(welcome)
welcome()

运行上述代码后，您将看到输出中包含了时间戳信息。

2.2 使用装饰器语法糖

Python提供了一种更便捷的方式来使用装饰器，使用 @ 符号将装饰器应用于函数。将上述示例改写为使用语法糖：

import datetime

def add_timestamp(func):
    def wrapper():
        print(f"访问时间：{datetime.datetime.now()}")
        func()
        print(f"欢迎访问我们的网站！")
    return wrapper

@add_timestamp
def welcome():
    print("欢迎访问我们的网站！")

这种方式更加简洁，使代码更易读。现在，每次调用 welcome() 函数时，装饰器 add_timestamp 将自动应用。

3. 装饰器的实际应用

3.1 记录日志

装饰器非常适合记录函数的执行日志。以下是一个简单的日志记录装饰器示例：

def log_function_call(func):
    def wrapper(*args, **kwargs):
        print(f"调用函数 {func.__name__}，参数：{args}, {kwargs}")
        result = func(*args, **kwargs)
        print(f"{func.__name__} 执行完毕，结果：{result}")
        return result
    return wrapper

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

现在，每次调用 add 函数时，都会记录函数的参数和返回结果。

3.2 权限检查

装饰器还可以用于进行权限检查。例如，以下是一个检查用户是否具有管理员权限的装饰器：

def admin_required(func):
    def wrapper(user):
        if user.is_admin:
            return func(user)
        else:
            raise PermissionError("只有管理员用户可以执行此操作")
    return wrapper

@admin_required
def delete_user(user):
    # 删除用户的操作
    pass

这个装饰器可以确保只有管理员用户可以执行 delete_user 函数。