探索Python的魔法：装饰器模式的奥秘

news2024/10/5 12:22:19

引言

装饰器模式是一种结构型设计模式，它通过创建一个包装对象来包含真实的对象，从而在不修改原有对象的基础上扩展其功能。在Python中，装饰器模式尤为流行，因为它提供了一种非常Pythonic的方式来增强函数或类的功能。

基础语法介绍

在Python中，装饰器是一种使用@语法的函数，它可以让其他函数在不改变其代码的前提下增加额外功能。装饰器的语法规则如下：

装饰器本身是一个函数，它接受一个函数作为参数并返回一个新的函数。
使用@decorator语法将装饰器应用于另一个函数。

基础实例

问题描述：假设我们需要记录函数执行的时间，我们可以使用装饰器来实现。

代码示例：

import time

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

@timer
def example_function(x):
    time.sleep(x)
    return x

result = example_function(2)

进阶实例

问题描述：在Web开发中，我们经常需要对请求进行权限检查。使用装饰器可以方便地实现这一功能。

高级代码实例：

from functools import wraps

def login_required(f):
    @wraps(f)
    def decorated_function(*args, **kwargs):
        if not is_user_logged_in():
            raise Exception("You need to log in first.")
        return f(*args, **kwargs)
    return decorated_function

def is_user_logged_in():
    return True  # 假设用户已登录

@login_required
def protected_function():
    return "This is a protected resource."

实战案例

问题描述：在构建一个RESTful API时，我们希望记录每个请求的响应时间，并在发生错误时发送错误日志。

解决方案：使用装饰器来实现请求日志和错误处理。

代码实现：

import logging
from flask import Flask, request, jsonify

app = Flask(__name__)

def log_request(f):
    @wraps(f)
    def decorated_function(*args, **kwargs):
        start_time = time.time()
        try:
            response = f(*args, **kwargs)
            status_code = response.status_code
        except Exception as e:
            status_code = 500
            logging.error(f"Error in {f.__name__}: {str(e)}")
        finally:
            end_time = time.time()
            logging.info(f"{f.__name__} executed in {end_time - start_time} seconds with status code {status_code}")
        return response
    return decorated_function

@app.route('/data')
@log_request
def get_data():
    return jsonify({"data": "Some data"})

if __name__ == '__main__':
    app.run(debug=True)