1 定義Serializer

1.1 定義方法

Django REST framework中的Serializer使用類來定義，須繼承自rest_framework.serializers.Serializer。

例如，我們已有了一個數據庫模型類BookInfo

class BookInfo(models.Model):
    btitle = models.CharField(max_length=20, verbose_name='名稱')
    bpub_date = models.DateField(verbose_name='釋出日期', null=True)
    bread = models.IntegerField(default=0, verbose_name='閱讀量')
    bcomment = models.IntegerField(default=0, verbose_name='評論量')
    image = models.ImageField(upload_to='booktest', verbose_name='圖片', null=True)
 

我們想為這個模型類提供一個序列化器，可以定義如下：

class BookInfoSerializer(serializers.Serializer):
    """圖書資料序列化器"""
    id = serializers.IntegerField(label='ID', read_only=True)
    btitle = serializers.CharField(label='名稱', max_length=20)
    bpub_date = serializers.DateField(label='釋出日期', required=False)
    bread = serializers.IntegerField(label='閱讀量', required=False)
    bcomment = serializers.IntegerField(label='評論量', required=False)
    image = serializers.ImageField(label='圖片', required=False)
 

注意：serializer不是隻能為資料庫模型類定義，也可以為非資料庫模型類的資料定義。serializer是獨立於資料庫之外的存在。

1.2 欄位與選項

常用欄位型別：

欄位	欄位構造方式
BooleanField	BooleanField()
NullBooleanField	NullBooleanField()
CharField	CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)
EmailField	EmailField(max_length=None, min_length=None, allow_blank=False)
RegexField	RegexField(regex, max_length=None, min_length=None, allow_blank=False)
SlugField	SlugField(maxlength=50, min_length=None, allow_blank=False)  正則欄位，驗證正則模式 [a-zA-Z0-9-]+
URLField	URLField(max_length=200, min_length=None, allow_blank=False)
UUIDField	UUIDField(format='hex_verbose')  format:  1) 'hex_verbose' 如"5ce0e9a5-5ffa-654b-cee0-1238041fb31a"  2） 'hex' 如 "5ce0e9a55ffa654bcee01238041fb31a"  3）'int' - 如: "123456789012312313134124512351145145114"  4）'urn' 如: "urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a"
IPAddressField	IPAddressField(protocol='both', unpack_ipv4=False, **options)
IntegerField	IntegerField(max_value=None, min_value=None)
FloatField	FloatField(max_value=None, min_value=None)
DecimalField	DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) max_digits: 最多位數 decimal_palces: 小數點位置
DateTimeField	DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)
DateField	DateField(format=api_settings.DATE_FORMAT, input_formats=None)
TimeField	TimeField(format=api_settings.TIME_FORMAT, input_formats=None)
DurationField	DurationField()
ChoiceField	ChoiceField(choices) choices與Django的用法相同
MultipleChoiceField	MultipleChoiceField(choices)
FileField	FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ImageField	ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ListField	ListField(child=, min_length=None, max_length=None)
DictField	DictField(child=)

選項引數：

引數名稱	作用
max_length	最大長度
min_lenght	最小長度
allow_blank	是否允許為空
trim_whitespace	是否截斷空白字元
max_value	最小值
min_value	最大值

通用引數：

引數名稱	說明
read_only	表明該欄位僅用於序列化輸出，預設False
write_only	表明該欄位僅用於反序列化輸入，預設False
required	表明該欄位在反序列化時必須輸入，預設True
default	反序列化時使用的預設值
allow_null	表明該欄位是否允許傳入None，預設False
validators	該欄位使用的驗證器
error_messages	包含錯誤編號與錯誤資訊的字典
label	用於HTML展示API頁面時，顯示的欄位名稱
help_text	用於HTML展示API頁面時，顯示的欄位幫助提示資訊

1.3 建立Serializer物件

定義好Serializer類後，就可以建立Serializer物件了。

Serializer的構造方法為：

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

說明：

1）用於序列化時，將模型類物件傳入instance引數

2）用於反序列化時，將要被反序列化的資料傳入data引數

3）除了instance和data引數外，在構造Serializer物件時，還可通過context引數額外新增資料，如

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

通過context引數附加的資料，可以通過Serializer物件的context屬性獲取。

2 序列化使用

我們在django shell中來學習序列化器的使用。

python manage.py shell

2.1 基本使用

1） 先查詢出一個圖書物件

from booktest.models import BookInfo

book = BookInfo.objects.get(id=2)

2） 構造序列化器物件

from booktest.serializers import BookInfoSerializer

serializer = BookInfoSerializer(book)

3）獲取序列化資料

通過data屬性可以獲取序列化後的資料

serializer.data
# {'id': 2, 'btitle': '天龍八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40, 'image': None}

4）如果要被序列化的是包含多條資料的查詢集QuerySet，可以通過新增many=True引數補充說明

book_qs = BookInfo.objects.all()
serializer = BookInfoSerializer(book_qs, many=True)
serializer.data
# [OrderedDict([('id', 2), ('btitle', '天龍八部'), ('bpub_date', '1986-07-24'), ('bread', 36), ('bcomment', 40), ('image', N]), OrderedDict([('id', 3), ('btitle', '笑傲江湖'), ('bpub_date', '1995-12-24'), ('bread', 20), ('bcomment', 80), ('image'ne)]), OrderedDict([('id', 4), ('btitle', '雪山飛狐'), ('bpub_date', '1987-11-11'), ('bread', 58), ('bcomment', 24), ('ima None)]), OrderedDict([('id', 5), ('btitle', '西遊記'), ('bpub_date', '1988-01-01'), ('bread', 10), ('bcomment', 10), ('im', 'booktest/xiyouji.png')])]

2.2 關聯物件巢狀序列化

如果需要序列化的資料中包含有其他關聯物件，則對關聯物件資料的序列化需要指明。

例如，在定義英雄資料的序列化器時，外來鍵hbook（即所屬的圖書）欄位如何序列化？

我們先定義HeroInfoSerialzier除外來鍵欄位外的其他部分

class HeroInfoSerializer(serializers.Serializer):
    """英雄資料序列化器"""
    GENDER_CHOICES = (
        (0, 'male'),
        (1, 'female')
    )
    id = serializers.IntegerField(label='ID', read_only=True)
    hname = serializers.CharField(label='名字', max_length=20)
    hgender = serializers.ChoiceField(choices=GENDER_CHOICES, label='性別', required=False)
    hcomment = serializers.CharField(label='描述資訊', max_length=200, required=False, allow_null=True)

對於關聯欄位，可以採用以下幾種方式：

1） PrimaryKeyRelatedField

此欄位將被序列化為關聯物件的主鍵。

hbook = serializers.PrimaryKeyRelatedField(label='圖書', read_only=True)
或
hbook = serializers.PrimaryKeyRelatedField(label='圖書', queryset=BookInfo.objects.all())

指明欄位時需要包含read_only=True或者queryset引數：

• 包含read_only=True引數時，該欄位將不能用作反序列化使用
• 包含queryset引數時，將被用作反序列化時引數校驗使用

使用效果：

from booktest.serializers import HeroInfoSerializer
from booktest.models import HeroInfo
hero = HeroInfo.objects.get(id=6)
serializer = HeroInfoSerializer(hero)
serializer.data
# {'id': 6, 'hname': '喬峰', 'hgender': 1, 'hcomment': '降龍十八掌', 'hbook': 2}

2) StringRelatedField

此欄位將被序列化為關聯物件的字串表示方式（即__str__方法的返回值）

hbook = serializers.StringRelatedField(label='圖書')

使用效果

{'id': 6, 'hname': '喬峰', 'hgender': 1, 'hcomment': '降龍十八掌', 'hbook': '天龍八部'}

3）HyperlinkedRelatedField

此欄位將被序列化為獲取關聯物件資料的介面連結

hbook = serializers.HyperlinkedRelatedField(label='圖書', read_only=True, view_name='books-detail')

必須指明view_name引數，以便DRF根據檢視名稱尋找路由，進而拼接成完整URL。

使用效果

{'id': 6, 'hname': '喬峰', 'hgender': 1, 'hcomment': '降龍十八掌', 'hbook': 'http://127.0.0.1:8000/books/2/'}

我們暫時還沒有定義檢視，此方式不再演示。

4）SlugRelatedField

此欄位將被序列化為關聯物件的指定欄位資料

hbook = serializers.SlugRelatedField(label='圖書', read_only=True, slug_field='bpub_date')

slug_field指明使用關聯物件的哪個欄位

使用效果

{'id': 6, 'hname': '喬峰', 'hgender': 1, 'hcomment': '降龍十八掌', 'hbook': datetime.date(1986, 7, 24)}

5）使用關聯物件的序列化器

hbook = BookInfoSerializer()

使用效果

{'id': 6, 'hname': '喬峰', 'hgender': 1, 'hcomment': '降龍十八掌', 'hbook': OrderedDict([('id', 2), ('btitle', '天龍八部')te', '1986-07-24'), ('bread', 36), ('bcomment', 40), ('image', None)])}

6） 重寫to_representation方法

序列化器的每個欄位實際都是由該欄位型別的to_representation方法決定格式的，可以通過重寫該方法來決定格式。

注意，to_representations方法不僅侷限在控制關聯物件格式上，適用於各個序列化器欄位型別。

自定義一個新的關聯欄位：

class BookRelateField(serializers.RelatedField):
    """自定義用於處理圖書的欄位"""
    def to_representation(self, value):
        return 'Book: %d %s' % (value.id, value.btitle)

指明hbook為BookRelateField型別

hbook = BookRelateField(read_only=True)

使用效果

{'id': 6, 'hname': '喬峰', 'hgender': 1, 'hcomment': '降龍十八掌', 'hbook': 'Book: 2 天龍八部'}

7）many引數

如果關聯的物件資料不是隻有一個，而是包含多個數據，如想序列化圖書BookInfo資料，每個BookInfo物件關聯的英雄HeroInfo物件可能有多個，此時關聯欄位型別的指明仍可使用上述幾種方式，只是在宣告關聯欄位時，多補充一個many=True引數即可。

此處僅拿PrimaryKeyRelatedField型別來舉例，其他相同。

在BookInfoSerializer中新增關聯欄位：

class BookInfoSerializer(serializers.Serializer):
    """圖書資料序列化器"""
    id = serializers.IntegerField(label='ID', read_only=True)
    btitle = serializers.CharField(label='名稱', max_length=20)
    bpub_date = serializers.DateField(label='釋出日期', required=False)
    bread = serializers.IntegerField(label='閱讀量', required=False)
    bcomment = serializers.IntegerField(label='評論量', required=False)
    image = serializers.ImageField(label='圖片', required=False)
    heroinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)  # 新增

使用效果：

from booktest.serializers import BookInfoSerializer
from booktest.models import BookInfo
book = BookInfo.objects.get(id=2)
serializer = BookInfoSerializer(book)
serializer.data
# {'id': 2, 'btitle': '天龍八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40, 'image': None, 'heroinfo_set': [6,8, 9]}

3 反序列化使用

3.1 驗證

使用序列化器進行反序列化時，需要對資料進行驗證後，才能獲取驗證成功的資料或儲存成模型類物件。

在獲取反序列化的資料前，必須呼叫is_valid()方法進行驗證，驗證成功返回True，否則返回False。

驗證失敗，可以通過序列化器物件的errors屬性獲取錯誤資訊，返回字典，包含了欄位和欄位的錯誤。如果是非欄位錯誤，可以通過修改REST framework配置中的NON_FIELD_ERRORS_KEY來控制錯誤字典中的鍵名。

驗證成功，可以通過序列化器物件的validated_data屬性獲取資料。

在定義序列化器時，指明每個欄位的序列化型別和選項引數，本身就是一種驗證行為。

如我們前面定義過的BookInfoSerializer

class BookInfoSerializer(serializers.Serializer):
    """圖書資料序列化器"""
    id = serializers.IntegerField(label='ID', read_only=True)
    btitle = serializers.CharField(label='名稱', max_length=20)
    bpub_date = serializers.DateField(label='釋出日期', required=False)
    bread = serializers.IntegerField(label='閱讀量', required=False)
    bcomment = serializers.IntegerField(label='評論量', required=False)
    image = serializers.ImageField(label='圖片', required=False)

通過構造序列化器物件，並將要反序列化的資料傳遞給data構造引數，進而進行驗證

from booktest.serializers import BookInfoSerializer
data = {'bpub_date': 123}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # 返回False
serializer.errors
# {'btitle': [ErrorDetail(string='This field is required.', code='required')], 'bpub_date': [ErrorDetail(string='Date has wrong format. Use one of these formats instead: YYYY[-MM[-DD]].', code='invalid')]}
serializer.validated_data  # {}

data = {'btitle': 'python'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # True
serializer.errors  # {}
serializer.validated_data  #  OrderedDict([('btitle', 'python')])

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)

如果覺得這些還不夠，需要再補充定義驗證行為，可以使用以下三種方法：

1）validate_<field_name>

對<field_name>欄位進行驗證，如

class BookInfoSerializer(serializers.Serializer):
    """圖書資料序列化器"""
    ...

    def validate_btitle(self, value):
        if 'django' not in value.lower():
            raise serializers.ValidationError("圖書不是關於Django的")
        return value

測試

from booktest.serializers import BookInfoSerializer
data = {'btitle': 'python'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # False   
serializer.errors
#  {'btitle': [ErrorDetail(string='圖書不是關於Django的', code='invalid')]}

2）validate

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

class BookInfoSerializer(serializers.Serializer):
    """圖書資料序列化器"""
    ...

    def validate(self, attrs):
        bread = attrs['bread']
        bcomment = attrs['bcomment']
        if bread < bcomment:
            raise serializers.ValidationError('閱讀量小於評論量')
        return attrs

測試

from booktest.serializers import BookInfoSerializer
data = {'btitle': 'about django', 'bread': 10, 'bcomment': 20}
s = BookInfoSerializer(data=data)
s.is_valid()  # False
s.errors
#  {'non_field_errors': [ErrorDetail(string='閱讀量小於評論量', code='invalid')]}

3）validators

在欄位中新增validators選項引數，也可以補充驗證行為，如

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

class BookInfoSerializer(serializers.Serializer):
    """圖書資料序列化器"""
    id = serializers.IntegerField(label='ID', read_only=True)
    btitle = serializers.CharField(label='名稱', max_length=20, validators=[about_django])
    bpub_date = serializers.DateField(label='釋出日期', required=False)
    bread = serializers.IntegerField(label='閱讀量', required=False)
    bcomment = serializers.IntegerField(label='評論量', required=False)
    image = serializers.ImageField(label='圖片', required=False)

測試：

from booktest.serializers import BookInfoSerializer
data = {'btitle': 'python'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # False   
serializer.errors
#  {'btitle': [ErrorDetail(string='圖書不是關於Django的', code='invalid')]}

REST framework提供的validators：

• UniqueValidator

  單欄位唯一，如

  from rest_framework.validators import UniqueValidator
  
  slug = SlugField(
      max_length=100,
      validators=[UniqueValidator(queryset=BlogPost.objects.all())]
  )
  

• UniqueTogetherValidation

  聯合唯一，如

  from rest_framework.validators import UniqueTogetherValidator
  
  class ExampleSerializer(serializers.Serializer):
      # ...
      class Meta:
          validators = [
              UniqueTogetherValidator(
                  queryset=ToDoItem.objects.all(),
                  fields=('list', 'position')
              )
          ]
  

3.2 儲存

如果在驗證成功後，想要基於validated_data完成資料物件的建立，可以通過實現create()和update()兩個方法來實現。

class BookInfoSerializer(serializers.Serializer):
    """圖書資料序列化器"""
    ...

    def create(self, validated_data):
        """新建"""
        return BookInfo(**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)
        return instance

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

class BookInfoSerializer(serializers.Serializer):
    """圖書資料序列化器"""
    ...

    def create(self, validated_data):
        """新建"""
        # return BookInfo(**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()被呼叫。

from booktest.serializers import BookInfoSerializer
data = {'btitle': '封神演義'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # True
serializer.save()  # <BookInfo: 封神演義>

from booktest.models import BookInfo
book = BookInfo.objects.get(id=2)
data = {'btitle': '倚天劍'}
serializer = BookInfoSerializer(book, data=data)
serializer.is_valid()  # True
serializer.save()  # <BookInfo: 倚天劍>
book.btitle  # '倚天劍'

提示：如果執行save()方法時報錯，django.db.utils.IntegrityError: (1048, "Column 'bpub_date' cannot be null")， 可以將models.py檔案中 bpub_date 改為：bpub_date = models.DateField(verbose_name='釋出日期', null=True)，然後進行資料庫遷移，再重新執行程式，即可。

兩點說明：

1） 在對序列化器進行save()儲存時，可以額外傳遞資料，這些資料可以在create()和update()中的validated_data引數獲取到

serializer.save(owner=request.user)

2）預設序列化器必須傳遞所有required的欄位，否則會丟擲驗證異常。但是我們可以使用partial引數來允許部分欄位更新

# Update `bread` with partial data
serializer = BookInfoSerializer(book, data={'bread': 30}, partial=True)

4 模型類序列化器ModelSerializer

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

ModelSerializer與常規的Serializer相同，但提供了：

• 基於模型類自動生成一系列欄位
• 基於模型類自動為Serializer生成validators，比如unique_together
• 包含預設的create()和update()的實現

4.1 定義

比如我們建立一個BookInfoSerializer

class BookInfoSerializer(serializers.ModelSerializer):
    """圖書資料序列化器"""
    class Meta:
        model = BookInfo
        fields = '__all__'

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

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

>>> from booktest.serializers import BookInfoSerializer
>>> serializer = BookInfoSerializer()
>>> serializer
BookInfoSerializer():
    id = IntegerField(label='ID', read_only=True)
    btitle = CharField(label='名稱', max_length=20)
    bpub_date = DateField(allow_null=True, label='釋出日期', required=False)
    bread = IntegerField(label='閱讀量', max_value=2147483647, min_value=-2147483648, required=False)
    bcomment = IntegerField(label='評論量', max_value=2147483647, min_value=-2147483648, required=False)
    image = ImageField(allow_null=True, label='圖片', max_length=100, required=False)

4.2 指定欄位

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

class BookInfoSerializer(serializers.ModelSerializer):
    """圖書資料序列化器"""
    class Meta:
        model = BookInfo
        fields = ('id', 'btitle', 'bpub_date')

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

class BookInfoSerializer(serializers.ModelSerializer):
    """圖書資料序列化器"""
    class Meta:
        model = BookInfo
        exclude = ('image',)

3) 預設ModelSerializer使用主鍵作為關聯欄位，但是我們可以使用depth來簡單的生成巢狀表示，depth應該是整數，表明巢狀的層級數量。如：

class HeroInfoSerializer2(serializers.ModelSerializer):
    class Meta:
        model = HeroInfo
        fields = '__all__'
        depth = 1

形成的序列化器如下：

HeroInfoSerializer():
    id = IntegerField(label='ID', read_only=True)
    hname = CharField(label='名稱', max_length=20)
    hgender = ChoiceField(choices=((0, 'male'), (1, 'female')), label='性別', required=False, validators=[<django.core.valators.MinValueValidator object>, <django.core.validators.MaxValueValidator object>])
    hcomment = CharField(allow_null=True, label='描述資訊', max_length=200, required=False)
    hbook = NestedSerializer(read_only=True):
        id = IntegerField(label='ID', read_only=True)
        btitle = CharField(label='名稱', max_length=20)
        bpub_date = DateField(allow_null=True, label='釋出日期', required=False)
        bread = IntegerField(label='閱讀量', max_value=2147483647, min_value=-2147483648, required=False)
        bcomment = IntegerField(label='評論量', max_value=2147483647, min_value=-2147483648, required=False)
        image = ImageField(allow_null=True, label='圖片', max_length=100, required=False)

4) 顯示指明欄位，如：

class HeroInfoSerializer(serializers.ModelSerializer):
    hbook = BookInfoSerializer()

    class Meta:
        model = HeroInfo
        fields = ('id', 'hname', 'hgender', 'hcomment', 'hbook')

5) 指明只讀欄位

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

class BookInfoSerializer(serializers.ModelSerializer):
    """圖書資料序列化器"""
    class Meta:
        model = BookInfo
        fields = ('id', 'btitle', 'bpub_date'， 'bread', 'bcomment')
        read_only_fields = ('id', 'bread', 'bcomment')

4.3 新增額外引數

我們可以使用extra_kwargs引數為ModelSerializer新增或修改原有的選項引數

class BookInfoSerializer(serializers.ModelSerializer):
    """圖書資料序列化器"""
    class Meta:
        model = BookInfo
        fields = ('id', 'btitle', 'bpub_date'， 'bread', 'bcomment')
        extra_kwargs = {
            'bread': {'min_value': 0, 'required': True}},
            'bcomment': {'max_value': 0, 'required': True}},
        }

# BookInfoSerializer():
#    id = IntegerField(label='ID', read_only=True)
#    btitle = CharField(label='名稱', max_length=20)
#    bpub_date = DateField(allow_null=True, label='釋出日期', required=False)
#    bread = IntegerField(label='閱讀量', max_value=2147483647, min_value=0, required=True)
#    bcomment = IntegerField(label='評論量', max_value=2147483647, min_value=0, required=True)