验证

使用序列化器进行反序列化时,需要对数据进行验证后,才能获取验证成功的数据或保存成模型类对象。

在获取反序列化的数据前,必须调用is_valid()方法进行验证,验证成功返回True,否则返回False。

验证失败,可以通过序列化器对象的errors属性获取错误信息,返回字典,包含了字段和字段的错误。

验证成功,可以通过序列化器对象的validated_data属性获取数据。

在定义序列化器时,指明每个字段的序列化类型和选项参数,本身就是一种验证行为。

如我们前面定义过的BookInfoSerializer

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    id = serializers.IntegerField(label='ID')
    name = serializers.CharField(label='名称')
    pub_date = serializers.DateField(label='发布日期')
    readcount = serializers.IntegerField(label='阅读量')
    commentcount = serializers.IntegerField(label='评论量')

通过构造序列化器对象,并将要反序列化的数据传递给data构造参数,进而进行验证

正确
>>> from book.serializers import BookInfoSerializer
>>> 
>>> data = {
...     'name':'Python高级',
...     'pub_date':'2020-1-1',
...     'readcount':100,
...     'commentcount':200
... }
>>> 
>>> serializer = BookInfoSerializer(data=data)
>>> 
>>> from book.serializers import BookInfoSerializer
>>> 
>>> data = {
...     'id':100,
...     'name':'Python高级',
...     'pub_date':'2020-1-1',
...     'readcount':100,
...     'commentcount':200
... }
>>> 
>>> serializer = BookInfoSerializer(data=data)
>>> 
>>> serializer.is_valid()
True
>>> 
>>> serializer.errors
{}
>>>

is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError,可以通过传递raise_exception=True参数开启,REST framework接收到此异常,会向前端返回HTTP 400 Bad Request响应。

>>> from book.serializers import BookInfoSerializer
>>> 
>>> data = {
...     'id':100,
...     'name':'Python高级',
...     'pub_date':'2020',
...     'readcount':100,
...     'commentcount':200
... }
>>> 
>>> serializer = BookInfoSerializer(data=data)
>>> 
>>> serializer.is_valid()
False
>>> 
>>> serializer.errors
{'pub_date': [ErrorDetail(string='Date has wrong format. Use one of these formats instead: YYYY-MM-DD.', code='invalid')]}

如果觉得这些还不够,可以使用以下几种方法验证:

1) 字段类型

2) 字段选项

3) validate_fieldname

4) validate