09.drf-modelserializer(代码片段)

yanadoude yanadoude     2022-11-29     476

关键词:

四、模型类序列化器ModelSerializer

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

ModelSerializer与常规的Serializer相同,但提供了:

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

4.1 定义

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

4.2 指定字段

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

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

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

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

4.2.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.2.4) 显示指明字段,如:

class HeroInfoSerializer(serializers.ModelSerializer):
    hbook = BookInfoSerializer()

    class Meta:
        model = HeroInfo
        fields = (‘id‘, ‘hname‘, ‘hgender‘, ‘hcomment‘, ‘hbook‘)

4.2.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‘)

4.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)

java—代码块详解(代码片段)

代码块概念代码块分类普通代码块构造代码块静态代码块同步代码块代码块概念在java中,括起来的代码被称为代码块代码块分类普通代码块类中方法的方法体publicclassMain publicstaticvoidmain(String[]args) ...普通代码块 普通代码... 查看详情

textcupon代码优惠券代码discont代码(代码片段)

查看详情

代码块(代码片段)

静态代码块、构造代码块、构造方法的执行顺序?静态-》构造代码块-》构造方法静态代码块:只执行一次构造方法:每次调用构造方法都执行/**代码块:在Java中,使用括起来的代码成为代码块*根据其位置和声明的不同,可以... 查看详情

java代码块,普通代码块,构造代码块,静态代码块

学习Java中…刚刚学到了Java的代码块,虽然很简单还是记下吧!左音2016-03-16-----------------//执行优先级:静态代码块>mian方法>构造代码块>构造方法//静态代码块不论是否实例化都会执行一次,不会重复执行//构造代码块... 查看详情

ruby编写代码的代码(代码片段)

查看详情

jsonvisualstudio代码用户代码段(代码片段)

查看详情

html代码html代码(代码片段)

查看详情

java代码规范-代码格式(代码片段)

查看详情

托管代码和非托管代码

什么是托管代码?托管代码是运行在公共语言运行库上的(CLR)一个中间代码,起到编译的源代码的作用;源代码运行时分为两个阶段:一是编译源代码为托管代码,二托管代码编译为平台专用语言。托管代码运行在CLR上边,这个... 查看详情

java中普通代码块,构造代码块,静态代码块区别及代码示例2构造代码块

//执行顺序:(优先级从高到低。)静态代码块>mian方法>构造代码块>构造方法。其中静态代码块只执行一次。构造代码块在每次创建对象是都会执行。1普通代码块1//普通代码块:在方法或语句中出现的就称... 查看详情

业务代码与非业务代码

1.什么是业务代码?直接用于实现用户需求的代码就是业务代码,比如用户需要查询某个数据,那么直接查询数据库,返回结果的代码,就是业务代码。2.什么是非业务代码?辅助业务代码,一般可以脱离业务而存在的代码,比... 查看详情

html女孩学习代码:现场代码(代码片段)

查看详情

代码块

代码块1.代码块概述 在Java中,使用{}括起来的代码被称为代码块。 2.代码块分类 根据其位置和声明的不同,可以分为局部代码块,构造代码块,静态代码块,同步代码块。 3.代码块的应用(创建对象,就会先走构造代码块... 查看详情

java普通代码块,构造代码块,静态代码块区别,执行顺序的代码实例

Java普通代码块,构造代码块,静态代码块区别,执行顺序的代码实例2018年05月08日08:12:48 WJN不忘初心 阅读数:34 除了说普通代码块,静态代码块,构造代码块的执行顺序外,还有静态方法,静态变量等,都放在一起... 查看详情

好代码,坏代码:你的代码和其他工程师的代码(代码片段)

如果你以团队一员的身份编写代码,你所编写的代码很可能建立在其他工程师编写的代码层次的基础上,其他人也可能以你的代码为基础构建新的代码层次。如果你在工作期间解决了各种各样的子问题,并将其分解为... 查看详情

java中普通代码块,构造代码块,静态代码块区别及代码示例

//普通代码块:在方法或语句中出现的{}就称为普通代码块。普通代码块和一般的语句执行顺序由他们在代码中出现的次序决定--“先出现先执行”publicclassCodeBlock01{publicstaticvoidmain(String[]args){{intx=3;System.out.println("1,普通代码块内... 查看详情

抽取公共代码(代码片段)

如果要彻底明白WebpackV4版本如何抽取公共代码,就要设计一个场景来支持抽取公共代码的多种形式,能够从代码运行的结果中查看实际的效果,从效果中深入理解各个参数的作用。场景设计在设计场景之前,首先要明白公共代码... 查看详情

#代码质量控制和代码质量相关工具说明(代码片段)

代码质量检测工具及检测说明代码质量与规范高质量代码的优势易读性、可维护性高安全性、可测试性高高内聚低耦合方便功能扩展代码质量目标代码质量管控规范化:建立代码规范与CodeReview制度自动化:使用工具自动... 查看详情