Flask 闪存消息在Flask中无法工作

在本文中，我们将介绍Flask中闪存消息无法工作的问题以及如何解决它。Flask是一个流行的Python web框架，其中的闪存消息机制可以用来在重定向或渲染页面时向用户提供反馈信息。

阅读更多：Flask 教程

问题描述

在一些情况下，开发者可能会发现Flask中使用flash()函数来添加消息，但是无法在模板中获取这些消息。这种情况下，当我们在视图函数中使用flash()函数发送消息后，调用get_flashed_messages()函数来获取消息时却返回一个空列表。

问题一般出现在以下几个方面：

1. Session未设置

Flask的闪存消息是通过session来实现的。如果我们忘记在应用中启用session会话或者没有正确配置会话密钥，那么闪存消息会失效。

要解决这个问题，我们需要确保在应用中启用session会话。在Flask中启用session非常简单，只需要设置应用对象的secret_key属性即可。例如：

from flask import Flask, session
app = Flask(__name__)
app.config['SECRET_KEY'] = 'your-secret-key'

2. 重定向问题

在Flask中，闪存消息一般是通过重定向来传递的。在一些情况下，如果重定向发生在与消息相关的请求之前，那么闪存消息可能会丢失。

解决这个问题有两种方法：

a. 使用`flash()`函数的重定向参数

Flask中的flash()函数有一个可以接受重定向参数的选项。这样，当我们在视图函数中使用flash()函数发送消息时，可以通过这个参数来指定重定向的目标，确保消息能够正确传递。

例如，如果我们在登录验证中使用闪存消息，在重定向到首页时，可以使用以下代码：

from flask import redirect, url_for, flash

@app.route('/login', methods=['POST'])
def login():
    # 验证用户登录
    if valid_login(request.form['username'], request.form['password']):
        flash('登录成功', 'success')
        return redirect(url_for('index'))
    else:
        flash('用户名或密码错误', 'error')
        return redirect(url_for('login'))

b. 使用`get_flashed_messages()`函数的`with_categories`参数

get_flashed_messages()函数还有一个with_categories参数，它可以让我们获取指定类型的闪存消息，或者获取所有的闪存消息，而不管它们是否和请求相关。

要获取所有类型的闪存消息，我们可以将with_categories参数设置为True。例如，在模板中使用以下代码来获取所有类型的闪存消息：

“`html+jinja
{% with messages = get_flashed_messages(with_categories=true) %}
{% if messages %}
<ul class="messages">
{% for category, message in messages %}
<li class="{{ category }}">{{ message }}</li>
{% endfor %}
</ul>
{% endif %}
{% endwith %}

<pre><code class="line-numbers">### 3. 消息显示的位置

某些情况下，开发者可能会忽略在模板中显示消息的位置。闪存消息默认会在模板的消息区域显示。我们可以通过在模板中插入以下代码来显示闪存消息：

“`html+jinja
{% with messages = get_flashed_messages() %}
{% if messages %}
<ul class=”messages”>
{% for message in messages %}
<li>{{ message }}</li>
{% endfor %}
</ul>
{% endif %}
{% endwith %}

如果我们希望在其他位置显示闪存消息，可以通过修改模板代码来实现。

示例和使用场景

下面是一个使用Flask闪存消息的示例代码。假设我们有一个简单的用户注册页面，用户填写完表单后，我们将显示成功消息或错误消息来反馈用户注册结果。

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

app = Flask(__name__)
app.config['SECRET_KEY'] = 'your-secret-key'

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

        if username == 'admin' and password == 'password':
            flash('注册成功', 'success')
            return redirect(url_for('login'))

        flash('用户名或密码错误', 'error')

    return render_template('register.html')

@app.route('/login')
def login():
    return '登录页面'

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