最常用的 Flask 装饰器

Flask 是用 Python 构建 Web 应用程序的最流行的微框架之一，它的大部分功能来自装饰器的使用。这些装饰器允许您以干净且可读的方式连接框架的功能，而不会使您的代码混乱。在这篇文章中，我们将探讨五个最常用的 Flask 装饰器，以及两个荣誉奖。

1 @app.route()

@app.route() 装饰器用于定义 Flask 应用程序的 URL 路由。它将 URL 绑定到处理该路由逻辑的 Python 函数。

示例：

@app.route('/')
def home():
返回“欢迎来到主页！”

这个简单的示例将根 URL (/) 映射到 home() 函数，向访问者返回欢迎消息。

2 @app.before_request()

这个装饰器在每个请求之前运行一个函数。它非常适合检查身份验证、初始化变量或设置资源。

示例：

@app.before_request
def check_authentication():
如果不是 user_is_logged_in():
return "请登录", 401

在这种情况下，该函数会在允许用户继续操作之前检查用户是否已通过身份验证。

3 @app.after_request()

@app.after_request() 装饰器允许您在处理请求之后但在将其发送到客户端之前修改响应。这通常用于添加标头或记录响应等任务。

示例：

@app.after_request
def add_security_headers(响应):
response.headers['X-Content-Type-Options'] = 'nosniff'
返回回复

这里，每个响应都会添加一个安全标头。

4 @app.errorhandler()

错误处理对于任何网络应用程序都至关重要。 @app.errorhandler() 装饰器允许您为特定 HTTP 状态代码定义自定义行为，例如 404 Not Found。

示例：

@app.errorhandler(404)
def page_not_found(e):
return "哎呀！找不到页面。", 404

每当发生 404 错误时，此自定义处理程序都会返回一条用户友好的消息。

5 @app.teardown_request()

@app.teardown_request() 用于在请求后进行清理，确保数据库连接等资源正确关闭。

示例：

@app.teardown_request
def close_db_connection(异常=无):
db_session.remove()

这里，即使在请求处理过程中引发异常，数据库会话也会在每次请求后关闭。

荣誉提名

虽然这些装饰器并不总是被频繁使用，但它们在某些情况下非常有用：

@app.before_first_request()

此装饰器用于在处理第一个请求之前执行函数。它非常适合初始化全局资源，例如数据库连接或加载配置。

@app.before_first_request
definitialize_db():
db.connect()
@app.context_processor()

如果您需要将变量注入到全局的所有 Jinja2 模板中，请使用 @app.context_processor() 装饰器。这使得当前用户或应用程序配置等值在每个模板中可用。

@app.context_processor
defject_user():
返回 dict(current_user=get_current_user())

这样，current_user就可以在您的所有模板中使用，而无需每次都手动传递它。

总结

Flask 的装饰器可以轻松管理 Web 请求的生命周期、自定义行为和扩展功能。了解如何以及何时使用这些常见装饰器将有助于保持 Flask 代码干净、可维护且强大。我们错过了您最喜欢的装饰师吗？让我们知道！

来源

• Flask API

• Flask 路由

• Flask 错误处理

• Flask 请求挂钩

• Flask 上下文处理器

• 首次请求前烧瓶

以上是最常用的 Flask 装饰器的详细内容。更多信息请关注PHP中文网其他相关文章！