功能

flask通过flash message给用户反馈。flash message在请求结束时记录信息并在下一个（且仅在下一个）请求中访问。通常结合模板布局来显示消息。

使用方式

  1. 定义一个flash message
  2. 获取flash message

09 flash message - 图1 完整示例：

  1. from flask import Flask, render_template, flash, request, redirect, url_for
  3. app = Flask(__name__)
  4. app.secret_key= b'9\xd5\xf8\xf2\x95\x19\x1a\xd2i0\xb71\xcfh\xcb\xe1E\x07\xbaT\t\xc6]#'
  6. @app.route('/index', endpoint='index')
  7. @app.route('/')
  8. def hello_world():
  9.     return render_template('index.html')
  12. @app.route('/login/', methods=['GET', 'POST'], endpoint='login')
  13. def login():
  14.     error = None
  15.     if request.method == 'POST':
  16.         if request.form['username'] != 'admin' or request.form['password'] != 'secret':
  17.             error = 'Invalid credentials'
  18.         else:
  19.               # 1. 定义flash, 注意：仅可以在下一个请求中访问
  20.             flash('You were successfully logged in')  
  21.             return redirect(url_for('index'))
  22.     return render_template('login.html', error=error)
  25. if __name__ == '__main__':
  26.     app.run()

在base.html 模板中获取 flash

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

模板扩展使用方法，以下是index.html模板

  1. {% extends 'base.html' %}
  3. {% block body %}
  5. <p>welcome to my homepage</p>
  6.     <a href="{{ url_for('login') }}">login</a>
  7. {% endblock %}

login 模板

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

flash类别

flash可以指定类别，默认为message。不同的类别可以给用户提供更好的反馈。例如错误消息可以使用红色背景。

  1. flash('Invalid pasword 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 %}

过滤flash消息

你可以视情况通过传递一个类别列表来过滤 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 %}