消息闪烁

良好的应用程序和用户界面都与反馈有关。如果用户没有得到足够的反馈,他们最终可能会讨厌该应用程序。Flask 提供了一种非常简单的方式来使用闪烁系统向用户提供反馈。闪烁系统基本上可以记录请求结束时的消息,并在下一个请求(仅下一个请求)中访问它。这通常与执行此操作的布局模板结合使用。请注意,浏览器和有时 Web 服务器对 Cookie 大小实施了限制。这意味着对于会话 Cookie 来说过大的闪烁消息会导致消息闪烁静默失败。

简单闪烁

这是一个完整的示例

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

app = Flask(__name__)
app.secret_key = b'_5#y2L"F4Q8z\n\xec]/'

@app.route('/')
def index():
    return render_template('index.html')

@app.route('/login', methods=['GET', 'POST'])
def login():
    error = None
    if request.method == 'POST':
        if request.form['username'] != 'admin' or \
                request.form['password'] != 'secret':
            error = 'Invalid credentials'
        else:
            flash('You were successfully logged in')
            return redirect(url_for('index'))
    return render_template('login.html', error=error)

这是执行此操作的 layout.html 模板

<!doctype html>
<title>My Application</title>
{% with messages = get_flashed_messages() %}
  {% if messages %}
    <ul class=flashes>
    {% for message in messages %}
      <li>{{ message }}</li>
    {% endfor %}
    </ul>
  {% endif %}
{% endwith %}
{% block body %}{% endblock %}

这是从 layout.html 继承的 index.html 模板

{% extends "layout.html" %}
{% block body %}
  <h1>Overview</h1>
  <p>Do you want to <a href="{{ url_for('login') }}">log in?</a>
{% endblock %}

这是也从 layout.html 继承的 login.html 模板

{% extends "layout.html" %}
{% block body %}
  <h1>Login</h1>
  {% if error %}
    <p class=error><strong>Error:</strong> {{ error }}
  {% endif %}
  <form method=post>
    <dl>
      <dt>Username:
      <dd><input type=text name=username value="{{
          request.form.username }}">
      <dt>Password:
      <dd><input type=password name=password>
    </dl>
    <p><input type=submit value=Login>
  </form>
{% endblock %}

带类别的闪烁

更新日志

0.3 版的新增功能。

闪烁消息时还可以提供类别。如果没有提供任何内容,则默认类别为 'message'。可以使用其他类别来向用户提供更好的反馈。例如,错误消息可以用红色背景显示。

要闪烁带有不同类别的消息,只需使用 flash() 函数的第二个参数

flash('Invalid password provided', 'error')

然后,在模板中,您必须告诉 get_flashed_messages() 函数也返回类别。在这种情况下,循环看起来略有不同

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

这只是呈现这些闪烁消息的一个示例。还可以使用类别为消息添加前缀,例如 <strong>Error:</strong>

过滤 Flash 消息

更新日志

0.9 版新增。

您还可以选择传递一个类别列表,该列表将过滤 get_flashed_messages() 的结果。如果您希望在单独的块中呈现每个类别,这将非常有用。

{% with errors = get_flashed_messages(category_filter=["error"]) %}
{% if errors %}
<div class="alert-message block-message error">
  <a class="close" href="#">×</a>
  <ul>
    {%- for msg in errors %}
    <li>{{ msg }}</li>
    {% endfor -%}
  </ul>
</div>
{% endif %}
{% endwith %}