Flask WTF form.validate_on_submit() 方法不起作用

在本文中，我们将介绍 Flask 中 WTF（WTForms）扩展的 form.validate_on_submit() 方法为何可能会失效，并探讨解决方法。

阅读更多：Flask 教程

WTF（WTForms）简介

WTF（WTForms）是一个用于处理表单的 Python 扩展，提供了一个简洁而强大的方式来生成和验证表单。它为 Flask 框架提供了集成支持，使开发人员可以轻松地创建和处理表单。

WTF 表单的基本结构包括字段（Field）和验证器（Validator）。字段用于定义表单中的各种输入元素（如文本框、复选框、下拉列表等），而验证器则用于验证用户输入是否满足特定条件（如必填、最小长度、电子邮件格式等）。

在 Flask 中，WTF 扩展提供了 form 对象来处理表单的提交、验证和渲染。其中，form.validate_on_submit() 方法用于同时判断表单是否被 POST 提交，并且通过了所有的验证规则。

form.validate_on_submit() 方法失效的原因

当在使用 Flask 和 WTF 扩展开发应用程序时，有时我们会遇到 form.validate_on_submit() 方法不起作用的情况。这可能是由以下原因造成的：

1. 请求方法错误

form.validate_on_submit() 方法只会在 HTTP 请求方法为 POST 时才进行验证，如果请求方法是 GET、PUT 或 DELETE，则该方法会直接返回 False，导致验证失败。因此，确保您的路由视图函数使用正确的请求方法是很重要的。

示例代码：

@app.route('/login', methods=['GET', 'POST'])
def login():
    form = LoginForm()
    if form.validate_on_submit():
        # 处理登录逻辑
        return redirect(url_for('index'))
    return render_template('login.html', form=form)

2. 表单数据错误

form.validate_on_submit() 方法的另一个可能的原因是表单数据本身存在错误，导致验证失败。这可能是由于用户的错误输入或表单定义的问题。

首先，确保表单定义的验证规则正确，并且与模板中的表单字段匹配。其次，可以通过检查表单对象的 errors 属性来查看具体的验证错误信息，以便进行排查和修复。

示例代码：

@app.route('/register', methods=['GET', 'POST'])
def register():
    form = RegistrationForm()
    if form.validate_on_submit():
        # 处理注册逻辑
        return redirect(url_for('index'))
    else:
        # 输出表单验证错误信息
        print(form.errors)
    return render_template('register.html', form=form)

3. CSRF 保护未开启

form.validate_on_submit() 方法依赖于 Flask-WTF 提供的 CSRF（Cross-Site Request Forgery）保护机制来验证表单提交。CSRF 是一种常见的网络攻击，通过伪造用户请求来进行恶意操作。

默认情况下，Flask-WTF 会自动开启 CSRF 保护机制，要在表单中正确地使用 form.validate_on_submit() 方法，需要在模板中包含 CSRF 令牌（token）。

示例代码：

<form method="POST">
    {{ form.csrf_token }}
    <!-- 其他表单字段 -->
    <button type="submit" class="btn btn-primary">提交</button>
</form>

如果您未在模板中包含 CSRF 令牌，或者将 CSRF 保护关闭，那么 form.validate_on_submit() 方法将始终返回 False，导致验证失败。

4. 表单重命名

如果您在模板中对表单字段进行了重命名，那么在提交表单时，需要相应地修改 form.validate_on_submit() 方法中字段的名称。

示例代码：

<form method="POST">
    <!-- 将 username 字段重命名为 user_name -->
    {{ form.user_name.label }} {{ form.user_name }}
    <!-- 其他表单字段 -->
    <button type="submit" class="btn btn-primary">提交</button>
</form>

对应的视图函数中：

@app.route('/register', methods=['GET', 'POST'])
def register():
    form = RegistrationForm()
    if form.validate_on_submit():
        # 处理注册逻辑
        return redirect(url_for('index'))
    return render_template('register.html', form=form)