python装饰器-猿码集

1. Python装饰器简介

Python装饰器是Python中十分常见且强大的语言特性之一，它以函数为基础，将一种函数进行包装处理，并返回新的函数的过程。

与其他编程语言相比，Python装饰器最引人注目的特点就是其简洁性，实现起来相对简单，使用范围广泛，比如Python中的Flask框架就是很好的例子。

Python装饰器有很多应用场景，比如函数计时器、异常处理、权限验证等，它可以让你在不修改原函数的情况下扩展或增强函数的功能，让你的代码更加清晰明了。

2. 装饰器的基本语法

装饰器的基本语法是声明并使用函数，这些函数可以接受一个函数作为参数，并返回一个新函数，也可以扩展或修改原函数的功能，以下为Python装饰器的基本语法：


def decorator(func):
    def wrapper(*args, **kwargs):
        # 在这里实现装饰器的功能
        return func(*args, **kwargs)
    return wrapper
@decorator
def func():
    # 这里是原函数的功能代码
    pass

在上面的代码中，@decorator是Python装饰器的语法糖，将func()函数作为参数传入decorator()函数，将其返回的新函数wrapper()赋值给func，相当于func = decorator(func)。

wrapper()函数的参数使用了*args和**kwargs，这里的*args和**kwargs表示接收任意数量的位置参数和关键字参数，并将其传递给func()函数。

3. 装饰器的应用实例

3.1 函数计时器

函数计时器是常用的装饰器之一，可以用于统计函数的执行时间，以下是实现函数计时器的代码：


import time
def timer(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print("函数%s执行时间：%f秒" % (func.__name__, end_time - start_time))
        return result
    return wrapper
@timer
def test():
    time.sleep(1)
test()

在上面的代码中，使用了Python的time模块来计算函数的执行时间，并在wrapper()函数结束时输出执行时间信息。

3.2 异常处理

装饰器有助于将应用程序的异常处理分离出来，使得处理函数与主要逻辑分离，这样可以使应用程序更容易维护和扩展，以下是一个简单的异常处理装饰器：


def exception_handler(func):
    def wrapper(*args, **kwargs):
        try:
            result = func(*args, **kwargs)
        except Exception as e:
            result = '函数%s出现异常：%s' % (func.__name__, str(e))
        return result
    return wrapper
@exception_handler
def test(a, b):
    return a / b
print(test(10, 0))

在上面的代码中，exception_handler()装饰器可以捕获函数的所有异常，并将异常信息返回。

在这个例子中，因为test()函数的参数b为0，所以会发生ZeroDivisionError异常，但由于使用了装饰器，我们可以将异常信息捕获，并返回错误提示信息。

3.3 权限验证

装饰器还可以用于实现权限验证功能，以下是一个简单的权限验证装饰器：


def admin_required(func):
    def wrapper(*args, **kwargs):
        if 'admin' in args[0].get('role', ''):
            return func(*args, **kwargs)
        else:
            return '当前用户没有权限执行该操作'
    return wrapper
@admin_required
def delete_user(user):
    print("删除用户：%s" % user)
user1 = {'name': 'Tom', 'role': 'user'}
user2 = {'name': 'Bob', 'role': 'admin'}
print(delete_user(user1)) # 当前用户没有权限执行该操作
print(delete_user(user2)) # 删除用户：{'name': 'Bob', 'role': 'admin'}

在上面的代码中，admin_required()装饰器实现了权限验证，只有用户的role包含admin时才有权限执行delete_user()函数，否则会返回错误提示信息。

4. 装饰器的进阶用法

4.1 多级装饰器

装饰器之间可以进行嵌套使用，也就是说可以使用多个装饰器对同一个函数进行装饰，以下是一个多级装饰器的例子：


def decorator1(func):
    def wrapper(*args, **kwargs):
        print('decorator1函数开始装饰')
        result = func(*args, **kwargs)
        print('decorator1函数结束装饰')
        return result
    return wrapper
def decorator2(func):
    def wrapper(*args, **kwargs):
        print('decorator2函数开始装饰')
        result = func(*args, **kwargs)
        print('decorator2函数结束装饰')
        return result
    return wrapper
@decorator1
@decorator2
def test():
    print("测试函数")
test()

在上面的代码中，test()函数被同时使用了decorator1()和decorator2()两个装饰器进行装饰，结果呈现了多级装饰效果。

4.2 类装饰器

除了函数装饰器外，Python中还有一种装饰器称为类装饰器，它将函数作为参数传递给一个类的构造函数，使得该函数可以在对象上被调用。类装饰器常用于管理函数状态或实现类似内置函数的效果。以下是一个类装饰器的例子：


class mydecorator:
    def __init__(self, func):
        self.func = func
        self.count = 0
    def __call__(self, *args, **kwargs):
        self.count += 1
        print('函数被调用了 %d 次' % self.count)
        return self.func(*args, **kwargs)
@mydecorator
def test():
    print("测试函数")
test()
test()

在上面的代码中，mydecorator类接收一个函数作为参数，并实现了一个__call__()方法，该方法每次被调用时计数器加1，并记录函数的执行次数。

5. 总结

Python装饰器是Python语言的一个重要特性，它可以帮助我们扩展或修改函数的功能，使代码更加灵活、易于维护和扩展。

本文介绍了Python装饰器的基本语法、常见应用场景和进阶用法，包括多级装饰器和类装饰器。

掌握了Python装饰器的使用技巧，可以让我们的代码更加高效、优雅。

python装饰器