【1120 | Day63】ModelSerializer组件

目录

• 一、 模型类序列化器
• 二、定义
• 三、指定字段
• 四、添加额外参数

一、 模型类序列化器

如果我们想要使用序列化器对应的是Django的模型类，DRF为我们提供了ModelSerializer模型类序列化器来帮助我们快速创建一个Serializer类。

ModelSerializer与常规的Serializer相同，但提供了：

• 基于模型类自动生成一系列字段
• 基于模型类自动为Serializer生成validators，比如unique_together
• 包含默认的create()和update()的实现

二、定义

比如我们创建一个BookInfoSerializer

class BookInfoSerializer(serializers.ModelSerializer):
     """图书数据序列化器"""
     class Meta:
         model = BookInfo  #指明参照模型类
         fields = '__all__'  #指明为模型类的哪些字段生成

我们可以在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)

三、指定字段

使用fields来明确字段， __all__ 表名包含所有字段，也可以写明具体哪些字段，如

class BookInfoSerializer(serializers.ModelSerializer):
     """图书数据序列化器"""
     class Meta:
         model = BookInfo
         fields = ('id', 'btitle', 'bpub_date')

使用exclude可以明确排除掉哪些字段

class BookInfoSerializer(serializers.ModelSerializer):
     """图书数据序列化器"""
     class Meta:
         model = BookInfo
         exclude = ('image',)

显示指明字段，如

class HeroInfoSerializer(serializers.ModelSerializer):
     hbook = BookInfoSerializer()
     
     class Meta:
         model = HeroInfo
         fields = ('id', 'hname', 'hgender', 'hcomment', 'hbook')

指明只读字段， 可以通过read_only_fields指明只读字段，即仅用于序列化输出的字段，如

class BookInfoSerializer(serializers.ModelSerializer):
     """图书数据序列化器"""
     class Meta:
         model = BookInfo
         fields = ('id', 'btitle', 'bpub_date'， 'bread', 'bcomment')
         read_only_fields = ('id', 'bread', 'bcomment')

四、添加额外参数

我们可以使用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)

补充：https://www.cnblogs.com/yingjp/p/10604201.html