反序列化使用

验证

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

以通过序列化器对象的errors属性获取错误信息，返回字典，包含了字段和字段的错误

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

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

如我们前面定义过的BookInfoSerializer

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)

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

errors

def test(request):
    data = {'btitle': '123', 'bpub_date': 123}
    serializer = BookInfoSerializer(data=data)
    serializer.is_valid()
    print(serializer.errors) # {'bpub_date': [ErrorDetail(string='日期格式错误。请从这些格式中选择：YYYY-MM-DD。', code='invalid')]}
    return HttpResponse('ok')

validated_data

def test(request):
    data = {'btitle': '123'}
    serializer = BookInfoSerializer(data=data)
    serializer.is_valid()
    print(serializer.validated_data) # OrderedDict([('btitle', '123')])
    return HttpResponse('ok')

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)

如果觉得这些还不够，需要再补充定义验证行为，可以使用以下三种方法：

a. validate_<field_name>

对<field_name>字段进行验证，如

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)
    heroinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)  # 新增

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

def test(request):
    data = {'btitle': '123'}
    serializer = BookInfoSerializer(data=data)
    serializer.is_valid()
    print(serializer.errors) # {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}
    return HttpResponse('ok')

 

b. validate

在序列化器中需要同时对多个字段进行比较验证时，可以定义validate方法来验证，如

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)
    heroinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)  # 新增

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


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

视图结果:

def test(request):
    data = {'btitle': 'django', 'bread': 1, "bcomment": 6}
    serializer = BookInfoSerializer(data=data)
    serializer.is_valid()
    print(serializer.errors) #  {'non_field_errors': [ErrorDetail(string='阅读量小于评论量', code='invalid')]}
    return HttpResponse('ok')

c. 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)
    bread = serializers.IntegerField(label='阅读量', required=False)
    bcomment = serializers.IntegerField(label='评论量', required=False)
    image = serializers.ImageField(label='图片',  required=False)
    heroinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)  

视图结果:

def test(request):
    data = {'btitle': 'djang', 'bread': 1, "bcomment": 6}
    serializer = BookInfoSerializer(data=data)
    serializer.is_valid()
    print(serializer.errors) #  {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}
    return HttpResponse('ok')

总结:校验顺序

validators——>validate_<field_name>——>validate

REST framework提供的validators:

UniqueValidator

单字段唯一，如

from rest_framework.validators import UniqueValidator

slug = SlugField(
    max_length=100,
    validators=[UniqueValidator(queryset=BlogPost.objects.all())]
)

UniqueTogetherValidation

联合唯一，如

from rest_framework.validators import UniqueTogetherValidator

class ExampleSerializer(serializers.Serializer):
    # ...
    class Meta:
        validators = [
            UniqueTogetherValidator(
                queryset=ToDoItem.objects.all(),
                fields=('list', 'position')
            )
        ]

保存

如果在验证成功后，想要基于validated_data完成数据对象的创建，可以通过实现create()和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

视图结果:

create

def test(request):
    data = {'btitle': 'djang', 'bread': 1, "bcomment": 6}
    serializer = BookInfoSerializer(data=data)
    serializer.is_valid(raise_exception=True)
    serializer.save()
    print(serializer.validated_data) # OrderedDict([('btitle', 'djang'), ('bread', 1), ('bcomment', 6)])

    return HttpResponse('ok')

update

def test(request):
    data = {'btitle': 'djang111', 'bread': 1, "bcomment": 6}
    book = BookInfo.objects.get(id=4)
    serializer = BookInfoSerializer(book, data=data)
    serializer.is_valid(raise_exception=True)
    serializer.save()
    print(serializer.validated_data) # OrderedDict([('btitle', 'djang111'), ('bread', 1), ('bcomment', 6)])

    return HttpResponse('ok')

两点说明：

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)

模型类序列化器ModelSerializer

ModelSerializer与常规的Serializer相同，但提供了：

• 基于模型类自动生成一系列字段
• 基于模型类自动为Serializer生成validators，比如unique_together
• 包含默认的create()和update()的实现

1. 定义

比如我们创建一个BookInfoSerializer

class BookInfoSerializer(serializers.ModelSerializer):
    """图书数据序列化器"""
    class Meta():
        model = BookInfo
        fields = '__all__'

• model 指明参照哪个模型类
• fields 指明为模型类的哪些字段生成

def test(request):
    serializer = BookInfoSerializer
    print(serializer)  #  <class 'booktest.serializers.BookInfoSerializer'>


    return HttpResponse('ok')

2. 指定字段

1) 使用fields来明确字段，__all__表名包含所有字段，也可以写明具体哪些字段，如

class BookInfoSerializer(serializers.ModelSerializer):
    """图书数据序列化器"""
    class Meta:
        model = BookInfo
        fields = ('id', 'btitle', 'bpub_date')