Python中的装饰器函数详解和示例

1. 概述

装饰器是 Python 中的一种高级语法，广泛运用于各种框架和库中，常用于修改函数或类的行为。装饰器的本质就是函数（或类），它可以用来修改另外一个函数（或类）的行为，使其具有新的功能或修改原有功能。装饰器非常灵活，可以在不需要修改原函数（或类）源码的情况下，改变其行为。

装饰器的本质是闭包，其实就是一个闭包调用的语法糖。闭包是指在函数内部定义函数，并返回该函数的引用，形成一个封闭的函数结构，使得函数内部的变量可以在函数外部得以保存和引用。闭包可以用于实现对外部变量的保护，隐藏内部状态等。

2. 简单装饰器的实现

下面我们来简单实现一个装饰器函数：

def my_decorator(func):
    def wrapper():
        print("Before the function is called.")
        func()
        print("After the function is called.")
    return wrapper

def say_hello():
    print("Hello!")

say_hello = my_decorator(say_hello)
say_hello()

运行结果：

Before the function is called.
Hello!
After the function is called.

装饰器函数 my_decorator 接受一个函数作为参数，返回一个闭包函数 wrapper。这里闭包函数 wrapper 调用了原函数 say_hello，并在调用前后输出一些信息。

装饰器的语法糖

Python 提供了一种语法糖，可以简化装饰器的调用。可以通过在函数定义前加 @my_decorator 来使用装饰器：

@my_decorator
def say_hello():
    print("Hello!")

这种写法的效果和手动调用 my_decorator(say_hello) 一样，但更加简洁，易读。这种写法等价于：

say_hello = my_decorator(say_hello)

3. 装饰器包装有参数的函数

如果要包装有参数的函数，我们需要在闭包函数 wrapper 中传入参数。下面是一个简单的示例，包装一个计数器函数：

def my_decorator(func):
    def wrapper(*args, **kwargs):
        print("Before the function is called.")
        result = func(*args, **kwargs)
        print("After the function is called.")
        return result
    return wrapper

@my_decorator
def counter(start, end):
    for i in range(start, end):
        print(i)
    return end - start

counter(1, 10)

运行结果：

Before the function is called.
1
2
3
4
5
6
7
8
9
After the function is called.

这里我们在闭包函数 wrapper 中传入了可变数量的参数 *args 和 **kwargs，以便于传递计数器函数的参数。我们在函数调用前后输出一些信息，并最终返回计算结果。

4. 带参数的装饰器函数

装饰器函数本身也可以带有参数，这对于实现可定制化的装饰器非常有用。下面是一个简单的示例：

def repeat(num):
    def my_decorator(func):
        def wrapper(*args, **kwargs):
            for i in range(num):
                print("Before the function is called.")
                result = func(*args, **kwargs)
                print("After the function is called.")
            return result
        return wrapper
    return my_decorator

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

say_hello()

运行结果：

Before the function is called.
Hello!
After the function is called.
Before the function is called.
Hello!
After the function is called.
Before the function is called.
Hello!
After the function is called.

这里我们定义了一个 repeat 装饰器函数，它接受一个参数 num，用于指定函数重复的次数。它返回一个闭包函数 my_decorator，该闭包函数中再定义一个闭包函数 wrapper，它包装了原函数 say_hello，并在函数调用前后输出一些信息。最后我们使用装饰器函数 @repeat(num=3) 来调用装饰器，将函数 say_hello 重复调用三次。

5. 装饰器的应用

装饰器广泛应用于各种库和框架中，为其中的函数和类添加一些额外的功能。

比如，Django Web 框架中，@login_required 装饰器可以用于验证用户的登录状态：

from django.contrib.auth.decorators import login_required

@login_required
def my_view(request):
    ...

Flask Web 框架中，@app.route 装饰器可以用于指定 URL 路径：

from flask import Flask

app = Flask(__name__)

@app.route("/")
def hello():
    return "Hello World!"

SQLAlchemy ORM 框架中，@classmethod 装饰器可以用于标识一个类方法：

from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, Integer, String

Base = declarative_base()

class User(Base):
    __tablename__ = 'users'

    id = Column(Integer, primary_key=True)
    name = Column(String)
    age = Column(Integer)

    @classmethod
    def get_all(cls):
        return session.query(cls).all()

6. 总结

Python 装饰器是一种高级语法，它可以用来修改函数或类的行为，使其具有新的功能或修改原有功能。我们可以定义装饰器函数，使用语法糖 @my_decorator 来调用装饰器。装饰器函数可以包含可变数量的参数，以便于定制化装饰器的行为。装饰器广泛应用于库和框架中，为其中的函数和类添加一些额外的功能。