Flask Session と Cookie
HTTP プロトコル自体はステートレスです——サーバーは2つのリクエストが同じユーザーからのものかどうかを自動的に記憶しません。
Flask はSessionメカニズムによってこの問題を解決し、Webアプリケーションがユーザーの状態を「記憶」できるようにします。
Session の仕組み
Flask はデフォルトでSecureCookieSession、その仕組みは次のとおりです:
- Session データはシリアライズされ、鍵で署名された後、ブラウザの Cookie に保存されます。
- リクエストのたびに、ブラウザは自動的にこの Cookie を送信します。
- Flask は署名を検証した後、データを Python 辞書に復元して利用できるようにします。
ユーザーは Cookie の内容を見ることができます(base64 エンコードされているため)が、改ざんはできません。変更すると署名検証が失敗するからです。
SECRET_KEY の設定
Session を使用するには、まず設定が必要ですSECRET_KEY——署名に使用する鍵。
例
from flask import Flask
app = Flask(__name__)
# 安全なランダムキーを生成します(初回実行時にのみ生成すれば十分です)
# secrets.token_hex() は64文字の16進ランダム文字列を生成します
app.secret_key = secrets.token_hex()
# または固定値を直接設定します(開発には便利ですが、本番環境では使用しないでください)
# app.secret_key = "dev-secret-key-change-in-production"
重要:SECRET_KEY秘密に保ち、十分にランダムである必要があります。キーが漏洩すると、誰でもアプリの Session データを偽造できます。本番環境では環境変数または設定ファイルから読み取り、コードにハードコードしないでください。
高品質なキーを生成するコマンド:
$ python -c 'import secrets; print(secrets.token_hex())' 192b9bdd22ab9ed4d12e236c78afcb9a393ec15f71bbf5dc987d54727823bcbf
Session の読み書き
session辞書に似たオブジェクトであり、使い方は Python の辞書とほぼ同じです:
例
app = Flask(__name__)
app.secret_key = "dev-secret-key"
@app.route("/")
def index():
# session に username が含まれているか確認する
if "username" in session:
return f"""
<h1>おかえりなさい、{session["username"]}!</h1>
<p>あなたの訪問回数:{session.get("visits", 0)}</p>
<p><a href="/logout">ログアウト</a></p>
"""
return """
<h1>サンプル ホーム</h1>
<p>あなたはまだログインしていません。</p>
<p><a href="/login">ログインへ</a></p>
"""
@app.route("/login", methods=["GET", "POST"])
def login():
if request.method == "POST":
username = request.form.get("username", "")
if username:
# ユーザー名を session に保存する
session["username"] = username
# 訪問回数を初期化する
session["visits"] = 0
return redirect(url_for("index"))
return """
<form method="post">
<h2>サンプル にログイン</h2>
<p><input type="text" name="username" placeholder="ユーザー名を入力"></p>
<p><input type="submit" value="ログイン"></p>
</form>
"""
@app.route("/logout")
def logout():
# session のすべてのデータをクリアする
session.clear()
# または特定のキーのみを削除する:
# session.pop("username", None)
return redirect(url_for("index"))
永続 Session
デフォルトでは、Session はブラウザを閉じると無効になります(ブラウザセッションレベル)。
「记住我」機能が必要な場合は、Session を永続(permanent):
例
# 永続セッションの有効期限を設定する(デフォルト31日)
app.config["PERMANENT_SESSION_LIFETIME"] = timedelta(days=7)
@app.post("/login-remember")
def login_remember():
username = request.form.get("username")
if username:
session["username"] = username
# 永続セッションとしてマークし、ブラウザを閉じても有効
session.permanent = True
return redirect(url_for("index"))
Message Flashing——一度きりのメッセージ
ユーザーがフォームを送信した後、「操作成功」または「エラー」のフィードバックメッセージを表示する必要があります。
この「一度表示したら消える」メッセージのために、Flask はflash()メカニズムを提供しています。
例
app = Flask(__name__)
app.secret_key = "dev-secret-key"
@app.route("/post", methods=["GET", "POST"])
def create_post():
if request.method == "POST":
title = request.form.get("title", "").strip()
if not title:
# エラーメッセージを flash に保存し、分類を "error" にします
flash("タイトルは空にできません", "error")
return redirect(url_for("create_post"))
# 成功メッセージを flash に保存し、分類を "success" にします
flash(f"記事「{title}」の公開に成功しました!", "success")
return redirect(url_for("create_post"))
return render_template("create_post.html")
@app.route("/flash-demo")
def flash_demo():
# flash されたすべてのメッセージを取得する(読み取り後に自動的にクリアされる)
messages = get_flashed_messages(with_categories=True)
return render_template("flash_demo.html", messages=messages)
テンプレートで flash メッセージを描画する:
例
<!DOCTYPE html>
<html>
<head>
<title>記事の公開 - サンプル</title>
<style>
.flash-success { color: green; background: #E8EEF5; padding: 10px; border-radius: 4px; }
.flash-error { color: red; background: #ffebee; padding: 10px; border-radius: 4px; }
.flash-info { color: blue; background: #e3f2fd; padding: 10px; border-radius: 4px; }
</style>
</head>
<body>
<h1>記事の公開</h1>
<!-- flash メッセージをすべて取得して表示する -->
{% with messages = get_flashed_messages(with_categories=true) %}
{% if messages %}
{% for category, message in messages %}
<div class="flash-{{ category }}">{{ message }}</div>
{% endfor %}
{% endif %}
{% endwith %}
<form method="post">
<p>タイトル:<input type="text" name="title" style="width:300px;"></p>
<p><input type="submit" value="公開"></p>
</form>
</body>
</html>
| カテゴリ | 推奨される使用シーン |
|---|---|
| "message"(デフォルト) | 一般通知 |
| "success" | 操作成功 |
| "error" | 操作失敗 |
| "warning" | 警告情報 |
| "info" | 通常情報 |
Flash メッセージは Session に依存するため、設定が必要ですSECRET_KEYそうして初めて使用できます。
Session よくある質問
その他の拡張Cookie サイズ制限:ブラウザの単一 Cookie のサイズ制限は約4KBです。Session に大量のデータを保存しないでください。ユーザーIDや設定などの軽量な情報の保存に適しており、ファイルや大きなオブジェクトの保存には適していません。