Serializer序列化器

序列化器的作用：

1. 進行資料的校驗
2. 對資料物件進行轉換

一、定義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 欄位與選項

常用欄位型別：

選項引數：

通用引數：

1.3 創建Serializer物件

定義好Serializer類后，就可以創建Serializer物件了，

Serializer的構造方法為：

Serializer(instance=None, data=https://www.cnblogs.com/yanadoude/p/empty, **kwarg)

說明：

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

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

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

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

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

二、序列化使用

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

python manage.py shell

2.1 基本使用

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

from booktest.models import BookInfo

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

2.1.2） 構造序列化器物件

from booktest.serializers import BookInfoSerializer

serializer = BookInfoSerializer(book)

2.1.3）獲取序列化資料

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

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

2.1.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)

對于關聯欄位，可以采用以下幾種方式：

2.2.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.2.2）使用關聯物件的序列化器

hbook = BookInfoSerializer()

使用效果

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

2.2.3) StringRelatedField

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

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

使用效果

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

2.2.4）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/'}

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

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

2.2.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 天龍八部'}

2.3 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]}

標籤：Python

上一篇：06.DRF-第一個demo

下一篇：將陣列進行轉置