flask中的常用装饰器

这篇具有很好参考价值的文章主要介绍了flask中的常用装饰器。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

flask中的常用装饰器,flask,python,flask,python,后端

flask中的常用装饰器

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

  1. @app.route():这可能是 Flask 中最常用的装饰器。它用于将 URL 路由绑定到一个 Python 函数,这个函数就是处理对应 URL 请求的视图函数。例如:

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

    在这个例子中,@app.route('/') 装饰器将根 URL (/) 绑定到了 home 函数。当用户访问应用的根 URL 时,home 函数就会被调用,并返回 “Hello, World!”。

  2. @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 扩展来更安全、更方便地处理用户登录。

  3. @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 对象或其他日志库来记录日志。

  4. @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 装饰器,所以它会在每个请求结束后运行,无论请求是否成功。这个函数关闭了数据库会话。

  5. @app.errorhandler():这个装饰器用于注册错误处理函数。你可以使用它来定义当特定的 HTTP 错误发生时应该如何响应。例如:

    @app.errorhandler(404)
    def page_not_found(error):
    return 'This page does not exist', 404
    

​ 在这个例子中,@app.errorhandler(404) 装饰器将 page_not_found 函数注册为处理 404 错误的函数。文章来源地址https://www.toymoban.com/news/detail-612057.html

到了这里,关于flask中的常用装饰器的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 谈一谈Python中的装饰器

    1.1 何为Python中的装饰器? Python中装饰器的定义以及用途: 装饰器是一种特殊的函数,它可以接受一个函数作为参数,并返回一个新的函数。装饰器可以用来修改或增强函数的行为,而不需要修改函数本身的代码。在Python中,装饰器通常用于实现AOP(面向切面编程),例如日

    2023年04月16日
    浏览(64)
  • Python中的装饰器详解及实际应用【第120篇—装饰器详解】

    在Python编程中,装饰器(Decorator)是一种强大而灵活的工具,用于修改函数或方法的行为。它们广泛应用于许多Python框架和库,如Flask、Django等。本文将深入探讨装饰器的概念、使用方法,并提供实际应用的代码示例和详细解析。 装饰器是一种特殊的函数,它可以接受一个函

    2024年03月11日
    浏览(53)
  • python中的装饰器原理和作用

    装饰器的作用就是用一个新函数封装旧函数(是旧函数代码不变的情况下增加功能)然后会返回一个新函数,新函数就叫做装饰器,一般为了简化装饰器会用语法糖@新函数来简化 例子: 这是一段代码,但功能太少,要对这个进行增强,但又不能改变代码。 现在我们的需求是

    2024年02月05日
    浏览(32)
  • Python教程(24)——全方位解析Python中的装饰器

    Python装饰器是一种特殊的函数,它接收一个函数作为参数,然后返回一个新的函数,用于扩展或修改原始函数的行为。装饰器提供了一种便捷的方式来在不修改被装饰函数源代码的情况下,增加、修改或包装函数的功能。通俗点说就是尽量不修改原有功能代码的情况下,给原

    2024年02月02日
    浏览(60)
  • 【python】flask模板渲染引擎Jinja2,通过后端数据渲染前端页面

    ✨✨ 欢迎大家来到景天科技苑✨✨ 🎈🎈 养成好习惯,先赞后看哦~🎈🎈 🏆 作者简介:景天科技苑 🏆《头衔》:大厂架构师,华为云开发者社区专家博主,阿里云开发者社区专家博主,CSDN新星创作者,掘金优秀博主,51CTO博客专家等。 🏆《博客》:Python全栈,前后端开

    2024年04月11日
    浏览(57)
  • flask处理token的装饰器

    以下是在 Flask 中基于 token 实现的登录验证装饰器的示例代码: 该装饰器首先检查请求头中是否存在 Authorization 字段,并解码其中的 token。如果没有找到 token,则返回一个包含错误消息的 JSON 响应。如果找到了 token,则使用 JWT 对其进行解码,同时使用 Flask 的 current_app 对象获

    2024年02月13日
    浏览(41)
  • (三)Flask前置知识栈——装饰器

    在后续的讲解中,对大家对装饰器的掌握程度要求较高,所以此文来深入讲解一下,有看过《Python全栈系列教程》专栏的小伙伴可能会说,装饰器已经出过文章讲的很详细了。饶是如此,深究过装饰器的小伙伴们就权当复习一遍,同时,本篇文章会有所拓展哦~ 在继续之前,

    2024年02月15日
    浏览(41)
  • (八)Flask之app.route装饰器函数的参数

    app.route() 是Flask框架中用于定义路由的装饰器函数,它接受一些参数来指定路由的URL规则、请求方法等。 app.route() 参数如下: rule (必选):定义URL规则的字符串,表示要匹配的URL路径。可以包含动态部分,使用尖括号( )来指定动态部分的名称和类型。例如: /user/username 。

    2024年02月05日
    浏览(45)
  • python在flask中的请求数据“无限流”

    在flask请求中,有个需求是让调用方一直调接口,并立马返回,而接口方缓存请求,依次执行。 注意: 需要注意的是, request_queue.get() 之后队列里的值就直接推出了,不用显式推出。 以上就可以做到讲请求立刻返回,接口缓存请求内容自我\\\"消化\\\"。Enjoy~ ∼ O n e   p e r s o n  

    2024年02月21日
    浏览(37)
  • 【毕设必备】手把手带你用Python搭建一个简单的后端服务- API的创建,前后端交互的数据传递,GET,POST,JSON,FLASK

    Python是一种 流行 的高级编程语言,具有易于学习和使用的特性,被广泛应用于各种领域。 简单易学 :Python的语法清晰简洁,易于理解和学习。与其他编程语言相比,Python的语法设计非常直观,使得编程新手也能快速上手。 强大的标准库和丰富的第三方库 :Python拥有一个庞

    2024年02月04日
    浏览(174)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包