詳解 DRF 序列化器

一套 RESTful Web API，最基本的要求就是能為調(diào)用該 API 的客戶端提供符合要求的數(shù)據(jù)類型，而能否提供符合要求的數(shù)據(jù)類型，序列化器是關(guān)鍵。上一節(jié)中，我們通過短短 6 行代碼，構(gòu)建了一個序列化器，那么序列化器是如何工作的呢？這一節(jié)，我們就帶領(lǐng)大家手動構(gòu)建一個序列化器，并深入介紹序列化器的詳細使用方法。

1. 構(gòu)建序列化器

我們在已有的一個數(shù)據(jù)庫模型類 StudentsInfo：

# models.py

class StudentsInfo(models.Model):
		'''
		學(xué)生信息模型
		'''
    s_name = models.CharField(max_length=8, verbose_name='學(xué)生姓名') 
    s_age = models.IntegerField(verbose_name='學(xué)生年齡')
    s_number = models.CharField(max_length=16, verbose_name='學(xué)號')

構(gòu)建此模型的序列化器，可按如下操作構(gòu)建：

# serializers.py

from rest_framework import serializers

class StudentsSerializer(serializers.Serializer):
		'''
		學(xué)生信息序列化器
		'''
    id = serializers.IntegerField(label='ID', read_only=True)
    s_name = serializers.CharField(label='姓名', max_length=8)
    s_age = serializers.IntegerField(label='年齡', required=True)
    s_number = serializers.CharField(label='學(xué)號', max_length=16)

注意：serializer 不是只能為數(shù)據(jù)庫模型類定義，也可以為非數(shù)據(jù)庫模型類的數(shù)據(jù)定義。serializer 是獨立于數(shù)據(jù)庫之外的存在。

2. 常用字段類型與約束參數(shù)

常用字段類型：

選項參數(shù)：

通用參數(shù)：

3. Serializer對象

定義好 Serializer 類后，就可以創(chuàng)建 Serializer 對象了。Serializer 的構(gòu)造方法為：

Serializer(instance=None, data=empty, **kwarg)

說明：

• 用于序列化時，將模型類對象傳入 instance 參數(shù)；

• 用于反序列化時，將要被反序列化的數(shù)據(jù)傳入 data 參數(shù)；

• 除了 instance 和 data 參數(shù)外，在構(gòu)造 Serializer 對象時，還可通過 context 參數(shù)額外添加數(shù)據(jù)，如：

serializer = AccountSerializer(account, context={'request': request})

通過 context 參數(shù)附加的數(shù)據(jù)，可以通過 Serializer 對象的 context 屬性獲取。

4. 序列化器使用流程

為了更好理解序列化器的原理，我們通過終端來演示序列化器的使用：

python manage.py shell

1. 通過查詢獲取需要序列化的學(xué)生對象：

from AppDemo.models import StudentsModel

student = StudentsModel.objects.get(pk=2)

2. 實例化序列化器，構(gòu)造序列化器對象：

from AppDemo.serializers import StudentsSerializer

serializer = StudentsSerializer(student)

3. 獲取序列化數(shù)據(jù)，通過序列化器對象的 data 屬性，可以獲取序列化后的數(shù)據(jù)：

serializer.data
# {'id': 1, 's_name': '小明', 's_age': 12, 's_number': '001'}

4. 如果要被序列化的是包含多條數(shù)據(jù)的查詢集 QuerySet，可以通過添加 many=True 參數(shù)實現(xiàn)序列化

student_qs = StudentsModel.objects.all()
serializer = StudentsSerializer(student_qs, many=True)
serializer.data
# [OrderedDict([('id', 1), ('s_name', '小明'), ('s_age', 12), ('s_number', '001')]), OrderedDict([('id', 3), ('s_name', '小王'), ('s_age', 11), ('s_number', '003')]), OrderedDict([('id', 4), ('s_name', '小白'), ('s_age', 10), ('s_number', '004')])]

5.反序列化使用

5.1 數(shù)據(jù)驗證

序列化是將數(shù)據(jù)庫中的數(shù)據(jù)進行解析，返回前端需要的數(shù)據(jù)形式（如 json），而前端發(fā)來的數(shù)據(jù)，經(jīng)過驗證和處理，變?yōu)閿?shù)據(jù)庫需要的數(shù)據(jù)形式，這個過程稱為反序列化。

為了保證數(shù)據(jù)符合數(shù)據(jù)模型的要求，對前端發(fā)來的數(shù)據(jù)，根據(jù)字段類別、字段限制首先進行驗證。在序列化器中，可以調(diào)用 is_valid() 方法進行驗證，驗證成功返回 True，否則返回 False。

# serializers.py

from rest_framework import serializers

class StudentsSerializer(serializers.Serializer):

    id = serializers.IntegerField(label='ID', read_only=True)
    s_name = serializers.CharField(label='姓名', max_length=8)
    s_age = serializers.IntegerField(label='年齡', required=True)
    s_number = serializers.CharField(label='學(xué)號', max_length=16)

通過構(gòu)造序列化器對象，并將要反序列化的數(shù)據(jù)傳遞給 data 構(gòu)造參數(shù)，進而進行驗證：

from AppDemo.serializers import StudentsSerializer
data = {'s_name': '小黃', 's_age': 15, 's_number': '004'}
serializer = StudentsSerializer(data=data)
serializer.is_valid()  
# 返回True
serializer.errors
# {}
serializer.validated_data  # 驗證通過的數(shù)據(jù)
# OrderedDict([('s_name', '小黃'), ('s_age', 15), ('s_number', '004')])

5.2 數(shù)據(jù)保存

數(shù)據(jù)驗證通過后，如果需要將驗證通過的數(shù)據(jù)（validated_data）進行存儲或更新，需要對序列化器進行改造，增加 create() 和 update() 兩個方法來實現(xiàn)：

from rest_framework import serializers
from AppDemo.models import StudentsModel

class StudentsSerializer(serializers.Serializer):

    id = serializers.IntegerField(label='ID', read_only=True)
    s_name = serializers.CharField(label='姓名', max_length=8)
    s_age = serializers.IntegerField(label='年齡', required=True)
    s_number = serializers.CharField(label='學(xué)號', max_length=16)

    def create(self, validated_data):
        """存儲新數(shù)據(jù)"""
        return StudentsModel.objects.create(**validated_data)

    def update(self, instance, validated_data):
        """更新，instance為要更新的對象實例"""
        instance.s_name = validated_data.get('s_name', instance.s_name)
        instance.s_age = validated_data.get('s_age', instance.s_age)
        instance.s_number = validated_data.get('s_number', instance.s_number)
        instance.save()
        return instance

實現(xiàn)了上述兩個方法后，在反序列化數(shù)據(jù)的時候，就可以通過 save() 方法返回一個數(shù)據(jù)對象實例了

student = serializer.save()

說明：

在對序列化器進行 save() 保存時，可以額外傳遞數(shù)據(jù)，這些數(shù)據(jù)可以在 create() 和 update() 中的validated_data 參數(shù)獲取到：

serializer.save(owner=request.user)

默認序列化器必須傳遞所有 required 的字段，否則會拋出驗證異常。但是我們可以使用 partial 參數(shù)來允許部分字段更新：

serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True)

6. 模型類序列化器 ModelSerializer

在上述案例中，我們手動實現(xiàn)了序列化器。在實現(xiàn)的過程中，每一個字段都需要指定，如果模型類中字段很多，那將是一個極其繁瑣的過程。能否通過模型中已聲明的字段，自動創(chuàng)建序列化器，從而簡化操作呢？幸運的是，Django REST framework 為我們提供了 ModelSerializer 模型類序列化器。

ModelSerializer 與常規(guī)的 Serializer 相同，不再需要聲明每一個字段，它提供了：

• 基于模型類自動生成一系列字段
• 包含默認的 create() 和 update() 的實現(xiàn)

6.1 構(gòu)建模型類序列化器（ModelSerializer）

將上述序列化器改造為模型類序列化器 StudentsSerializer：

# serializers.py

from rest_framework import serializers
from AppDemo.models import StudentsModel

class StudentsSerializer(serializers.ModelSerializer):

    class Meta:
        model = StudentsModel
        fields = '__all__'

• model 指明與序列化器相對應(yīng)的數(shù)據(jù)模型；

• fields 指明為模型類中要序列化（反序列化）的字段。

我們在終端中可以查看我們構(gòu)建的模型類序列化器：

python manage.py shell

可以看到，模型類序列化器與我們手動實現(xiàn)的序列化器并無差別，簡化的工作，只是 Django REST framework 幫助我們實現(xiàn)了。

from AppDemo.serializers import StudentsSerializer
serializer = StudentsSerializer()
serializer
# StudentsSerializer():
    id = IntegerField(label='ID', read_only=True)
    s_name = CharField(label='學(xué)生姓名', max_length=8)
    s_age = IntegerField(label='學(xué)生年齡')
    s_number = CharField(label='學(xué)號', max_length=16)

6.2 指定字段

1. 在構(gòu)建序列化器時，fields 除了可以指定 __all__ 外，還可以選擇性地指定需要序列化的字段。

# serializers.py

from rest_framework import serializers
from AppDemo.models import StudentsModel

class StudentsSerializer(serializers.ModelSerializer):

    class Meta:
        model = StudentsModel
        fields = ('id', 's_name', 's_age', 's_number')

2. 另外，也可以使用 exclude 用來指定哪些字段不需要進行序列化。

class BookInfoSerializer(serializers.ModelSerializer):
    """圖書數(shù)據(jù)序列化器"""
    class Meta:
        model = BookInfo
        exclude = ('image',)

3. 指明只讀字段，有些字段僅需序列化時輸出，此時可以通過read_only_fields指明只讀字段：

# serializers.py

from rest_framework import serializers
from AppDemo.models import StudentsModel

class StudentsSerializer(serializers.ModelSerializer):

    class Meta:
        model = StudentsModel
        fields = ('id', 's_name', 's_age', 's_number')
        read_only_fields = ('id')

7.小結(jié)

本節(jié)小節(jié)通過手動構(gòu)建序列化器的方式，帶領(lǐng)大家詳細了解了序列化器的構(gòu)建過程和使用流程，并帶領(lǐng)大家認識了更為簡潔的模型類序列化器。在實際工作中，90% 以上的場景可以直接使用模型類序列化器實現(xiàn)，使用模型類序列化器能夠大大減少代碼量，讓程序更加簡潔，同時提高開發(fā)效率。