模型类序列化器ModelSerializer

weixin_43641389

于 2019-06-14 17:50:32 发布

阅读量94

点赞数

比如我们创建一个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)

2.指定字段

1）使用字段来明确字段，__all__表名包含所有字段，也可以写明具体哪些字段，如
class BookInfoSerializer(serializers.ModelSerializer):
“”“图书数据序列化器”""
class Meta:
model = BookInfo
fields = (‘id’, ‘btitle’, ‘bpub_date’)
2）使用排除可以明确排除掉哪些字段
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’)
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’: {‘min_value’: 0, ‘required’: True},
}