（十三）Flask之特殊装饰器详解

news2024/12/28 5:51:50

目录：

  • Flask中用作装饰器的特殊的函数
    • 第一部分：`before_request`和`after_request`
      • 一、 `before_request`装饰器：
      • 二、`after_request`装饰器：
      • 三、多个`before_request`和`after_request`执行流程分析：
        • 首先—理论讲解：
        • 然后—实战讲解：
        • 最后—扒扒源码：
        • 画图形象记忆：
    • 第二部分：实战—使用`before_request`进行身份验证
    • 第三部分：补充常见特殊装饰器
      • 一、`@app.errorhandler(code)`：
      • 二、 `@app.teardown_request`：
      • 三、`@app.template_test`：
      • 四、`@app.before_first_request`：

Flask中用作装饰器的特殊的函数

第一部分：before_request和after_request

在Flask中，before_request和after_request是用作装饰器的特殊函数，它们可以用来在请求处理过程中执行某些操作。

一、 before_request装饰器：

  • 通过在函数上使用@app.before_request装饰器，可以将该函数注册为全局的请求前钩子（hook）。这意味着每次请求到达服务器时，在实际处理请求之前，都会先执行被before_request装饰的函数。
  • before_request函数通常用于执行一些预处理任务，例如验证用户身份、设置全局变量、打开数据库连接等。它可以修改请求或应用程序上下文，并且可以返回响应对象或 None（后面扒扒源码看看）。

比如：

@app.before_request
def before_request():
    # 执行一些预处理任务
    if not current_user.is_authenticated:
        return redirect(url_for('login'))

二、after_request装饰器：

  • 通过在函数上使用@app.after_request装饰器，可以将该函数注册为全局的请求后钩子。这意味着在每次请求完成并返回响应之后，都会执行被after_request装饰的函数。

  • after_request函数通常用于执行一些后处理任务，例如**添加响应头、记录请求日志、关闭数据库连接等。**它接收一个参数，即响应对象，并且必须返回一个响应对象。

比如：

@app.after_request
def after_request(response):
    # 执行一些后处理任务
    response.headers['X-Frame-Options'] = 'SAMEORIGIN'
    return response

通过使用before_request和after_request装饰器，可以在请求的前后执行一些共同的逻辑，从而实现全局的预处理和后处理操作。这样可以避免在每个视图函数中重复编写相同的代码。

三、多个before_request和after_request执行流程分析：

首先—理论讲解：

当存在多个before_request和after_request装饰器时，分析它们的执行顺序：

  1. before_request执行流程：

    • 当一个请求到达服务器时，首先会执行第一个注册的before_request装饰的函数。
    • 如果该函数返回了一个响应对象，则停止执行后续所有的before_request函数，而是直接返回该响应对象给客户端。
    • 如果该函数没有返回响应对象，则继续执行下一个注册的before_request函数，以此类推，直到所有的before_request函数都被执行完毕。

  2. after_request执行流程：

    • 在每次请求完成并返回响应之后，从最后一个注册的after_request装饰的函数开始执行。
    • 每个after_request函数都会接收前一个after_request函数所返回的响应对象作为参数，并且必须返回一个新的响应对象。
    • 执行完最后一个after_request函数后，最终的响应对象将会发送给客户端。
然后—实战讲解：
from flask import Flask, session

app = Flask(__name__)  # 创建Flask应用程序对象


@app.before_request
def before_request_1():
    print("Before Request 1")


@app.before_request
def before_request_2():
    print("Before Request 2")


@app.after_request
def after_request_1(response):
    print("After Request 1")
    return response


@app.after_request
def after_request_2(response):
    print("After Request 2")
    return response


@app.route('/')
def index():
    print("Index Page")
    return "Hello, World!"


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

输出的执行顺序如下：

在这里插入图片描述

可以看到，首先执行了before_request_1和before_request_2两个函数，然后处理了请求并返回响应，接着按照相反的顺序执行了after_request_2和after_request_1两个函数。

最后—扒扒源码：

为何before_request是按注册顺序执行，而after_request是按注册倒序执行嘞？

扒一扒源码就晓得啦~

直接进入before_request和after_request的身体：

在这里插入图片描述

上面就是Flask注册before_request和after_request函数的方法，一模一样！

下面来扒下Flask执行before_request和after_request函数部分的源码：

进入app.__call__()后直到full_dispatch_request函数：

在这里插入图片描述

在这里插入图片描述

关注点先放在上图第二个for循环，其余部分后续会慢慢探究~

before_request_funcs 就是上述包含了请求前钩子函数的字典。这些函数会在请求分发（即dispatch_request）之前被调用。

遍历每个注册的请求前钩子函数，并执行它们。如果任何一个请求前钩子函数**返回一个非 None 的值，该值会被当作视图函数的返回值处理（直接返回给客户端页面），并且后续的请求处理流程会被停止【但是after_request正常执行！】；**如果没有任何请求前钩子函数返回非 None 值，那么 preprocess_request 方法会返回 None。

来个代码讲解：

在这里插入图片描述
在这里插入图片描述

画图形象记忆：

绿色就是所有请求前钩子函数(before_request)返回值都为None时的执行流程；

相应的，白色就是有一个返回值非None时的执行流程。
在这里插入图片描述

差点忘了带大家看after_request了！

在这里插入图片描述
在这里插入图片描述

在这里插入图片描述

看到没！reversed！！！反向遍历哦~

第二部分：实战—使用before_request进行身份验证

上代码：

from flask import Flask, request, redirect, url_for, render_template, session

app = Flask(__name__)

# 模拟的用户数据库
users = {
    'admin': {
        'username': 'admin',
        'password': 'GuHanZhe'
    }
}


@app.before_request
def authenticate_user():
    # 获取当前请求的路径
    path = request.path

    # 如果请求的路径不是登录页面，进行身份验证
    if path != '/login':
        # 检查 session 中是否存在已登录的用户
        if 'username' not in session:
            # 用户未登录，重定向到登录页面
            return redirect(url_for('login'))


@app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'POST':
        username = request.form['username']
        password = request.form['password']

        # 在实际开发中，这里需要进行密码验证
        if username in users and users[username]['password'] == password:
            # 登录成功，将用户名保存在 session 中
            session['username'] = username
            return redirect(url_for('protected_page'))
        else:
            # 登录失败，显示错误信息
            error_message = "Invalid username or password."
            return render_template('login.html', error_message=error_message)

    return render_template('login.html')


@app.route('/protected')
def protected_page():
    return "This is a protected page. Only logged-in users can access it."


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

在上述代码中，before_request 钩子函数 authenticate_user 用于验证用户身份。它会在每个请求到达之前被调用，除了登录页面 /login 外的所有页面都需要进行身份验证。

如果用户未登录，authenticate_user 函数将重定向到登录页面，使用 redirect 函数和 url_for 函数实现页面重定向。登录成功后，将用户名保存在 session 中，以便在后续的请求中进行验证。

login 路由处理函数负责渲染登录页面，并接收用户提交的表单数据。在实际应用中，需要根据数据库中的用户信息进行密码验证。验证成功后，将用户名保存在 session 中，并重定向到受保护的页面 /protected。

protected_page 路由处理函数是一个示例的受保护页面，只有登录用户可见。

第三部分：补充常见特殊装饰器

一、@app.errorhandler(code)：

  • 这是用于注册错误处理函数的装饰器。
  • code 参数指定了需要处理的错误码，例如 404、500 等。
  • 装饰的函数将作为错误处理函数，在出现指定错误码时被调用，并返回自定义的错误页面或响应。

二、 @app.teardown_request：

用于注册在每个请求结束时执行的函数。它可以用来进行一些清理操作或释放资源。

实战：

from flask import Flask

app = Flask(__name__)


@app.route('/')
def index():
    return "Hello, World!"


@app.teardown_request
def teardown_request_func(error=None):
    print("Teardown function is called after each request.")


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

在上述代码中，定义了一个名为 teardown_request_func 的函数，并使用 @app.teardown_request 装饰器将其注册为每个请求结束时执行的函数。

当我们访问任何路由时，Flask 会在请求结束后自动调用 teardown_request_func 函数。无论请求是否出现错误，该函数都会被执行。

需要注意的是，@app.teardown_request 装饰的函数只能接受一个参数，即可选的错误对象。如果要访问请求上下文中的其他对象，可以使用 flask.request 对象。

这个装饰器通常用于进行一些清理操作，例如关闭数据库连接、释放资源等。

三、@app.template_test：

用于注册自定义模板测试函数的装饰器。

实战：

from flask import Flask

app = Flask(__name__)


@app.template_test('even')
def is_even(number):
    return number % 2 == 0


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

通过 @app.template_test('even') 装饰器将 is_even 函数注册为一个名为 “even” 的模板测试函数。该函数用于判断一个数字是否是偶数。

在模板中，可以使用 {% if %} 语句来调用这个模板测试函数：

{% if num is even %}
    <p>The number is even</p>
{% else %}
    <p>The number is odd</p>
{% endif %}

通过注册模板测试函数，我们可以在模板中使用自定义的逻辑判断函数，以便根据特定的条件进行动态渲染和显示不同的内容。

四、@app.before_first_request：

用于注册在第一个请求到达之前执行的函数。它只会在应用程序启动时执行一次。

实战：

from flask import Flask

app = Flask(__name__)


@app.before_first_request
def before_first_request_func():
    print("This function is executed before the first request.")


@app.route('/')
def index():
    return "Hello, World!"


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

在上述代码中，before_first_request_func 被装饰为 @app.before_first_request，它会在第一个请求到达之前执行。

当我们运行这个应用程序时，before_first_request_func 函数会在第一个请求到达之前执行一次。之后，每个请求到达时，都不会再次调用该函数。

需要注意的是，@app.before_first_request 装饰的函数仅在主线程中执行，并且只有在应用程序启动时才会被调用一次。如果使用多线程或多进程部署应用程序，可以考虑使用其他方法来进行初始化操作。

【新版本Flask没有这个装饰器了~】

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1258738.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

Java核心知识点整理大全18-笔记

Java核心知识点整理大全18-笔记

Java核心知识点整理大全-笔记_希斯奎的博客-CSDN博客 Java核心知识点整理大全2-笔记_希斯奎的博客-CSDN博客 Java核心知识点整理大全3-笔记_希斯奎的博客-CSDN博客 Java核心知识点整理大全4-笔记-CSDN博客 Java核心知识点整理大全5-笔记-CSDN博客 Java核心知识点整理大全6…
阅读更多...
沈阳陪诊系统|陪诊软件开发功能

沈阳陪诊系统|陪诊软件开发功能

陪诊小程序的出现它可以帮助患者或家属解决就医过程中的各种问题。根据数据显示&#xff0c;2021年中国陪诊市场规模约为36.7亿元&#xff0c;预计到2025年将达到100亿元。同时&#xff0c;在医疗行业数字化转型的大背景下&#xff0c;陪诊微信小程序作为一种创新的医疗服务模式…
阅读更多...
ABAP: JSON 报文解析——/ui2/cl_json

ABAP: JSON 报文解析——/ui2/cl_json

1、JSON数组 报文格式如下&#xff0c;是JSON 数组类型的。 [{"I_TYPE":"V","I_BUSINESSSCOPE":"1001"},{"I_TYPE":"V","I_BUSINESSSCOPE":"1002"} ] json转换为SAP内表&#xff1a; TYP…
阅读更多...
二 使用GPIO的复用功能 利用USART 实现printf()

二 使用GPIO的复用功能 利用USART 实现printf()

参考这篇&#xff1a; STM32串口通信详解 1. 关于USART USART ( universal synchronous / asynchronous receiver /transmitter) 是一种串行通讯协议 , 允许设备通过串行端口进行数据传输&#xff0c; USART 能够以同步或者异步的方式进行工作&#xff0c;在实际的运用中&…
阅读更多...
机器学习的复习笔记4-岭回归与多项式回归

机器学习的复习笔记4-岭回归与多项式回归

一、岭回归 在简单的线性回归中&#xff0c;一味追求平方误差最小化&#xff0c;R2值尽可能大&#xff0c;可能会受到噪声的严重干扰。噪声&#xff0c;即偶发的错误的值。 如图&#xff0c;若为满足所有点的拟合&#xff08;虚线&#xff09;&#xff0c;表面上看R2值小&…
阅读更多...
虚拟偶像的商业化

虚拟偶像的商业化

虚拟偶像的商业化主要通过以下几种方式实现&#xff1a; 直播与内容&#xff1a;虚拟主播在各大平台进行直播&#xff0c;提供音乐、游戏、教育等内容。收益主要包括Super Chat&#xff08;直播打赏&#xff09;、收费会员&#xff08;支付月费后成为该频道会员&#xff0c;可…
阅读更多...
如何使用WMS仓储管理系统实现流程优化

如何使用WMS仓储管理系统实现流程优化

随着企业对于物流管理的需求日益增长&#xff0c;自动化WMS仓储管理系统已经成为了现代企业的核心工具之一。通过引入信息化技术&#xff0c;我们可以实现仓库管理流程的不断调整和优化&#xff0c;从而更好地满足客户的多样化需求。 一、信息化技术的引领 在现代仓库管理中&a…
阅读更多...
Docker和Kubernetes：区别与优势对比

Docker和Kubernetes：区别与优势对比

在现代软件开发和部署中&#xff0c;Docker和Kubernetes是两个备受关注的技术。本文将对Docker和Kubernetes进行比较&#xff0c;探讨它们的区别和各自的优势。 引言 在过去的几年中&#xff0c;容器技术得到了迅速的发展&#xff0c;并且在现代软件交付和部署中扮演着越来越重…
阅读更多...
如何获取抖音订单列表

如何获取抖音订单列表

怎么获取订单列表接口 请求地址&#xff1a;响应参数以及示例
阅读更多...
为什么我用 AI 做不出好看的图？好说给你划重点

为什么我用 AI 做不出好看的图？好说给你划重点

最近一个月&#xff0c;我们介绍了些实用的 AI 绘画教程&#xff0c;不知道看过的你是学会了吗&#xff1f;有不少朋友和小编说&#xff0c;有了这些教程&#xff0c;用好说 AI 的指令做起图来比 SD 方便了不少。 不过也有朋友就和小编抱怨&#xff1a;“你教程里的和我做出来…
阅读更多...
Flask 实现Token认证机制

Flask 实现Token认证机制

在Flask框架中&#xff0c;实现Token认证机制并不是一件复杂的事情。除了使用官方提供的flask_httpauth模块或者第三方模块flask-jwt&#xff0c;我们还可以考虑自己实现一个简易版的Token认证工具。自定义Token认证机制的本质是生成一个令牌&#xff08;Token&#xff09;&…
阅读更多...
dubbo框架技术文档-《spring-boot整合dubbo框架搭建+配置文件》框架的本地基础搭建

dubbo框架技术文档-《spring-boot整合dubbo框架搭建+配置文件》框架的本地基础搭建

阿丹&#xff1a; 目前流行的微服务更多的就是dubbo和springcould微服务。之前阿丹没有出过dubbo相关的文章&#xff0c;因为之前接触springcould的微服务概念比较多一点&#xff0c;但是相对于springcould来说&#xff0c;springcould服务之间的调用是大多是使用了nacos&#…
阅读更多...
Cascader 级联选择器动态加载数据的回显

Cascader 级联选择器动态加载数据的回显

如果后端没有只返回第三级的id,而是同时把第三级的名字一起返回了&#xff0c;那么就可以通过下面的方法来实现 1.在级联选择器里面加上这句代码 placeholder"请选择" 2.注册一个字符串 pleasett:"" 3.赋值 如过后端返回的有第三级的选项名 直接进行赋…
阅读更多...
记录一个mqtt错误

记录一个mqtt错误

在vue-admin-template 中引入mqtt 安装不报错&#xff0c;引入试过 import mqtt from mqtt import * as mqtt from mqtt/dist/mqtt.min; import {connect} from mqtt 一直报错&#xff1a; 就表示不理解&#xff0c;网上也没查到相应的资料&#xff0c;请告诉我我不是第一个遇…
阅读更多...
pytest系列——pytest_runtest_makereport钩子函数获取测试用例执行结果

pytest系列——pytest_runtest_makereport钩子函数获取测试用例执行结果

前言 pytest测试框架提供的很多钩子函数方便我们对测试框架进行二次开发&#xff0c;可以根据自己的需求进行改造。 例如&#xff1a;钩子方法&#xff1a;pytest_runtest_makereport &#xff0c;可以更清晰的了解测试用例的执行过程&#xff0c;并获取到每个测试用例的执行…
阅读更多...
Python基础：字符串（String）详解

Python基础：字符串（String）详解

1. 字符串定义 在Python中&#xff0c;字符串是一种数据类型&#xff0c;用于表示文本数据。字符串是由字符组成的序列&#xff0c;可以包含字母、数字、符号和空格等字符。在Python中&#xff0c;你可以使用单引号&#xff08;&#xff09;或双引号&#xff08;"&#xf…
阅读更多...
【Python】巧用tkinter设计秒表计时器

【Python】巧用tkinter设计秒表计时器

秒表计时器是一种用于计算时间间隔的计时器。它通常由一个开始按钮、一个停止按钮和一个重置按钮组成。 使用方法&#xff1a; 单击“开始”按钮开始计时。单击“停止”按钮停止计时。单击“重置”按钮将计时器归零。 注意事项&#xff1a; 没有对计时器误差进行校准&#…
阅读更多...
【密码学】【多方安全计算】不经意传输（Oblivious Transfer，OT）

【密码学】【多方安全计算】不经意传输（Oblivious Transfer，OT）

文章目录 不经意传输&#xff08;oblivious transfer&#xff09;定义不经意传输的实例&#xff08;1 out 2&#xff0c;二选一不经意传输&#xff09;基于RSA的1 out 2 不经意传输疑问 不经意传输&#xff08;oblivious transfer&#xff09;定义 不经意传输&#xff08;obli…
阅读更多...
Spring之@Autowired 属性多实现和单实现源码解析

Spring之@Autowired 属性多实现和单实现源码解析

Autowired使用过程中遇到疑问&#xff0c;通过源码解析原因 一、起因1、当person只有一个实现类时&#xff0c;TestController中&#xff0c;Person属性随意取名。2、当有Person两个实现类时&#xff0c;TestController中&#xff0c;属性名称必须和实现类名一致&#xff08;ma…
阅读更多...
HarmonyOS 位置服务开发指南

HarmonyOS 位置服务开发指南

位置服务开发概述 移动终端设备已经深入人们日常生活的方方面面&#xff0c;如查看所在城市的天气、新闻轶事、出行打车、旅行导航、运动记录。这些习以为常的活动&#xff0c;都离不开定位用户终端设备的位置。 当用户处于这些丰富的使用场景中时&#xff0c;系统的位置能力…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023