序列化器的基本使用
我们在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), ('commentcount', 18), ('is_delete', False), ('image', None)]), OrderedDict([('id', 4), ('name', '雪山飞狐'), ('pub_date', '1987-11-11'), ('readcount', 58), ('commentcount', 24), ('is_delete', False), ('image', None)]), OrderedDict([('id', 5), ('name', '新射雕英雄传'), ('pub_date', '2000-05-01'), ('readcount', 0), ('commentcount', 0), ('is_delete', False), ('image', None)]), OrderedDict([('id', 7), ('name', 'python入门'), ('pub_date', '2018-05-12'), ('readcount', 0), ('commentcount', 0), ('is_delete', False), ('image', None)]), OrderedDict([('id', 9), ('name', 'python运维'), ('pub_date', '2018-05-12'), ('readcount', 0), ('commentcount', 0), ('is_delete', False), ('image', 'book/1.png')])]
关联对象嵌套序列化
如果需要序列化的数据中包含有其他关联对象,则对关联对象数据的序列化需要指明。
例如,在定义人物数据的序列化器时,外键book(即所属的图书)字段如何序列化?
我们先定义PeopleInfoSerialzier除外键字段外的其他部分
class PeopleInfoSerializer(serializers.Serializer):
"""英雄数据序列化器"""
GENDER_CHOICES = (
(0, 'male'),
(1, 'female')
)
id = serializers.IntegerField(label='ID')
name = serializers.CharField(label='名字')
gender = serializers.ChoiceField(choices=GENDER_CHOICES, label='性别')
description = serializers.CharField(label='描述信息')
对于关联字段,可以采用以下几种方式:
1、 IntegerField
此字段将被序列化为关联对象的主键。
book_id = serializers.IntegerField(label='书籍id')
使用效果:
>>> 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、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': '令狐冲'}
3、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}
4、使用关联对象的序列化器
序列化器嵌套
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', ]), 'gender': 1, 'name': '令狐冲', 'description': '独孤九剑', 'id': 10}
5、many参数
如果关联的对象数据不是只有一个,而是包含多个数据,如想序列化图书BookInfo数据,每个BookInfo对象关联的英雄PeopleInfo对象可能有多个,此时关联字段类型的指明仍可使用上述几种方式,只是在声明关联字段时,多补充一个many=True参数即可。
此处仅拿PrimaryKeyRelatedField类型来举例,其他相同。
在BookInfoSerializer中添加关联字段:
class BookInfoSerializer(serializers.Serializer):
"""图书数据序列化器"""
id = serializers.IntegerField(label='ID')
name = serializers.CharField(label='名称')
pub_date = serializers.DateField(label='发布日期')
readcount = serializers.IntegerField(label='阅读量')
commentcount = serializers.IntegerField(label='评论量')
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'}