flask中的常用装饰器

news2024/11/17 23:44:45

在这里插入图片描述

flask中的常用装饰器

Flask 框架中提供了一些内置的装饰器，这些装饰器可以帮助我们更方便地开发 Web 应用。以下是一些常用的 Flask 装饰器：

@app.route()：这可能是 Flask 中最常用的装饰器。它用于将 URL 路由绑定到一个 Python 函数，这个函数就是处理对应 URL 请求的视图函数。例如：
```
@app.route('/')
def home():
    return 'Hello, World!'
```
在这个例子中，@app.route('/') 装饰器将根 URL (/) 绑定到了 home 函数。当用户访问应用的根 URL 时，home 函数就会被调用，并返回 “Hello, World!”。
@app.before_request()：这个装饰器用于注册在每次请求之前运行的函数。这对于需要在处理请求之前执行某些操作（如打开数据库连接、进行身份验证等）的情况非常有用。

假设我们有一个 Flask 应用，我们想在每个请求开始之前检查用户是否已经登录。如果用户未登录，我们将重定向他们到登录页面。
```
from flask import Flask, session, redirect, url_for

app = Flask(__name__)

@app.before_request
def require_login():
    allowed_routes = ['login', 'signup']
    if request.endpoint not in allowed_routes and 'username' not in session:
        return redirect(url_for('login'))

@app.route('/login', methods=['GET', 'POST'])
def login():
    # 登录逻辑
    pass

@app.route('/signup', methods=['GET', 'POST'])
def signup():
    # 注册逻辑
    pass

@app.route('/')
def index():
    return "Welcome, " + session['username']
```
在这个例子中，require_login 函数使用了 @app.before_request 装饰器，所以它会在每个请求开始之前运行。这个函数检查用户是否已经登录（即 'username' 是否在 session 中）。如果用户未登录，并且他们正在尝试访问除 ‘login’ 和 ‘signup’ 以外的路由，那么他们将被重定向到登录页面。

注意：这个例子假设你已经设置了 session，并且在用户登录时将他们的用户名添加到了 session 中。在实际的 Flask 应用中，你可能还需要使用 Flask 的 flask_login 扩展来更安全、更方便地处理用户登录。
@app.after_request()：这个装饰器用于注册在每次请求之后运行的函数，无论请求是否成功。这对于需要在处理请求之后执行某些操作（如关闭数据库连接、记录日志等）的情况非常有用。

让我们来看一个使用 @app.after_request() 装饰器的例子。假设我们有一个 Flask 应用，我们想在每个请求结束后在服务器日志中记录一些信息，比如请求的状态码和处理请求所花费的时间。
```
from flask import Flask, request
import time

app = Flask(__name__)

@app.before_request
def start_timer():
    request.start_time = time.time()

@app.after_request
def log_request(response):
    # 获取请求开始时间
    start_time = request.start_time
    # 计算请求花费的时间
    elapsed_time = time.time() - start_time
    # 获取请求的路径
    path = request.path
    # 获取响应的状态码
    status_code = response.status_code
    # 记录信息到服务器日志
    app.logger.info(f"Path: {path}, Status Code: {status_code}, Time: {elapsed_time}")
    return response

@app.route('/')
def index():
    return "Hello, World!"
```
在这个例子中，start_timer 函数使用了 @app.before_request 装饰器，所以它会在每个请求开始之前运行。这个函数记录了请求开始的时间。

log_request 函数使用了 @app.after_request 装饰器，所以它会在每个请求结束后运行。这个函数计算了处理请求所花费的时间（当前时间减去请求开始的时间），然后将请求的路径、响应的状态码和处理请求所花费的时间记录到服务器日志中。

注意：这个例子假设你的 Flask 应用已经配置了日志记录。在实际的 Flask 应用中，你可能需要使用 Flask 的 app.logger 对象或其他日志库来记录日志。
@app.teardown_request()：这个装饰器用于注册在每次请求结束后运行的函数，无论请求是否成功。这对于需要在请求结束后执行某些清理操作的情况非常有用。

看一个使用 @app.teardown_request() 装饰器的例子。假设我们有一个 Flask 应用，我们在每个请求开始时都会打开一个数据库连接，我们想在每个请求结束后关闭这个连接。
```
from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:tmp/test.db'
db = SQLAlchemy(app)

@app.before_request
def before_request():
    # 打开数据库连接
    db.session = db.create_scoped_session()

@app.teardown_request
def teardown_request(exception):
    # 关闭数据库连接
    db.session.remove()

@app.route('/')
def index():
    return "Hello, World!"
```
在这个例子中，before_request 函数使用了 @app.before_request 装饰器，所以它会在每个请求开始之前运行。这个函数创建了一个新的数据库会话并将其存储在 db.session 中。

teardown_request 函数使用了 @app.teardown_request 装饰器，所以它会在每个请求结束后运行，无论请求是否成功。这个函数关闭了数据库会话。
@app.errorhandler()：这个装饰器用于注册错误处理函数。你可以使用它来定义当特定的 HTTP 错误发生时应该如何响应。例如：
```
@app.errorhandler(404)
def page_not_found(error):
return 'This page does not exist', 404
```