如何使用DRF的序列化器之反序列化

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

在获取反序列化的数据前，必须调用is_valid()方法进行验证，验证成功返回True，否则返回False。is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError，可以通过传递raise_exception=True参数开启，REST framework接收到此异常，会向前端返回HTTP 400 Bad Request响应。

# Return a 400 response if the data was invalid.
serializer.is_valid(raise_exception=True)

验证成功，可以通过序列化器对象的validated_data属性获取数据。serializer.validated_data为OrderedDict对象如OrderedDict([('btitle', 'python进阶')])

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

from booktest.serializers import BookInfoSerializer
data = {'bpub_date': 2008.12.29}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # 返回False
serializer.errors
# {'btitle': [ErrorDetail(string='This field is required.', code='required')], 'bpub_date': [ErrorDetail(string='Date has wrong format. Use one of these formats instead: YYYY[-MM[-DD]].', code='invalid')]}
serializer.validated_data  # {}

data = {'btitle': 'python'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # True
serializer.errors  # {}

serializer.validated_data  #  OrderedDict([('btitle', 'python')])

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

序列化器还提供了验证函数用来自定义验证：

def validate_属性(self, value): 用来针对单个字段进行验证

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...

    def validate_btitle(self, value):
        if 'django' not in value.lower():
            raise serializers.ValidationError("图书不是关于Django的")
        return value

def validate(self, attrs):用来同时对多个字段进行验证

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...

    def validate(self, attrs):
        bread = attrs['bread']
        bcomment = attrs['bcomment']
        if bread < bcomment:
            raise serializers.ValidationError('阅读量小于评论量')
        return attrs

验证函数一定要将验证后的数据return!

validators选项，在字段中添加validators选项参数，可以补充验证行为

def about_django(value):
    if 'django' not in value.lower():
        raise serializers.ValidationError("图书不是关于Django的")

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    id = serializers.IntegerField(label='ID', read_only=True)
    btitle = serializers.CharField(label='名称', max_length=20, validators=[about_django])
    bpub_date = serializers.DateField(label='发布日期', required=False)

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

在序列化器类中添加creat和update方法

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...

    def create(self, validated_data):
        """新建"""
        return BookInfo.objects.create(**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)
        instance.save()
        return instance

实现了上述两个方法后，在反序列化数据的时候，就可以通过save()方法返回一个数据对象实例了

book = serializer.save()

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

from db.serializers import BookInfoSerializer
data = {'btitle': 'python进阶'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # True
serializer.save()  # <BookInfo: python进阶>

from db.models import BookInfo
book = BookInfo.objects.get(id=2)
data = {'btitle': 'python核心编程'}
serializer = BookInfoSerializer(book, data=data)
serializer.is_valid()  # True
serializer.save()  # <BookInfo: python核心编程>
book.btitle  # 'python核心编程'

两点说明：

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

serializer.save(owner=request.user)

2）默认序列化器必须传递所有required的字段，否则会抛出验证异常。但是我们可以使用partial参数来允许部分字段更新,创建serializer对象时，传入partial参数，则所有字段的required选项失效。

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

反序列化帮我们封装了将字典转换为对象的过程。

# 创建对象
serializer = BookInfoSerializer(data=data)
serializer.save()
# 更新对象
serializer = BookInfoSerializer(book, data=data)
serializer.save()

如何使用DRF的序列化器之反序列化

猜你喜欢