訊息快閃

良好的應用程式和使用者介面都與回饋息息相關。如果使用者沒有得到足夠的回饋,他們可能會討厭這個應用程式。Flask 提供了一個非常簡單的方式,透過快閃系統向使用者提供回饋。快閃系統基本上可以讓你記錄在請求結束時的訊息,並在下一個請求(且僅限下一個請求)存取它。這通常與執行此操作的版面配置範本結合使用。請注意,瀏覽器有時以及網頁伺服器會強制限制 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 %}

使用類別快閃

更新日誌

在版本 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>

過濾快閃訊息

更新日誌

在版本 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 %}