序列化使用

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

python manage.py shell

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 關聯物件巢狀序列化

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

例如，在定義英雄資料的序列化器時，外來鍵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）使用關聯物件的序列化器

hbook = BookInfoSerializer()

使用效果

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

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

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

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

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

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': No