フォーム処理 — Flask-WTF

この章では、Flask-WTF を使ってフォームを標準的な方法で処理する方法を学びます:フォームクラスの定義、自動 CSRF 保護、フィールド検証とエラーメッセージ表示。


なぜ Flask-WTF を使うのか?

前章の登録・ログインフォームは手書きでした:手動でrequest.form.get()値を取得し、手動で検証し、手動でエラーを表示していました。

Flask-WTFWTForms をベースに Flask 向けにラップし、以下を提供します:

  • フォームクラス定義により、フィールド + 検証ルールを一元管理
  • 自動 CSRF 保護
  • テンプレートでフィールドとエラーメッセージをレンダリング
  • form.validate_on_submit()GET/POST の判定と検証を一元的に処理

インストールと設定

(venv) $ pip install flask-wtf

app.py で SECRET_KEY を設定します(CSRF トークンはこの鍵に依存します):

例

# ファイルパス:app.py
app.config['SECRET_KEY'] = 'your-secret-key'    # 本番環境では環境変数を使用
app.config['WTF_CSRF_ENABLED'] = True            # デフォルトで有効だが、明示的に宣言

フォームクラスの定義

例

# ファイルパス:app/forms.py(新規ファイル)
from flask_wtf import FlaskForm
from wtforms import StringField, PasswordField, EmailField, BooleanField
from wtforms.validators import DataRequired, Length, Email, EqualTo, ValidationError
from app.models import User

class RegisterForm(FlaskForm):
    """登録フォーム"""
    username = StringField('ユーザー名', validators=[
        DataRequired(message='ユーザー名は必須です'),
        Length(min=3, max=50, message='ユーザー名は3〜50文字で入力してください')
    ])
    email = EmailField('メールアドレス', validators=[
        DataRequired(message='メールアドレスは必須です'),
        Email(message='有効なメールアドレスを入力してください')
    ])
    password = PasswordField('パスワード', validators=[
        DataRequired(message='パスワードは必須です'),
        Length(min=6, message='パスワードは6文字以上で入力してください')
    ])
    confirm_password = PasswordField('パスワード(確認)', validators=[
        DataRequired(message='パスワードをもう一度入力してください'),
        EqualTo('password', message='入力されたパスワードが一致しません')
    ])

    # カスタムバリデータ:ユーザー名が登録済みかどうかを確認
    def validate_username(self, field):
        if User.query.filter_by(username=field.data).first():
            raise ValidationError('このユーザー名は既に使用されています。')

    def validate_email(self, field):
        if User.query.filter_by(email=field.data).first():
            raise ValidationError('このメールアドレスは既に登録されています。')


class LoginForm(FlaskForm):
    """ログインフォーム"""
    username = StringField('ユーザー名', validators=[
        DataRequired(message='ユーザー名は必須です')
    ])
    password = PasswordField('パスワード', validators=[
        DataRequired(message='パスワードは必須です')
    ])
    remember = BooleanField('ログイン状態を保持')

よく使うフィールド型

フィールドクラスHTML タグ説明
StringField<input type="text">単行テキスト
PasswordField<input type="password">パスワード入力欄
EmailField<input type="email">メールアドレス入力欄
TextAreaField<textarea>複数行テキスト
BooleanField<input type="checkbox">チェックボックス
SelectField<select>ドロップダウン選択

よく使うバリデータ

バリデータ用途
DataRequired()フィールドは空欄不可
Length(min=, max=)文字数制限
Email()メールアドレス形式の検証
EqualTo('field_name')別のフィールドの値と一致
Optional()フィールドの空欄を許可(後続のバリデータをスキップ)

ビュー関数でフォームを使用する

例

# ファイルパス:app/blueprints/auth.py(リファクタリング後の register と login)
from flask import Blueprint, render_template, redirect, url_for, flash
from flask_login import login_user, logout_user, login_required, current_user
from app.forms import RegisterForm, LoginForm
from app.models import User, db

auth_bp = Blueprint('auth', __name__)

@auth_bp.route("/register", methods=['GET', 'POST'])
def register():
    if current_user.is_authenticated:
        return redirect(url_for('main.index'))

    form = RegisterForm()
    # form.validate_on_submit() は POST リクエスト時にフォームを検証する
    # GET リクエストまたは検証失敗時は False を返す
    if form.validate_on_submit():
        user = User(username=form.username.data, email=form.email.data)
        user.set_password(form.password.data)
        db.session.add(user)
        db.session.commit()
        login_user(user)
        flash(f'登録が完了しました。ようこそ、{user.username}!', 'success')
        return redirect(url_for('main.index'))

    # GET リクエストまたは検証失敗時は、フォーム付きテンプレートをレンダリング
    return render_template('register.html', form=form)


@auth_bp.route("/login", methods=['GET', 'POST'])
def login():
    if current_user.is_authenticated:
        return redirect(url_for('main.index'))

    form = LoginForm()
    if form.validate_on_submit():
        user = User.query.filter_by(username=form.username.data).first()
        if user is None or not user.check_password(form.password.data):
            flash('ユーザー名またはパスワードが正しくありません。', 'error')
            return render_template('login.html', form=form)

        login_user(user, remember=form.remember.data)
        flash(f'おかえりなさい、{user.username}!', 'success')
        next_page = request.args.get('next')
        return redirect(next_page or url_for('main.index'))

    return render_template('login.html', form=form)

テンプレートでフォームをレンダリングする

例

<!-- ファイルパス:app/templates/register.html -->
{% extends 'base.html' %}

{% block title %}登録 - サンプル ブログ{% endblock %}

{% block content %}
<div class="auth-form">
    <h2>登録</h2>
    <form method="post">
        <!-- form.hidden_tag() が CSRF トークンの隠しフィールドを自動生成 -->
        {{ form.hidden_tag() }}

        <div class="form-group">
            {{ form.username.label }}
            {{ form.username(class="form-input") }}
            {% if form.username.errors %}
                {% for error in form.username.errors %}
                <span class="field-error">{{ error }}</span>
                {% endfor %}
            {% endif %}
        </div>

        <div class="form-group">
            {{ form.email.label }}
            {{ form.email(class="form-input") }}
            {% for error in form.email.errors %}
            <span class="field-error">{{ error }}</span>
            {% endfor %}
        </div>

        <div class="form-group">
            {{ form.password.label }}
            {{ form.password(class="form-input") }}
            {% for error in form.password.errors %}
            <span class="field-error">{{ error }}</span>
            {% endfor %}
        </div>

        <div class="form-group">
            {{ form.confirm_password.label }}
            {{ form.confirm_password(class="form-input") }}
            {% for error in form.confirm_password.errors %}
            <span class="field-error">{{ error }}</span>
            {% endfor %}
        </div>

        {{ form.submit(class="btn-submit") }}
    </form>
    <p class="form-footer">
すでにアカウントをお持ちですか?<a href="{{ url_for('auth.login') }}">今すぐログイン</a>
    </p>
</div>
{% endblock %}

Flask-WTF の CSRF 保護は自動です:form.hidden_tag()隠しフィールドを生成し、<input>ランダムなトークンが含まれます。サーバーは POST リクエストを受け付ける前にこのトークンを検証します。外部サイトから送信されたフォームは、正しいトークンがないためすべて拒否されます。


手動 request.form と Flask-WTF の比較

項目手動 request.formFlask-WTF
コード行数各フィールドで取得/検証/エラー表示の3ステップを繰り返すフォームクラスを一度定義するだけ
CSRF 保護手動実装が必要自動
カスタム検証手動の if/elsevalidate_xxx メソッド
エラー表示手動で連結form.field.errors で自動収集
適用シーン単純なフォーム(検索ボックスなど)複雑なフォーム(登録、ログイン、プロフィール編集)

本章のまとめ

この章では、Flask-WTF を使って認証フォームをリファクタリングしました:FlaskForm でフィールドとバリデータを定義し、validate_xxx でカスタム検証を行い、form.validate_on_submit() で POST 検証を一元処理し、form.hidden_tag() で自動 CSRF 保護を実現し、テンプレートでエラーメッセージをレンダリングしました。

フォーム処理がより標準的で安全になりました。

その他の拡張