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这个扩展可以实现这一点,后续可以再研究一下。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,546评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,224评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,911评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,737评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,753评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,598评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,338评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,249评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,696评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,888评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,013评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,731评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,348评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,929评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,048评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,203评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,960评论 2 355

推荐阅读更多精彩内容