演示

針對前面所學習的序列化器代碼，我們來對比一下。對於接下來的代碼我們新建一個子應用來展示：

python manage.py startapp mod

註冊子應用：

INSTALLED_APPS = [
    'Django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',

    'rest_framework', # 把drf框架註冊到django項目中

    'students', # 註冊子應用
    'sers',     # 演示序列化
    'unsers',     # 演示反序列化
    'mod',     # 模型類序列化器
]

註冊路由：

# 子應用路由
from django.urls import path
from . import views
urlpatterns = [
]


# 主應用的的總路由
urlpatterns = [
    path('admin/', admin.site.urls),
    path("student/",include("students.urls")),
    path("sers/",include("sers.urls")),
    path("un/",include("unsers.urls")),
    path("mod/",include("mod.urls")),
]

同一個模型類，事實上既可以用於在序列化器序列化階段，也可以用於反序列化階段。

編寫序列化器的時候，有部分欄位在業務實現過程中只能用於其中一個階段。

欄位 id 屬於主鍵，只能在序列化階段，提供給用戶，用戶沒有辦法上傳提交給我們。ID 欄位無法用於反序列化階段。類似於 id 這樣的欄位，可以使用 read_only，顯示 id 只會被序列化階段被使用。
欄位 password，屬於用戶隱私信息，只能在反序列化器接收用戶的修改 / 添加，但是絕對不能在序列化階段提供給外界查看。類似於 password 這樣的欄位，可以使用 write_only，顯示 password 只會被反序列化階段被使用。

序列化器代碼：

from rest_framework import serializers

class BookInfoSerializer(serializers.Serializer):
    """圖書信息"""
    id = serializers.IntegerField(read_only=True, label="ID", help_text="ID")
    title = serializers.CharField(max_length=20, label="標題", help_text="標題")
    pub_date = serializers.DateField(required=True, label="發布日期", help_text="發布日期")
    image = serializers.ImageField(required=False, allow_null=True, max_length=3 * 1024 * 1024, label="圖書封面", help_text="圖書封面")
    price = serializers.decimalField(max_digits=8, decimal_places=2, required=True, label="價格", help_text="價格")
    read = serializers.IntegerField(min_value=0, default=0, label="閱讀量", help_text="閱讀量")
    comment = serializers.IntegerField(min_value=0, default=0, label="評論量", help_text="評論量")

視圖代碼：

from django.views import View
from unsers.models import BookInfo
from .serializers import BookInfoSerializer
from django.http.response import JsonResponse
class BookInfoView(View):
    def get(self,request):
        """提供所有圖書信息"""
        book_list = BookInfo.objects.all()
        serializer = BookInfoSerializer(instance=book_list, many=True)
        return JsonResponse(serializer.data, safe=False)

    def get2(self,request):
        """添加一本圖書"""
        data = {
            "title": "一本很厚的書",
            "pub_date": "2020-02-19",
            "price": 100,
            "read": 300,
            "comment": 10,
        }
        serializer = BookInfoSerializer(data=data)
        serializer.is_valid(raise_exception=True)
        print(serializer.validated_data)

        return JsonResponse({"message":"ok"})

路由代碼：

from django.urls import path
from . import views
urlpatterns = [
    path("all/", views.BookInfoView.as_view() ),
]

訪問 http://127.0.0.1:8000/mod/all/，然後把 get 改為 get1, 把 get2 改為 get 重新訪問。

雖然針對上面序列化和反序列化，我們可只聲明一個序列化器，但是序列化器和模型還是存在很高的相似度。

所以我們可以在序列化器欄位和模型欄位公共欄位較多的時候，基於 ModelSerializer 來聲明創建序列化器。

如果我們想要使用序列化器對應的是 Django 的模型類，DRF 為我們提供了 ModelSerializer 模型類序列化器來幫助我們快速創建一個 Serializer 類。

ModelSerializer 是之前序列壞器基類 Serializer 的子類，功能大部分相同，但 ModelSerializer 還提供了：

基於模型類自動生成系列化器的欄位
基於模型類自動為 Serializer 生成 validators，比如 unique_together（多個欄位唯一）
包含默認的 create() 和 update() 的實現

定義

創建一個 BookInfoModelSerializer 模型序列化器：

class BookInfoModelSerializer(serializers.ModelSerializer):
    """圖書數據序列化器"""
        # 從什麼模型繼承過來
        model = BookInfo
        # 繼承那些欄位過來
        fields = "__all__"    # 表示繼承所有欄位

model 指明參照哪個模型類
fields 指明為模型類的哪些欄位生成

我們可以在 python manage.py shell 中查看自動生成的 BookInfoSerializer 的具體實現

from rest_framework import serializers

class BookInfoSerializer(serializers.Serializer):
    """圖書信息"""
    id = serializers.IntegerField(read_only=True, label="ID", help_text="ID")
    title = serializers.CharField(max_length=20, label="標題", help_text="標題")
    pub_date = serializers.DateField(required=True, label="發布日期", help_text="發布日期")
    image = serializers.ImageField(required=False, allow_null=True, max_length=3 * 1024 * 1024, label="圖書封面", help_text="圖書封面")
    price = serializers.DecimalField(max_digits=8, decimal_places=2, required=True, label="價格", help_text="價格")
    read = serializers.IntegerField(min_value=0, default=0, label="閱讀量", help_text="閱讀量")
    comment = serializers.IntegerField(min_value=0, default=0, label="評論量", help_text="評論量")


from unsers.models import BookInfo
class BookInfoModelSerializer(serializers.ModelSerializer):
    # 自定義欄位

    # 繼承ModelSerializer必須聲明內部類Mata
    class Meta:
        # 從什麼模型繼承過來
        model = BookInfo
        # 繼承那些欄位過來
        # fields = "__all__" # 表示繼承所有欄位
        fields = ["id","title","pub_date","price","read","comment"]
        # 如果覺得模型轉換的序列化器欄位選項要補充說明,則可以extra_kwargs
        # 擴展欄位選項
        extra_kwargs = {
            "read":{"min_value":0,"help_text":"閱讀量",},
            "title":{"min_length": 2,},
        }

        # def validate(self,data):
            # """所有欄位驗證"""
            # pass

        # def validate_<欄位>
            # pass

指定欄位

使用 fields 來明確欄位，__all__ 表明包含所有欄位，也可以寫明具體哪些欄位，如：

class BookInfoModelSerializer(serializers.ModelSerializer):
    """圖書數據序列化器"""
    class Meta:
        model = BookInfo
        fields = "__all__"

2.使用 exclude 可以明確排除掉哪些欄位：

class BookInfoModelSerializer(serializers.ModelSerializer):
    """圖書數據序列化器"""
    class Meta:
        model = BookInfo
        exclude = ['image']

3.顯示指明欄位，如：

class BookInfoModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = BookInfo
        fields = ["id","title","pub_date","price","read","comment"]

4.指明只讀欄位：

可以通過 read_only_fields 指明只讀欄位，即僅用於序列化輸出的欄位

class BookInfoModelSerializer(serializers.ModelSerializer):
    """圖書數據序列化器"""
    class Meta:
        model = BookInfo
        fields = ('id', 'title', 'pub_date'， 'read', 'comment')
        read_only_fields = ('id', 'read', 'comment')

添加額外參數

我們可以使用 extra_kwargs 參數為 ModelSerializer 添加或修改原有的選項參數：

from rest_framework import serializers

from unsers.models import BookInfo
class BookInfoModelSerializer(serializers.ModelSerializer):
    # 自定義欄位

    # 繼承ModelSerializer必須聲明內部類Mata
    class Meta:
        # 從什麼模型繼承過來
        model = BookInfo
        # 繼承那些欄位過來
        # fields = "__all__" # 表示繼承所有欄位
        fields = ["id","title","pub_date","price","read","comment"]
        # 如果覺得模型轉換的序列化器欄位選項要補充說明,則可以extra_kwargs
        # 擴展欄位選項[用於替換/添加參數選項]
        extra_kwargs = {
            "read":{"min_value":0,"help_text":"閱讀量",},
            "title":{"min_length": 2,},
        }

補充

主鍵會被自動識別，並設置為只讀
模型序列化器內部已經寫好了 create 和 update 方法，不需要我們自己手動去寫

什麼時候聲明的序列化器需要繼承序列化器基類 Serializer，什麼時候繼承模型序列化器類 ModelSerializer？

繼承序列化器類 Serializer欄位聲明驗證添加 / 保存數據功能
繼承模型序列化器類 ModelSerializer欄位聲明（可選，看需要）Meta 聲明驗證添加 / 保存數據功能（可選）

看表欄位大小，看使用哪個更加節省代碼。

Python | 模型類序列化器 ModelSerializer

演示

定義

指定欄位

添加額外參數

補充