Flask 使用wtforms验证前端请求数据

Python v3.8.5 , flask v1.1.2，wtforms v2.3.3

以一个注册接口为例，最终实现效果如下：

代码实现

创建表单数据验证基类，所有视图的表单验证都继承此类：

from flask import request, current_app
from wtforms import Form

from app.libs.error import ParameterError


class BaseForm(Form):
    def __init__(self, location=None):
        data = request.get_json(silent=True)    # 若解析出错则抛出Werkzeug.BadRequest异常, 若silent设为True则返回None
        query_string = request.args.to_dict() 
        form_data = request.form  # Werkzeug的ImmutableMultiDict对象, 存储解析后的表单数据

        super(BaseForm, self).__init__(formdata=form_data,
                                       data=data,
                                       meta={"locales": [current_app.config['WTFORMS_ERROR_MESSAGE_LANGUAGE']]},
                                       **query_string)

    def api_validate(self):
        valid = super(BaseForm, self).validate()
        if not valid:
            raise ParameterError(message=str(self.errors))  # 错误绑定

        return self

WTForms验证表单字段的方式是在实例化表单类时传入表单数据，然后对表单实例调用validate()方法，这会逐个对字段调用字段实例化时定义的验证器，返回表示验证结果的布尔值。如果验证失败，就把错误消息存储到表单实例的errors属性对应的字典中，而并非抛出异常，所以这里定义了api_validate方法，使其抛出项目中自定义的异常，然后在全局中进行捕捉。

在基类构造方法中，会尝试以三种不同的方式获取请求数据，分别是json提交、查询字符串以及form表单提交，然后将其传入wtforms.Form中，关于wtforms.Form中是怎么处理这些数据的，这里不在多述，可以自行查看源码。

然后编写视图表单验证类：

from wtforms import StringField, PasswordField, ValidationError
from wtforms.validators import Length, Email, DataRequired, Regexp

from app.validators.base import BaseForm
from app.models.user import UserModel

class UserRegisterForm(BaseForm):
    """用户注册"""
    username = StringField(validators=[DataRequired('用户名不允许为空'), Regexp(r'^[A-Za-z0-9_-]{2,20}$', message="用户名不能包含特殊字符, 且长度不能超过20个字符")])
    nickname = StringField(validators=[DataRequired('用户昵称不允许为空'), Length(1, 20, message="用户昵称长度不能超过20个字符")])
    password = PasswordField(validators=[DataRequired('密码不允许为空'), Regexp(r'^[A-Za-z0-9_-]{6,20}$')])
    email = StringField(validators=[DataRequired('邮箱地址不允许为空'), Email(message='无效的邮箱地址')])

    def validate_email(self, value):
        if UserModel.query.filter_by(email=value.data).first():
            raise ValidationError('用户邮箱已存在')

    def validate_username(self, value):
        if 'admin' in value.data:
            raise ValidationError('用户名不合法')
        if UserModel.query.filter_by(username=value.data).first():
            raise ValidationError('用户名已存在')

在视图函数中进行数据校验：

@api.route('/Register', methods=['POST'])
def register():
    """用户注册
    """
    form = UserRegisterForm().api_validate()
    new_user = UserModel(username=form.username.data, email=form.email.data, nickname=form.nickname.data)
    new_user.status = 2
    new_user.password = form.password.data

    with db.auto_commit():
        db.session.add(new_user)

    return api_response(APIStatusCode.SUCCESS.code, data=new_user)

补充： wtforms只支持简单的json数据, 对于复杂的嵌套结构并不支持字段校验, wtforms-json这个扩展可以实现这一点，后续可以再研究一下。