11 Serializer組件

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)

如果還不夠，需要在補充定義驗證行為，可以使用一下三種方法

3.3.2 validate_<field_name>-區域鉤子

• 對<field_name>欄位進行驗證

• 區域鉤子：validate_要校驗的欄位名(self, 當前要校驗欄位的值)

• 校驗規則：校驗通過回傳原值，校驗失敗，拋出例外

class BookInfoSerializer(serializers.Serializer):
    """圖書資料序列化器"""
    ...
    
	# 區域鉤子：validate_要校驗的欄位名(self, 當前要校驗欄位的值)
    # 校驗規則：校驗通過回傳原值，校驗失敗，拋出例外
    def validate_btitle(self, value):
        if 'django' not in value.lower():
            raise exceptions.ValidationError('圖書不是關于Django的')
        return value

測驗

http://127.0.0.1:8000/bookinfo/
{
    "btitle":"紅樓夢",
    "bpub_date":"2020-10-07"
}

{
    "btitle": [
        "圖書不是關于Django的"
    ]
}

3.3.2 validate-全域鉤子

• 在序列化器中需要同時對多個欄位進行比較驗證時，可以定義validate方法來驗證

• 全域鉤子：validate(self, 通過系統與區域鉤子校驗之后的所有資料)

class BookInfoSerializer(serializers.Serializer):
    """圖書資料序列化器"""
    ...   
    # 全域鉤子：validate(self, 通過系統與區域鉤子校驗之后的所有資料)
    def validate(self, attrs):  # attrs是字典格式
        pwd = attrs.get('pwd')
        re_pwd = attrs.pop('re_pwd')  # 因為re_pwd不需要存入資料庫，所以在全域鉤子校驗中洗掉掉這個欄位
        bread = attrs['bread']
        bcomment = attrs['bcomment']
        if pwd != re_pwd:
            raise exceptions.ValidationError({'pwd&re_pwd': '兩次密碼不一致'})
        if bread < bcomment:
            raise serializers.ValidationError('閱讀量小于評論量')
        return attrs

3.3.3 validators

• 在欄位中添加validators選項引數，也可以補充驗證行為

def about_django(value):
    if 'django' not in value.lower():
        raise serializers.ValidationError("validators-圖書不是關于Django的")

class BookInfoDeSerializer(serializers.Serializer):
    id = serializers.IntegerField(label='ID', read_only=True)
    pwd = serializers.CharField(label='密碼', required=True)
    publisher = serializers.IntegerField(label='出版社', required=False)
    btitle = serializers.CharField(label='名稱', max_length=20, validators=[about_django])
    bpub_date = serializers.DateField(label='發布日期', required=False)
    created_time = serializers.DateTimeField(label='創建時間', required=False)
    bread = serializers.IntegerField(label='閱讀量', required=True)
    bcomment = serializers.IntegerField(label='評論量', required=True)
    image = serializers.ImageField(label='圖片', required=False)

測驗：

Copyfrom booktest.serializers import BookInfoSerializer
data = https://www.cnblogs.com/LYPZX/p/{'btitle': 'python'}
serializer = BookInfoSerializer(data=https://www.cnblogs.com/LYPZX/p/data)
serializer.is_valid()  # False   
serializer.errors
#  {'btitle': [ErrorDetail(string='圖書不是關于Django的', code='invalid')]}

3.3.4 validators、validate_<field_name>、validate優先級

validators--->validate_<field_name>（區域）----->validate（全域）

3.4 反序列化-保存資料

如果在驗證成功后，想要基于validated_data完成資料物件的創建，可以通過實作create()和update()兩個方法來實作，

class BookInfoSerializer(serializers.Serializer):
    """圖書資料序列化器"""
    ...
    
    # 要完成新增，必須重寫create方法，validated_data是校驗的資料
    def create(self, validated_data):
        # 盡量在所有校驗規則完畢之后，資料可以直接入庫
        return models.User.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.pwd = validated_data.get('pwd', instance.pwd)
        instance.bread = validated_data.get('bread', instance.bread)
        instance.bcomment = validated_data.get('bcomment', instance.bcomment)
        return instance

如果需要在回傳資料物件的時候，也將資料保存到資料庫中，則可以進行如下修改

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()被呼叫，

models.py

from django.db import models

class BookInfo(models.Model):
    PUB_CHOICES = [
        (0, '商務印書館'),
        (1, '人民出版社'),
        (2, '人民文學出版社 '),
        (3, '作家出版社')
    ]
    pwd = models.CharField(max_length=32, verbose_name='密碼')
    publisher = models.IntegerField(choices=PUB_CHOICES, default=0, verbose_name='出版社')
    btitle = models.CharField(max_length=20, verbose_name='名稱')
    bpub_date = models.DateField(verbose_name='發布日期', null=True)
    created_time = models.DateTimeField(auto_now_add=True, verbose_name="創建時間", help_text='創建時間')
    bread = models.IntegerField(default=0, verbose_name='閱讀量')
    bcomment = models.IntegerField(default=0, verbose_name='評論量')
    image = models.ImageField(upload_to='icon', verbose_name='圖片', default='icon/default.jpg')

    class Meta:
        db_table = 'BookInfo'
        verbose_name = '書籍資訊'
        verbose_name_plural = verbose_name

    def __str__(self):
        return '%s' % self.btitle

路由：urls

from django.urls import path, re_path
from .views import test, users, books, v2books

urlpatterns = [
    path('bookinfo/', users.BookInfo.as_view()),
    re_path('bookinfo/(?P<pk>.*)/$', users.BookInfo.as_view()),
]

views視圖

rom rest_framework.views import APIView
from rest_framework.response import Response

from .. import models
from ..serializers import UserSerializer, UserDeserializer, BookInfoSerializer, BookInfoDeSerializer


class BookInfo(APIView):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        if pk:
            try:
                # 1) 查詢出圖書物件
                book_obj = models.BookInfo.objects.get(pk=pk)
                # 2) 構造序列化器
                book_ser = BookInfoSerializer(instance=book_obj)
                # 3) 獲取序列化資料
                return Response({
                    'status': 200,
                    'msg': 0,
                    'results': book_ser.data  # 通過data屬性可以獲取序列化后的資料
                })
            except:
                return Response({
                    'status': 201,
                    'msg': '書籍資訊不存在',
                })
        else:
            # 1) 查詢出圖書物件
            book_obj_list = models.BookInfo.objects.all()
            # 2) 構造序列化器   PS:如果要被序列化的是包含多條資料的查詢集QuerySet，可以通過添加many=True引數補充說明
            book_ser_data = https://www.cnblogs.com/LYPZX/p/BookInfoSerializer(instance=book_obj_list, many=True)
            # 3) 獲取序列化資料
            return Response({'status': 200,
                'msg': 0,
                'results': book_ser_data.data  # 通過data屬性可以獲取序列化后的資料
            })

    def post(self, request, *args, **kwargs):
        request_data = https://www.cnblogs.com/LYPZX/p/request.data
        if not isinstance(request_data, dict) or request_data == {}:
            return Response({'status': 1,
                'msg': '資料有誤',
            })

        book_ser = BookInfoDeSerializer(data=https://www.cnblogs.com/LYPZX/p/request_data)
        # 序列化物件呼叫is_valid()完成校驗，校驗失敗的失敗資訊都會被存盤在 序列化物件.errors
        # 檢驗是否合格 raise_exception=True必填的
        book_ser.is_valid(raise_exception=True)
        # book_result是物件

from rest_framework import serializers
from django.conf import settings
from rest_framework.exceptions import ValidationError
from . import models

# 序列化
class BookInfoSerializer(serializers.Serializer):
    """圖書資料序列化器"""
    id = serializers.IntegerField(label='ID', read_only=True)
    pwd = serializers.CharField(label='密碼', required=True)
    publisher = serializers.IntegerField(label='出版社', required=False)
    btitle = serializers.CharField(label='名稱', max_length=20)
    bpub_date = serializers.DateField(label='發布日期', required=False)
    created_time = serializers.DateTimeField(label='創建時間', required=False)
    bread = serializers.IntegerField(label='閱讀量', required=False)
    bcomment = serializers.IntegerField(label='評論量', required=False)
    image = serializers.ImageField(label='圖片', required=False)
    """
    自定義序列化屬性
    格式：  屬性名隨意，值由固定的命名規范方法提供
    def get_屬性名(self, 參與序列化的model物件):
        回傳值就是自定義序列化屬性的值
    """
    # 出版社顯示名稱，而不是0，1，，，
    publisher_name = serializers.SerializerMethodField()

    def get_publisher_name(self, obj):
        # choice型別的解釋型值 get_欄位_display() 來訪問
        return obj.get_publisher_display()

    # 圖片顯示全路徑
    image_path = serializers.SerializerMethodField()

    def get_image_path(self, obj):
        # settings.MEDIA_URL: 自己配置的 /media/，給后面高級序列化與視圖類準備的
        # obj.icon不能直接作為資料回傳，因為內容雖然是字串，但是型別是ImageFieldFile型別
        return '%s%s%s' % (r'http://127.0.0.1:8000', settings.MEDIA_URL, str(obj.image))

    # 自定義虛擬閱讀量，原基礎增加10
    fictitious_bread = serializers.SerializerMethodField()

    def get_fictitious_bread(self, obj):
        return obj.bread + 10


def about_django(value):
    if 'django' not in value.lower():
        raise serializers.ValidationError("validators-圖書不是關于Django的")

# 反序列化
class BookInfoDeSerializer(serializers.Serializer):
    id = serializers.IntegerField(label='ID', read_only=True)
    pwd = serializers.CharField(label='密碼', required=True)
    publisher = serializers.IntegerField(label='出版社', required=False)
    btitle = serializers.CharField(label='名稱', max_length=20, validators=[about_django])
    bpub_date = serializers.DateField(label='發布日期', required=False)
    created_time = serializers.DateTimeField(label='創建時間', required=False)
    bread = serializers.IntegerField(label='閱讀量', required=True)
    bcomment = serializers.IntegerField(label='評論量', required=True)
    image = serializers.ImageField(label='圖片', required=False)

    # 自定義有校驗規則的反序列化欄位,例如確認密碼欄位re_pwd
    re_pwd = serializers.CharField(required=True)

    # 區域鉤子：validate_要校驗的欄位名(self, 當前要校驗欄位的值)
    # 校驗規則：校驗通過回傳原值，校驗失敗，拋出例外
    def validate_btitle(self, value):
        if 'django' not in value.lower():
            raise exceptions.ValidationError('validate_btitle-圖書不是關于Django的')
        return value

    # 全域鉤子：validate(self, 通過系統與區域鉤子校驗之后的所有資料)
    def validate(self, attrs):  # attrs是字典格式
        pwd = attrs.get('pwd')
        re_pwd = attrs.pop('re_pwd')  # 因為re_pwd不需要存入資料庫，所以在全域鉤子校驗中洗掉掉這個欄位
        bread = attrs['bread']
        bcomment = attrs['bcomment']
        if pwd != re_pwd:
            raise exceptions.ValidationError({'pwd&re_pwd': '兩次密碼不一致'})
        if bread < bcomment:
            raise serializers.ValidationError('閱讀量小于評論量')
        return attrs

    # 要完成新增，必須重寫create方法，validated_data是校驗的資料
    def create(self, validated_data):
        # 盡量在所有校驗規則完畢之后，資料可以直接入庫
        return models.User.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.pwd = validated_data.get('pwd', instance.pwd)
        instance.bread = validated_data.get('bread', instance.bread)
        instance.bcomment = validated_data.get('bcomment', instance.bcomment)
        return instance

# request.user 是django中記錄當前登錄用戶的模型物件
serializer.save(owner=request.user)

# Update `comment` with partial data
serializer = CommentSerializer(comment, data=https://www.cnblogs.com/LYPZX/p/{'content': u'foo bar'}, partial=True)