消息闪现¶

一个好的应用和用户界面都需要良好的反馈。如果用户得不到足够的反馈，那么应用最终会被用户唾弃。 Flask 的闪现系统提供了一个良好的反馈方式。闪现系统的基本工作方式是：在且只在下一个请求中访问上一个请求结束时记录的消息。一般我们结合布局模板来使用闪现系统。注意，浏览器会限制 cookie 的大小，有时候网络服务器也会。这样如果消息比会话 cookie 大的话，那么会导致消息闪现静默失败。

简单的例子¶

以下是一个完整的示例:

  1. from flask import Flask, flash, redirect, render_template, \
  2.      request, url_for
  3.  
  4. app = Flask(__name__)
  5. app.secret_key = b'_5#y2L"F4Q8z\n\xec]/'
  6.  
  7. @app.route('/')
  8. def index():
  9.     return render_template('index.html')
  10.  
  11. @app.route('/login', methods=['GET', 'POST'])
  12. def login():
  13.     error = None
  14.     if request.method == 'POST':
  15.         if request.form['username'] != 'admin' or \
  16.            request.form['password'] != 'secret':
  17.             error = 'Invalid credentials'
  18.         else:
  19.             flash('You were successfully logged in')
  20.             return redirect(url_for('index'))
  21.     return render_template('login.html', error=error)

以下是实现闪现的 layout.html 模板：

  1. <!doctype html>
  2. <title>My Application</title>
  3. {% with messages = get_flashed_messages() %}
  4.   {% if messages %}
  5.     <ul class=flashes>
  6.     {% for message in messages %}
  7.       <li>{{ message }}</li>
  8.     {% endfor %}
  9.     </ul>
  10.   {% endif %}
  11. {% endwith %}
  12. {% block body %}{% endblock %}

以下是继承自 layout.html 的 index.html 模板：

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

以下是同样继承自 layout.html 的 login.html 模板：

  1. {% extends "layout.html" %}
  2. {% block body %}
  3.   <h1>Login</h1>
  4.   {% if error %}
  5.     <p class=error><strong>Error:</strong> {{ error }}
  6.   {% endif %}
  7.   <form method=post>
  8.     <dl>
  9.       <dt>Username:
  10.       <dd><input type=text name=username value="{{
  11.           request.form.username }}">
  12.       <dt>Password:
  13.       <dd><input type=password name=password>
  14.     </dl>
  15.     <p><input type=submit value=Login>
  16.   </form>
  17. {% endblock %}

闪现消息的类别¶

Changelog

New in version 0.3.


闪现消息还可以指定类别，如果没有指定，那么缺省的类别为 'message' 。不同的类别可以给用户提供更好的反馈。例如错误消息可以使用红色背景。

使用 flash() 函数可以指定消息的类别:

  1. flash(u'Invalid password provided', 'error')

模板中的 get_flashed_messages() 函数也应当返回类别，显示消息的循环也要略作改变：

  1. {% with messages = get_flashed_messages(with_categories=true) %}
  2.   {% if messages %}
  3.     <ul class=flashes>
  4.     {% for category, message in messages %}
  5.       <li class="{{ category }}">{{ message }}</li>
  6.     {% endfor %}
  7.     </ul>
  8.   {% endif %}
  9. {% endwith %}

上例展示如何根据类别渲染消息，还可以给消息加上前缀，如<strong>Error:</strong> 。

过滤闪现消息¶

Changelog

New in version 0.9.


你可以视情况通过传递一个类别列表来过滤 get_flashed_messages() 的结果。这个功能有助于在不同位置显示不同类别的消息。

  1. {% with errors = get_flashed_messages(category_filter=["error"]) %}
  2. {% if errors %}
  3. <div class="alert-message block-message error">
  4.   <a class="close" href="#">×</a>
  5.   <ul>
  6.     {%- for msg in errors %}
  7.     <li>{{ msg }}</li>
  8.     {% endfor -%}
  9.   </ul>
  10. </div>
  11. {% endif %}
  12. {% endwith %}

原文: https://dormousehole.readthedocs.io/en/latest/patterns/flashing.html