7.9.5Serializer序列化器之反序列化操作

7.9.5Serializer序列化器之反序列化操作

（1）调用序列化器进行验证

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

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

验证失败，可以通过序列化器对象的errors属性获取错误信息，返回字典，包含了字段和字段的错误。如果是非字段错误，可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。

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

1）准备序列化器

class BookInfoSerializer(serializers.Serializer):

    """图书数据序列化器"""

    id = serializers.IntegerField(label='ID', read_only=True)

    btitle = serializers.CharField(label='名称', max_length=20)

    bpub_date = serializers.DateField(label='发布日期', required=False)

    bread = serializers.IntegerField(label='阅读量', required=False)

    bcomment = serializers.IntegerField(label='评论量', required=False)

    image = serializers.ImageField(label='图片', required=False)

    # 定义一关联多的序列化器字段

    # many=True：表示一对多

    heroinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)

2）验证失败的情况

>>> from booktest.serializers import BookInfoSerializer

>>> data = {}

>>> s = BookInfoSerializer(data=data)

>>> s.is_valid()

False

>>> s.errors

{'btitle': [ErrorDetail(string='This field is required.', code='required')]}

3）验证成功的情况

>>> data = {'btitle':'水浒传'}

>>> s = BookInfoSerializer(data=data)

>>> s.is_valid()

True

>>> s.validated_data

OrderedDict([('btitle', '水浒传')])

4）验证同时抛出异常

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

>>> data = {}

>>> s = BookInfoSerializer(data=data)

>>> s.is_valid(raise_exception=True)

Traceback (most recent call last):

File "<console>", line 1, in <module>

File "/home/python/.virtualenvs/py3_django/lib/python3.5/site- packages/rest_framework/serializers.py", line 244, in is_valid

raise ValidationError(self.errors)

rest_framework.exceptions.ValidationError: {'btitle': [ErrorDetail(string='This field is required.', code='required')]}

（2）定义序列化器进行验证

1）单个字段验证

①在BookInfoSerializer序列化器中添加

def validate_btitle(self,value):

    """单个字段的验证"""

    if 'django' not in value.lower():

        raise serializers.ValidationError("图书不是关于django的")

        return value

②验证

>>> from booktest.serializers import BookInfoSerializer

>>> data = {'btitle':'python'}

>>> s = BookInfoSerializer(data=data)

>>> s.is_valid()

False

>>> s.errors

{'btitle': [ErrorDetail(string='图书不是关于django的', code='invalid')]}

2）对字段联合验证

①提示

多字段联合验证是在单个字段验证之后进行的验证

②在BookInfoSerializer序列化器中添加

def validate(self, attrs):

    """多字段验证"""

    bread = attrs['bread']
    
    bcomment = attrs['bcomment']

    if bread < bcomment:

        raise serializers.ValidationError('阅读量小于评论量')

    return attrs

③验证

>>> from booktest.serializers import BookInfoSerializer

>>> data = {'btitle':'django','bread':10,'bcomment':20}

>>> s = BookInfoSerializer(data=data)

>>> s.is_valid()

False

>>> s.errors

{'non_field_errors': [ErrorDetail(string='阅读量小于评论量', code='invalid')]}

注意：'non_field_errors' 是多字段联合校验时的错误信息key

3）validators

在字段中添加validators选项参数：

btitle = serializers.CharField(label='名称', max_length=20,validators=[about_django])

①在BookInfoSerializer序列化器上方添加（即：定义为全局）

def about_django(value):

    if 'django' not in value.lower(): 

        raise serializers.ValidationError("图书不是关于Django的")

②验证

>>> from booktest.serializers import BookInfoSerializer

>>> data = {'btitle':'python'}

>>> s = BookInfoSerializer(data=data)

>>> s.is_valid()

False

>>> s.errors

{'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}

（3）保存序列化器验证后的数据

如果在验证成功后，想要基于validated_data完成数据对象的创建，可以通过实现create()和update()两个方法来实现。

如果创建序列化器对象的时候，没有传递instance实例，则调用save()方法的时候，create()被调用，相反，如果传递了instance实例，则调用save()方法的时候，update()被调用。

①在BookInfoSerializer序列化器中添加：

def create(self, validated_data):

    """新建"""

    return BookInfo(**validated_data)



def update(self, instance, validated_data):
    
    """更新，instance为要更新的对象实例"""

    instance.btitle = validated_data.get('btitle', instance.btitle)

    instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date)

    instance.bread = validated_data.get('bread', instance.bread)

    instance.bcomment = validated_data.get('bcomment', instance.bcomment)
    
    return instance

②验证后保存

>>> from booktest.serializers import BookInfoSerializer

>>> data = {'btitle':'django','bread':30,'bcomment':10,'bpub_date':'1989-11-11'}

>>> s = BookInfoSerializer(data=data)

>>> s.is_valid()

True

>>> book = s.save()

>>> book

<BookInfo: django>

③验证后新增

>>> data = {'btitle':'python_django','bread':30,'bcomment':10,'bpub_date':'1989-11-11'}

>>> s = BookInfoSerializer(book,data=data)

>>> s.is_valid()

True

>>> book = s.save()

>>> book

<BookInfo: python_django>

两点说明：

1） 在对序列化器进行save()保存时，可以额外传递数据，这些数据可以在create()和update()中的validated_data参数获取到

serializer.save(owner=request.user)

2）默认序列化器必须传递所有required的字段，否则会抛出验证异常。但是我们可以使用partial参数来允许部分字段更新

# Update `comment` with partial data serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True)