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這個擴展可以實現這一點，後續可以再研究一下。