內容概要

• 序列化器介紹
• Serializer的使用
  • 基本使用（序列化）
  • 欄位型別
  • 欄位引數
• 序列化
  • 定製序列化的欄位
• 反序列化
  • 反序列化之新增
  • 反序列化之修改
  • 反序列化之區域性和全域性鉤子
• ModelSerializer 模型類序列化器
• ModelSerializer 額外新增引數

內容詳細

序列化器介紹

QuerySet 物件 ：queryset_obj = models.Book.objects.all()

單個物件：book = models.Book.objects.all().first()

• 1、序列化：序列化器會將模型物件（QuerySet 物件、單個 book
  物件）轉成字典，在經過 response 的時候序列化成 json 格式返回給前端。
• 2、反序列化：前端傳送到後端的資料，經過request之變成程字典（request.data），序列化器再把字典轉成模型，存到資料庫中。
• 3、反序列化中，序列化器有進行資料校驗的功能，（前端傳入的資料是否合法，長度夠不夠）

Serializer的使用

1、基本使用（序列化）

首先得在序列化器模組中書寫序列化類。

然後在檢視函式模組中書寫 CBV 的get方法（獲取資料）

序列化類的書寫步驟和使用流程：

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

模型類(models.py)：

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)

序列化類(ser.py)：

from rest_framework import serializers
from .models import Book

class BookSerializer(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()
 

檢視層類（views.py）

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()),
]

2、欄位型別

需要記憶：

CharField
IntegerField
FloatField
DecimalField
DateTimeField
DateField

瞭解：

反序列化時，前端傳送進來的json資料中，也有值是列表或者字典的時候，那麼這種資料我們需要用什麼欄位來反序列化？

{name:lqz,age:19,hobby:[籃球,足球],wife:{name:lyf,age:38}}

• ListField 反序列化列表值
• DictField 反序列化字典值

3、欄位引數

序列化器中欄位引數是用來在反序列化時做校驗資料的功能作用

如 max_length 是限制資料的字元長度

重點記憶：

• read_only ：該欄位只能序列化，後端傳送給前端看
• write_only：該欄位只能反序列化，由前端傳送到後端儲存

例子：

# 什麼都不寫，表示 name 欄位既序列化，又反序列化
name=serializers.CharField(max_length=32,min_length=3)

# 只反序列化，author 欄位只能由前端把作者資訊發到後端儲存
author=serializers.CharField(write_only=True)

# 這是錯誤寫法，write_only=True,read_only=True 邏輯矛盾
price=serializers.CharField(write_only=True,read_only=True)

選項引數：

通用引數：

序列化

1、定製序列化的欄位

方式一：在序列化類中寫

使用 serializers的SerializerMethodField()來定製，但必須配合一個方法,方法名get_欄位名，方法返回什麼，欄位就是什麼，obj是當前序列化到的模型類中的單個物件（queryset 或 單個 book）

from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.Serializer):
    name = serializers.CharField(max_length=8, min_length=3)
    price=serializers.CharField()
    author = serializers.CharField()
    # 在序列化後返回給前端時，前端就可以多看到一個 price_info 值
    price_info = serializers.SerializerMethodField()
    def get_price_info(self, obj):  # obj是當前序列化到的單個物件
        return "價格是："+str(obj.price)

方式二：在模型類中寫

表模型中寫方法，並且把方法包裝成資料屬性，在序列化類中使用的時候把該方法當作普通欄位

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)
    @property   # 把方法包裝成資料屬性
    def price_info(self):
       return "價格是：" + str(self.price)

在序列化類中使用：

只能給前端看，前端不能傳送該欄位的值（只序列化）

price_info=serializers.CharField(read_only=True)  # 只用來做序列化

反序列化

1、反序列化之新增

反序列化同時可以進行資料校驗

具體步驟如下：

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

# 校驗通過的資料都存放在 validated_data 中
    def create(self, validated_data):
        book=Book.objects.create(**validated_data)
        return book

如果instance為None，呼叫save本質會呼叫create，父類create是直接拋異常的，所以我們要重寫

檢視層類：

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

序列化類：

注意：重寫 create 方法後 不要忘記返回book物件

from rest_framework import serializers
from .models import Book

# drf提供的類：Serializer
class BookSerializer(serializers.Serializer):
    name = serializers.CharField(max_length=8, min_length=3)
    price=serializers.CharField()
    author = serializers.CharField()
    price_info=serializers.CharField(read_only=True)  # 只用來做序列化


    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物件

2、反序列化之修改

檢視層類：

寫 put 方法，與 get 方法很像，但 put 方法序列化器中要有 instance 引數

class BookDetailView(APIView):

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

序列化類：

修改，需要重寫 序列化類 中的update 方法，否則和新增一樣也會報錯

from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.Serializer):
    name = serializers.CharField(max_length=8, min_length=3)
    price=serializers.CharField()
    author = serializers.CharField()
    
    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物件

3、反序列化之區域性和全域性鉤子

與 forms 元件類中的校驗區域性鉤子全域性鉤子書寫方法幾乎一樣。

需要在序列化類中書寫區域性和全域性鉤子

from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.Serializer):
    name = serializers.CharField(max_length=8, min_length=3)
    price=serializers.CharField()
    author = serializers.CharField()
    
        # 區域性鉤子
    # 欄位有自己的校驗：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 模型類序列化器

以後我們在實際開發中會使用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']
  
  # 重寫欄位
  # 區域性和全域性鉤子跟之前一樣

ModelSerializer 額外新增引數

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