赵走x博客 - 开发者的网上家园

Flask 实战：25、自定义验证器

资源编号:75876 Python Web Flask Web开发实战：入门、进阶与原理解析热度：83

在WTForms中，验证器是指在定义字段时传入validators参数列表的可调用对象，这一节我们会介绍如何编写自定义验证器。

### 1.行内验证器

除了使用WTForms提供的验证器来验证表单字段，我们还可以在表单类中定义方法来验证特定字段，如代码清单所示：

```

from wtforms import IntegerField, SubmitField
from wtforms.validators import ValidationError

class FortyTwoForm(FlaskForm):
    answer = IntegerField('The Number')
    submit = SubmitField()

def validate_answer(form, field):
        if field.data != 42:
            raise ValidationError('Must be 42.')

```

当表单类中包含以“validate_字段属性名”形式命名的方法时，在验证字段数据时会同时调用这个方法来验证对应的字段，这也是为什么表单类的字段属性名不能以validate开头。验证方法接收两个位置参数，依次为form和field，前者为表单类实例，后者是字段对象，我们可以通过field.data获取字段数据，这两个参数将在验证表单时被调用传入。验证出错时抛出从wtforms.validators模块导入的ValidationError异常，传入错误消息作为参数。因为这种方法仅用来验证特定的表单类字段，所以又称为行内验证器（in-line validator）。

### 2.全局验证器

如果你想要创建一个可重用的通用验证器，可以通过定义一个函数实现。如果不需要传入参数定义验证器，那么一个和表单类中定义的验证方法完全相同的函数就足够了，如代码清单所示:

```

from wtforms.validators import ValidationError

def is_42(form, field):
    if field.data != 42:
        raise ValidationError('Must be 42')

class FortyTwoForm(FlaskForm):
    answer = IntegerField('The Number', validators=[is_42])
    submit = SubmitField()

```

当使用函数定义全局的验证器时，我们需要在定义字段时在validators列表里传入这个验证器。因为在validators列表中传入的验证器必须是可调用对象，所以这里传入了函数对象，而不是函数调用。

这仅仅是一个简单的示例，在现实中，我们通常需要让验证器支持传入参数来对验证过程进行设置。至少，我们应该支持message参数来设置自定义错误消息。这时验证函数应该实现成工厂函数，即返回一个可调用对象的函数，如代码清单所示:

```
from wtforms.validators import ValidationError

def is_42(message=None):
    if message is None:
        message = 'Must be 42.'

def _is_42(form, field):
        if field.data != 42:
            raise ValidationError(message)

return _is_42

class FortyTwoForm(FlaskForm):
    answer = IntegerField('The Number', validators=[is_42()])
    submit = SubmitField()

```

在现在的is_42（）函数中，我们创建了另一个_is_42（）函数，这个函数会被作为可调用对象返回。is_42（）函数接收的message参数用来传入自定义错误消息，默认为None，如果没有设置就使用内置消息。在validators列表中，这时需要传入的是对工厂函数is_42（）的调用。

在更复杂的验证场景下，你可以使用实现了__call__（）方法的类（可调用类）来编写验证器，具体请参考WTForms文档相关章节（[http://wtforms.readthedocs.io/en/latest/validators.html#custom-validators](http://wtforms.readthedocs.io/en/latest/validators.html#custom-validators) ）。