通常你会想要与Django模型相对应的序列化类。
ModelSerializer类能够让你自动创建一个具有模型中相应字段的Serializer类。
这个ModelSerializer类和常规的Serializer类一样,不同的是:
它根据模型自动生成一组字段。
它自动生成序列化器的验证器,比如unique_together验证器。
它默认简单实现了.create()方法和.update()方法。
声明一个ModelSerializer如下:
class AccountSerializer(serializers.ModelSerializer):
class Meta:
model = Account
fields = ('id', 'account_name', 'users', 'created')
默认情况下,所有的模型的字段都将映射到序列化器上相应的字段。
模型中任何关联字段比如外键都将映射到PrimaryKeyRelatedField字段。默认情况下不包括反向关联,除非像serializer relations文档中规定的那样显式包含。
序列化类生成有用的详细表示字符串,允许你全面检查其字段的状态。 这在使用ModelSerializers时特别有用,因为你想确定自动创建了哪些字段和验证器。
要检查的话,打开Django shell,执行 python manage.py shell,然后导入序列化器类,实例化它,并打印对象的表示:
>>> from myapp.serializers import AccountSerializer
>>> serializer = AccountSerializer()
>>> print(repr(serializer)) AccountSerializer():
id = IntegerField(label='ID', read_only=True)
name = CharField(allow_blank=True, max_length=100, required=False)
owner = PrimaryKeyRelatedField(queryset=User.objects.all())
2. 指定字段
如果你希望在模型序列化器中使用默认字段的一部分,你可以使用fields或exclude选项来执行此操作,就像使用ModelForm一样。强烈建议你使用fields属性显式的设置要序列化的字段。这样就不太可能因为你修改了模型而无意中暴露了数据。
例如:
class AccountSerializer(serializers.ModelSerializer):
class Meta:
model = Account
exclude = ('users',)
在上面的例子中,如果Account模型有三个字段account_name,users和created,那么只有 account_name和created会被序列化。
在fields和exclude属性中的名称,通常会映射到模型类中的模型字段。
或者fields选项中的名称可以映射到模型类中不存在任何参数的属性或方法。
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},
}
# 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=0, required=True)
# bcomment = IntegerField(label='评论量', max_value=2147483647, min_value=0, required=True)
日后会整理,源码会上传
---------------------
-----------------------
------------------------------------------
网友评论