消息闪现

良好的应用和用户界面都强调“反馈”。 如果用户得不到足够的反馈,他们很可能会讨厌这个应用。 Flask 提供了一个非常简单的方式来向用户提供反馈 —— 闪现系统(flashing system)。 闪现系统的基本原理是在一个请求结束时记录一条消息,并在**下一个请求**中访问该消息,仅限一次。 这通常配合一个包含通用布局的模板一起使用。 请注意,浏览器以及某些 Web 服务器会限制 Cookie 的大小, 这意味着如果闪现的消息过大,超过了 session 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.htmlindex.html 模板:

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

这是同样继承自 layout.htmllogin.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 %}

闪现消息的分类

Changelog

Added in version 0.3.

闪现消息时也可以添加“类别”(categories)。 如果没有指定,默认类别是 '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>错误:</strong>

过滤闪现的消息

Changelog

Added in version 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 %}