序列化的基本使用

序列化使用

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

python manage.py shell

基本使用

1） 先查詢出一個圖書對象

from book.models import BookInfo

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

2） 構造序列化器對象

from book.serializers import BookInfoSerializer

serializer = BookInfoSerializer(book)

3）獲取序列化數據

通過data屬性可以獲取序列化後的數據

serializer.data

# {'is_delete': False, 'pub_date': '1987-11-11', 'readcount': 58, 'image': None, 'id': 4, 'commentcount': 24, 'name': '雪山飛狐'}

4）如果要被序列化的是包含多條數據的查詢集QuerySet，可以通過添加many=True參數補充說明

books = BookInfo.objects.all()
serializer = BookInfoSerializer(books, many=True)
serializer.data

# [OrderedDict([('id', 3), ('name', '笑傲江湖'), ('pub_date', '1995-12-24'), ('readcount', 28), ('commentco

關聯對象嵌套序列化

串行關係

如果需要序列化的數據中包含有其他關聯對象，則對關聯對象數據的序列化需要指明。

例如，在定義人物數據的序列化器時，外鍵book（即所屬的圖書）字段如何序列化？

我們先定義PeopleInfoSerialzier除外鍵字段外的其他部分

class PeopleInfoSerializer(serializers.Serializer):
    """英雄數據序列化器"""
    GENDER_CHOICES = (
        (0, 'male'),
        (1, 'female')
    )
    id = serializers.IntegerField(label='ID', read_only=True)
    name = serializers.CharField(label='名字', max_length=20)
    gender = serializers.ChoiceField(choices=GENDER_CHOICES, label='性別', required=False)
    description = serializers.CharField(label='描述信息', max_length=200, required=False, allow_null=True)

對於關聯字段，可以採用以下幾種方式：

1） PrimaryKeyRelatedField

此字段將被序列化爲關聯對象的主鍵。

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

指明字段時需要包含read_only=True或者queryset參數：

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

使用效果：

>>> from book.models import PeopleInfo
>>> from book.serializers import PeopleInfoSerializer
>>> person = PeopleInfo.objects.get(id=10)
>>> serializer = PeopleInfoSerializer(instance=person)
>>> serializer.data
{'id': 10, 'book': 3, 'description': '獨孤九劍', 'gender': 1, 'name': '令狐沖'}

2) StringRelatedField

此字段將被序列化爲關聯對象的字符串表示方式（即__str__方法的返回值）

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

使用效果

>>> from book.models import PeopleInfo
>>> from book.serializers import PeopleInfoSerializer
>>> person = PeopleInfo.objects.get(id=10)
>>> serializer = PeopleInfoSerializer(instance=person)
>>> serializer.data
{'description': '獨孤九劍', 'name': '令狐沖', 'gender': 1, 'book': '笑傲江湖', 'id': 10}

3）使用關聯對象的序列化器

book = BookInfoSerializer()

使用效果

>>> from book.models import PeopleInfo
>>> from book.serializers import PeopleInfoSerializer
>>> person = PeopleInfo.objects.get(id=10)
>>> serializer = PeopleInfoSerializer(instance=person)
>>> serializer.data
{'book': OrderedDict([('id', 3), ('name', '笑傲江湖'), ('pub_date', '1995-12-24'), ('readcount', 28), ('commentcount',  ('image', None)]), 'gender': 1, 'name': '令狐沖', 'description': '獨孤九劍', 'id': 10}

4）HyperlinkedRelatedField

此字段將被序列化爲獲取關聯對象數據的接口鏈接

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

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

使用效果

{'description': '獨孤九劍', 'name': '令狐沖', 'gender': 1, 'book': 'http://127.0.0.1/books/2/', 'id': 10}

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

5）SlugRelatedField

此字段將被序列化爲關聯對象的指定字段數據

book = serializers.SlugRelatedField(label='圖書', read_only=True, slug_field='pub_date')

slug_field指明使用關聯對象的哪個字段

使用效果

>>> from book.models import PeopleInfo
>>> from book.serializers import PeopleInfoSerializer
>>> person = PeopleInfo.objects.get(id=10)
>>> serializer = PeopleInfoSerializer(instance=person)
>>> serializer.data
{'book': datetime.date(1995, 12, 24), 'description': '獨孤九劍', 'name': '令狐沖', 'id': 10, 'gender': 1}

6） 重寫to_representation方法

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

注意，to_representations方法不僅侷限在控制關聯對象格式上，適用於各個序列化器字段類型。

自定義一個新的關聯字段：

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

指明book爲BookRelateField類型

book = BookRelateField(read_only=True)

使用效果

>>> from book.models import PeopleInfo
>>> from book.serializers import PeopleInfoSerializer
>>> person = PeopleInfo.objects.get(id=10)
>>> serializer = PeopleInfoSerializer(instance=person)
>>> serializer.data
{'description': '獨孤九劍', 'book': 'Book: 3 笑傲江湖', 'id': 10, 'name': '令狐沖', 'gender': 1}

many參數

如果關聯的對象數據不是隻有一個，而是包含多個數據，如想序列化圖書BookInfo數據，每個BookInfo對象關聯的英雄PeopleInfo對象可能有多個，此時關聯字段類型的指明仍可使用上述幾種方式，只是在聲明關聯字段時，多補充一個many=True參數即可。

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

在BookInfoSerializer中添加關聯字段：

class BookInfoSerializer(serializers.Serializer):
    """圖書數據序列化器"""
    id = serializers.IntegerField(label='ID', read_only=True)
    name = serializers.CharField(label='名稱', max_length=20)
    pub_date = serializers.DateField(label='發佈日期', required=False)
    readcount = serializers.IntegerField(label='閱讀量', required=False)
    commentcount = serializers.IntegerField(label='評論量', required=False)
    image = serializers.ImageField(label='圖片', required=False)
    peopleinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)  # 新增

使用效果：

>>> from book.models import BookInfo
>>> from book.serializers import BookInfoSerializer
>>> book = BookInfo.objects.get(id=3)
>>> serializer = BookInfoSerializer(book)
>>> serializer.data
{'id': 3, 'peopleinfo_set': [10, 11, 12, 13], 'commentcount': 18, 'name': '笑傲江湖', 'readcount': 28, 'pub_date': '199-24', 'image': None}