序列化器介紹

序列化器其實就是一個類

作用

1. 序列化,序列化器會把模型物件(qs，book)轉換成字典,經過response以後變成json字串
2. 反序列化,把客戶端發(前端)送過來的資料,經過request以後變成字典(data),序列化器可以把字典轉成模型-->存到資料庫中
3. 反序列化,完成資料校驗功能---》前端傳入的資料是否合法，長度夠不夠。。。資料校驗

使用方式

-第一步：寫一個類：必須繼承drf中的Serializer及其子類
-第二步：在類中寫要序列化的欄位-->要序列化哪些，就寫哪些，不序列化的不寫
-第三步：使用序列化類，檢視類中用
-得到序列化類物件 物件.data,通過Response返回給前端

serializer的使用

序列化類

from rest_framework import serializers
from .models import Book

x(serializers.Serializer):
    # max_length=32,min_length=3  反序列化儲存校驗資料的時候用
    name = serializers.CharField(max_length=8, min_length=3)
    price=serializers.CharField() # models中使用了DecimalField，這個位置使用了CharField會把小數型別轉成字串
 

    author = serializers.CharField()

檢視類

class BookView(APIView):
    def get(self,request):
        # 查出來的資料做序列化
        book_list=Book.objects.all()
        # instance:要序列化的物件  qs，單個物件
        # many:如果是qs物件，many=True，如果是單個物件many=False
        ser=BookSerializer(instance=book_list,many=True)  #
 
 傳入初始化的引數instance=None, data=empty
        # ser.data使用模型類物件序列化後的字典
        return Response(ser.data) # 字典，列表，字串都行

路由

from app01 import views
urlpatterns = [
    path('admin/', admin.site.urls),
    path('books/', views.BookView.as_view()),
]

模型類

class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.DecimalField(decimal_places=2, max_digits=5)
    author = models.CharField(max_length=32)

欄位型別

欄位引數

通用引數：

重點欄位引數

read_only:表明該欄位僅用於序列化輸出，預設False
  -如果read_only=True，這個欄位只用來做序列化---》把物件---》json給前端
write_only:表明該欄位僅用於反序列化輸入，預設False
  -如果read_only=write_only，這個欄位只用來做反序列化---》前端json---》存到資料庫
  
  
# 舉例
    name=serializers.CharField(max_length=32,min_length=3)
    price=serializers.CharField(write_only=True,read_only=True)
    author=serializers.CharField(write_only=True)
   
    
    # 什麼都不寫，表示既序列化，又反序列化
    # 序列化給前端，前端看到的欄位樣子---》只能看到name
    # 反序列化，前端需要傳什麼過來name,price,author都傳
    
    # write_only=True,read_only=True 邏輯矛盾

自定製欄位

序列化類中寫

price_info = serializers.SerializerMethodField()  # 必須配合一個方法,方法名get_欄位名
def get_price_info(self, obj): # 方法返回什麼，欄位就是什麼，obj是當前序列化到的單個物件
   return "價格是："+str(obj.price)  # python是動態強型別語言--》強型別是：不同型別之間不允許直接運算

模型類中寫

# 表模型中寫方法
@property   # 把方法包裝成資料屬性
def price_info(self):
   return "價格是：" + str(self.price)
  
# 序列化類中使用
price_info=serializers.CharField(read_only=True)  # 只用來做序列化
# authors=serializers.ListField()

反序列化之新增資料

# 反序列化
    第一步：把前端傳入的資料，放到Serializer物件中:ser=BookSerializer(data=request.data)
  第二步：校驗資料：ser.is_valid():
  第三步：儲存，ser.save()---》必須重寫create，在序列化類中
     def create(self, validated_data):
        book=Book.objects.create(**validated_data)
        return book

檢視類

class BookView(APIView):
    def post(self,request):
        # 反序列化,儲存---》使用data引數
        ser=BookSerializer(data=request.data) #
        # 校驗資料
        if ser.is_valid():  # 如果是true表示資料校驗通過，通過，就儲存
            # 如果instance為None，呼叫save本質會呼叫create--》父類create直接拋異常，所以我們要重寫
            ser.save()  # 就會儲存,重寫create方法，如果不重寫，我們不知道存到哪個表中
            return Response(ser.data)
        return Response({'code':101,'msg':'資料校驗失敗','err':ser.errors})

反序列化類之修改資料

序列化類

class BookSerializer(serializers.Serializer):
    id = serializers.CharField(read_only=True)
    # max_length=32,min_length=3  反序列化儲存校驗資料的時候用
    name = serializers.CharField(max_length=8, min_length=3)
    price = serializers.CharField(required=False)  # models中使用了DecimalField，這個位置使用了CharField會把小數型別轉成字串
    author = serializers.CharField(required=False)

    def create(self, validated_data):
        # validated_data校驗過後的資料
        # 手動存到book表中

        book = Book.objects.create(**validated_data)
        # book=Book.objects.create(name=validated_data.get('name'))
        return book  # 不要忘記返回book物件

    def update(self, instance, validated_data):
        # validated_data校驗過後的資料,instance 是要修改的物件
        instance.name = validated_data.get('name')
        instance.price = validated_data.get('price')
        instance.author = validated_data.get('author')
        instance.save()  # 模型物件自帶的save，儲存到資料庫中
        return instance  # 要忘記返回instance物件

    # 區域性鉤子
    # 欄位有自己的校驗：max_length .... ,再校驗，就可以寫區域性鉤子
    def validate_name(self, attr):
        # attr就是前端傳入的資料
        # 名字不能以sb開頭
        if attr.startswith('sb'):
            raise ValidationError("名字不能以sb開頭")
        else:
            return attr  # 沒有問題，正常返回

檢視類

class BookDetailView(APIView):
    def get(self, request, pk):
        book = Book.objects.filter(pk=pk).first()
        ser = BookSerializer(instance=book)  # 如果是單條記錄，many不傳，就是false
        return Response(ser.data)

    def delete(self, request, pk):
        res = Book.objects.filter(pk=pk).delete()
        print(res)
        if res[0] > 0:
            return Response({'code': 100, 'msg': '刪除成功'})
        else:
            return Response({'code': 103, 'msg': '資料不存在'})

    def put(self, request, pk):
        # 修改：用什麼資料，修改哪個物件？
        book = Book.objects.filter(pk=pk).first()
        # 既有instance，又有data，表示修改
        ser = BookSerializer(instance=book, data=request.data)
        if ser.is_valid():
            # 重寫update方法
            ser.save()  # 呼叫save---》內部根據instance判斷是觸發create還是update
            return Response(ser.data)
        return Response({'code': 102, 'msg': '修改出錯', 'err': ser.errors})

路由

urlpatterns = [
    path('admin/', admin.site.urls),
    path('books/', views.BookView.as_view()),
    path('books/<int:pk>', views.BookDetailView.as_view()),
]

反序列化之區域性鉤子與全域性鉤子

   # 區域性鉤子
    # 欄位有自己的校驗：max_length .... ,再校驗，就可以寫區域性鉤子
    def validate_name(self, attr):
        # attr就是前端傳入的資料
        # 名字不能以sb開頭
        if attr.startswith('sb'):
            raise ValidationError("名字不能以sb開頭")
        else:
            return attr  # 沒有問題，正常返回

    # 先走欄位自己規則，再走區域性鉤子，再走全域性鉤子
    # 全域性鉤子
    def validate(self, attrs):
        # attrs校驗過後的資料
        if attrs.get('name') == attrs.get('author'):
            raise ValidationError('作者名不能等於書名')
        else:
            return attrs

Modelserializer模型類序列化器

# 因為綁定了表，所以不需要重寫update和create方法了
class BookSerializer2(serializers.ModelSerializer):
    class Meta:
        model = Book  # 跟那個表有關係
        # fields='__all__' # 所有欄位
        # id是從表模型中對映過來的，auto，它會不要求你傳
        # price_info：它不是資料庫中欄位
        # 即便擴寫的欄位，也要在fields中註冊
        fields = ['id', 'name', 'price', 'author', 'price_info']
        # 原來的欄位引數，通過extra_kwargs傳進去
        extra_kwargs = {
            'name': {'write_only': True, 'max_length': 8, 'min_length': 3}
        }
  
  # 重寫欄位
  # 區域性和全域性鉤子跟之前一樣

新增額外引數

# 
class BookSerializer2(serializers.ModelSerializer):
    class Meta:
        # 原來的欄位引數，通過extra_kwargs傳進去
        extra_kwargs = {
            'name': {'write_only': True, 'max_length': 8, 'min_length': 3}
        }