反序列化使用

時間 2019-11-18

標籤序列使用简体版

原文原文鏈接

驗證

在獲取反序列化的數據前，必須調用is_valid()方法進行驗證，驗證成功返回True，不然返回False。前端

以經過序列化器對象的errors屬性獲取錯誤信息，返回字典，包含了字段和字段的錯誤django

驗證成功，能夠經過序列化器對象的validated_data屬性獲取數據。ui

在定義序列化器時，指明每一個字段的序列化類型和選項參數，自己就是一種驗證行爲。spa

如咱們前面定義過的BookInfoSerializerrest

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構造參數，進而進行驗證code

errorsorm

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響應。blog

# 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>——>validatevalidate_<field_name>——>

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')