Python中的装饰器（Decorator）|极客笔记

Python中的装饰器（Decorator）

装饰器（Decorator）是Python中一种使用频率非常高的特性，它可以用来增强函数或类的行为。装饰器可以理解为一个对函数进行包装的函数，通过给原函数添加一些额外的功能，而不需要修改原函数的代码。装饰器的使用可以让代码更加简洁和易于维护。

为什么需要装饰器

在日常开发中，我们经常会遇到一些场景，需要对函数或类做一些统一的处理，比如日志记录、性能测试、权限检查等。如果每个函数都在里面添加这些操作代码，会导致代码冗余，也不利于维护。而装饰器可以帮助我们实现这些功能的复用，让代码更加简洁和可读。

装饰器的基本语法

在Python中，使用装饰器可以在函数定义的上面加上@装饰器函数名的语法糖。下面是一个简单的示例：

def decorator(func):
    def wrapper():
        print("Before function is called")
        func()
        print("After function is called")
    return wrapper

@decorator
def greet():
    print("Hello, world!")

greet()

上面的代码定义了一个装饰器函数decorator，它接受一个函数作为参数，并返回一个新的函数wrapper，在wrapper函数内部可以对原函数进行增强。通过@decorator将greet函数进行装饰，当调用greet函数时，会首先执行wrapper函数内的代码，再执行原函数的代码。

运行上面的代码，得到的输出为：

Before function is called
Hello, world!
After function is called

装饰器的应用场景

日志记录

日志记录是项目中非常常见的需求，我们可以通过装饰器来统一记录函数的调用日志，方便排查问题。

def log_decorator(func):
    def wrapper(*args, **kwargs):
        print(f"Start to call {func.__name__}")
        result = func(*args, **kwargs)
        print(f"Finish calling {func.__name__}")
        return result
    return wrapper

@log_decorator
def add(a, b):
    return a + b

result = add(1, 2)
print(result)

运行上面的代码，得到的输出为：

Start to call add
Finish calling add
3

性能测试

在性能优化过程中，我们经常需要对代码的执行时间进行统计，找出影响性能的瓶颈。通过装饰器可以很方便地实现这一功能。

import time

def time_decorator(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print(f"{func.__name__} takes {end_time - start_time} seconds.")
        return result
    return wrapper

@time_decorator
def fib(n):
    if n <= 1:
        return n
    return fib(n-1) + fib(n-2)

result = fib(30)
print(result)

运行上面的代码，得到的输出为：

fib takes 0.2685823440551758 seconds.
832040

权限检查

在Web开发中，常常需要对用户的权限进行检查，以确保用户拥有执行某个操作的权限。通过装饰器可以方便地实现这一功能。

def check_permission(permission):
    def decorator(func):
        def wrapper(*args, **kwargs):
            if permission in ["admin", "superuser"]:
                return func(*args, **kwargs)
            else:
                print("Permission denied")
        return wrapper
    return decorator

@check_permission("admin")
def delete_file(file):
    print(f"Delete file {file}")

delete_file("example.txt")

运行上面的代码，得到的输出为：

Delete file example.txt

装饰器的嵌套使用

装饰器可以嵌套使用，多个装饰器会依次执行，从最近到最远。下面是一个示例：

def decorator1(func):
    def wrapper(*args, **kwargs):
        print("Decorator 1")
        return func(*args, **kwargs)
    return wrapper

def decorator2(func):
    def wrapper(*args, **kwargs):
        print("Decorator 2")
        return func(*args, **kwargs)
    return wrapper

@decorator1
@decorator2
def greet():
    print("Hello, world!")

greet()

运行上面的代码，得到的输出为：

Decorator 1
Decorator 2
Hello, world!

带参数的装饰器

有时候我们需要给装饰器传递一些参数来定制其行为，可以通过在装饰器外再包一层函数来实现。

def param_decorator(param):
    def decorator(func):
        def wrapper(*args, **kwargs):
            print(f"Decorator param: {param}")
            return func(*args, **kwargs)
        return wrapper
    return decorator

@param_decorator("Hello")
def greet(name):
    print(f"Hello, {name}!")

greet("Alice")

运行上面的代码，得到的输出为：

Decorator param: Hello
Hello, Alice!

类装饰器

除了函数装饰器，Python还支持类装饰器。类装饰器通过__call__方法实现对被装饰对象的调用。下面是一个示例：

class Logger:
    def __init__(self, func):
        self.func = func

    def __call__(self, *args, **kwargs):
        print(f"Start logging {self.func.__name__}")
        result = self.func(*args, **kwargs)
        print(f"Finish logging {self.func.__name__}")
        return result

@Logger
def sub(a, b):
    return a - b

result = sub(5, 3)
print(result)

运行上面的代码，得到的输出为：