Flask WTForms教程|极客教程

Flask WTForms教程

在Web应用程序开发中，表单是一个常见的组件，用于接收用户输入数据。Flask-WTForms 是 Flask 框架中一个方便的表单处理工具，能够帮助开发者轻松地创建、验证和处理表单数据。

在本教程中，我们将介绍如何使用 Flask-WTForms 来创建表单、添加验证规则以及接收和处理用户提交的数据。

安装 Flask-WTForms

首先，我们需要安装 Flask-WTForms 扩展。可以使用 pip 命令来安装：

pip install Flask-WTF

创建一个简单的表单

在创建一个表单之前，我们需要在 Flask 应用程序的 app.py 文件中导入必要的模块：

from flask import Flask, render_template
from flask_wtf import FlaskForm
from wtforms import StringField, SubmitField

然后，我们需要创建一个 Flask 应用程序实例和一个简单的表单类：

app = Flask(__name__)
app.config['SECRET_KEY'] = 'your_secret_key_here'

class MyForm(FlaskForm):
    name = StringField('Name')
    submit = SubmitField('Submit')

在上面的代码中，我们创建了一个名为 MyForm 的表单类，其中包含一个输入框和一个提交按钮。

接下来，我们需要在视图函数中处理表单的展示和提交：

@app.route('/', methods=['GET', 'POST'])
def index():
    form = MyForm()

    if form.validate_on_submit():
        name = form.name.data
        return f'Hello, {name}!'

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

if __name__ == '__main__':
    app.run(debug=True)

在上面的代码中，我们定义了一个路由 /，通过 render_template 函数渲染模板 index.html，将表单对象传递给模板。在用户提交表单后，我们通过 validate_on_submit() 方法来验证表单数据，如果数据有效，则显示欢迎消息。

创建模板

现在，我们需要创建一个名为 index.html 的模板文件，用于显示表单和处理表单提交：

<!DOCTYPE html>
<html>
<head>
    <title>Flask WTForms Tutorial</title>
</head>
<body>
    <h1>My Form</h1>
    <form method="POST" action="/">
        {{ form.hidden_tag() }}
        {{ form.name.label }} {{ form.name(size=20) }}
        <br>
        {{ form.submit() }}
    </form>
</body>
</html>

在上面的模板文件中，我们使用了 Jinja2 模板引擎来生成表单的 HTML 代码。hidden_tag() 方法用于生成 CSRF 令牌，防止跨站请求伪造攻击。

运行应用程序

现在，我们可以运行 Flask 应用程序，访问 http://127.0.0.1:5000/ 来查看表单页面。输入名字并点击提交按钮，即可看到欢迎消息。

添加表单验证规则

除了基本的表单元素之外，Flask-WTForms 还支持各种验证规则，例如必填字段、长度限制、邮箱格式等。

我们可以在表单类中添加验证规则来保证用户输入的数据符合要求：

from wtforms.validators import DataRequired, Length, Email

class MyForm(FlaskForm):
    name = StringField('Name', validators=[DataRequired(), Length(max=20)])
    email = StringField('Email', validators=[DataRequired(), Email()])
    submit = SubmitField('Submit')

在上面的代码中，DataRequired() 规则用于验证字段是否为空，Length(max=20) 规则用于验证字段最大长度，Email() 规则用于验证邮箱格式。

显示验证错误信息

当用户输入的数据不符合验证规则时，我们可以显示相应的错误信息给用户。在模板文件中，我们可以使用 form.errors 字段来显示错误信息：

{% for field, errors in form.errors.items() %}
    <ul>
        {% for error in errors %}
            <li>{{ error }}</li>
        {% endfor %}
    </ul>
{% endfor %}

文件上传

除了文本输入框和提交按钮，Flask-WTForms 还支持文件上传字段。我们可以在表单类中添加 FileField 字段来处理文件上传：

from wtforms import FileField

class MyForm(FlaskForm):
    file = FileField('File')
    submit = SubmitField('Submit')

自定义验证规则

除了内置的验证规则之外，我们还可以自定义验证规则来满足特定的需求。例如，我们可以创建一个自定义的验证函数来验证用户名是否已经存在：

from wtforms import ValidationError

def validate_username(form, field):
    if field.data == 'admin':
        raise ValidationError('Username already exists')

class MyForm(FlaskForm):
    name = StringField('Name', validators=[validate_username])
    submit = SubmitField('Submit')