首页 > 其他分享 >drf

drf

时间:2023-02-02 19:46:28浏览次数:45  
标签:serializers name max publish CharField 序列化 drf

今日内容概要

1.序列化常用字段和字段参数

2.序列化高级用法之source(了解)

3.序列化高级用法之定制字段的两种方式

4.多表关联反序列化保存

5.反序列化字段校验

6.ModelSerializer使用

1.序列化常用字段和字段参数

序列化类

序列化类---》字段类 CharField,除此之外还有哪些其他的

序列化类---》字段类,字段类上,传属性的 ,序列化类上,也可以写属性
models.CharField(max_length=32)

常用字段类

1.BooleanField	      BooleanField()

2.NullBooleanField	  NullBooleanField()

3.CharField	CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)

4.EmailField	EmailField(max_length=None, min_length=None, allow_blank=False)

5.RegexField	RegexField(regex, max_length=None, min_length=None, allow_blank=False)

6.SlugField	SlugField(max_length=50, min_length=None, allow_blank=False) 正则字段,验证正则模式 [a-zA-Z0-9-]+

7.URLField	URLField(max_length=200, min_length=None, allow_blank=False)

8.UUIDField	UUIDField(format=’hex_verbose’) format: 1) 'hex_verbose' 如"5ce0e9a5-5ffa-654b-cee0-1238041fb31a" 2) 'hex' 如 "5ce0e9a55ffa654bcee01238041fb31a" 3)'int' - 如: "123456789012312313134124512351145145114" 4)'urn' 如: "urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a"

9.IPAddressField	IPAddressField(protocol=’both’, unpack_ipv4=False, **options)

10.IntegerField	IntegerField(max_value=None, min_value=None)

11.FloatField	FloatField(max_value=None, min_value=None)

12.DecimalField	DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) max_digits: 最多位数 decimal_palces: 小数点位置

13.DateTimeField	DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)

14.DateField	DateField(format=api_settings.DATE_FORMAT, input_formats=None)

15.TimeField	TimeField(format=api_settings.TIME_FORMAT, input_formats=None)

16.DurationField	DurationField()

17.ChoiceField	ChoiceField(choices) choices与Django的用法相同

18.MultipleChoiceField	MultipleChoiceField(choices)

19.FileField	FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)

20.ImageField	ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)


常用需要记住的:CharField  IntegerField  DecimalField  DateTimeField BooleanField
ListField
DictField

常用字段参数

选项参数:
CharField及其子类的(EmailField) ---》反序列化的校验,字段自己的规则
    max_length	最大长度
    min_lenght	最小长度
    allow_blank	是否允许为空
    trim_whitespace	是否截断空白字符

IntegerField
    max_value	最小值
    min_value	最大值

    
所有字段类都有的
required	表明该字段在反序列化时必须输入,默认True
default	    反序列化时使用的默认值
allow_null	表明该字段是否允许传入None,默认False
validators	该字段使用的验证器


error_messages	包含错误编号与错误信息的字典
label	用于HTML展示API页面时,显示的字段名称
help_text	用于HTML展示API页面时,显示的字段帮助提示信息


重点:
read_only	表明该字段仅用于序列化输出,默认False
write_only	表明该字段仅用于反序列化输入,默认False


反序列化校验执行流程
	1.先执行字段自己的校验规则----》最大长度,最小长度,是否为空,是否必填,最小数字。
    
    2.validators=[方法,] ----》单独给这个字段加校验规则
    	name=serializers.CharField(validators=[方法,])
    3.局部钩子校验规则
    4.全局钩子校验规则

2.序列化高级用法之source(了解)

创建关联表
class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.CharField(max_length=32)

    publish = models.ForeignKey(to='Publish', on_delete=models.CASCADE)  留住,还有很多
    authors = models.ManyToManyField(to='Author')


class Publish(models.Model):
    name = models.CharField(max_length=32)
    addr = models.CharField(max_length=32)


class Author(models.Model):
    name = models.CharField(max_length=32)
    phone = models.CharField(max_length=11)

迁移,录入数据

序列化定制字段名字

重点:source可以指定序列化字段的名字
	自有字段,直接写字段名字
    	name_real = serializers.CharField(max_length=8, source='name')
    关联字段,一对多的关联,直接点
    	publish = serializers.CharField(source='publish.name')
    多对多,搞不了,source不能用
    	authors=serializers.CharField(source='authors.all')
        
        
序列化类
class BookSerializer(serializers.Serializer):
    字段参数,通用的,所有字段都可以写  通过source指定哪个字段
    自有字段,直接写字段名字
    name_real = serializers.CharField(max_length=8, source='name')
    real_price = serializers.CharField(source='price')

    关联字段,一对多的关联,直接点
    publish = serializers.CharField(source='publish.name')

    多对多,搞不了,source不能用
    authors=serializers.CharField(source='authors.all')	

3.序列化高级用法之定制字段的两种方式

SerializerMethodField定制

定制关联字段的显示形式
	一对多的,显示字典
    多对多,显示列表套字典
    
代码
class BookSerializer(serializers.Serializer):
    name = serializers.CharField(max_length=8)
    price = serializers.CharField()

    定制返回格式
    publish_detail = serializers.SerializerMethodField()

    def get_publish_detail(self, obj):
        return {'name': obj.publish.name, 'addr': obj.publish.addr}

    author_list = serializers.SerializerMethodField()

    def get_author_list(self, obj):
        l = []
        for author in obj.authors.all():
            l.append({'name': author.name, 'phone': author.phone})
        return l

在表模型中定制

表模型
class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.CharField(max_length=32)

    publish = models.ForeignKey(to='Publish', on_delete=models.CASCADE)  留住,还有很多
    authors = models.ManyToManyField(to='Author')

    def publish_detail(self):
        return {'name': self.publish.name, 'addr': self.publish.addr}

    def author_list(self):
        l = []
        for author in self.authors.all():
            l.append({'name': author.name, 'phone': author.phone})
        return l   
序列化类
class BookSerializer(serializers.Serializer):
    name = serializers.CharField(max_length=8)
    price = serializers.CharField()

    publish_detail = serializers.CharField()
    publish_detail = serializers.DictField()
    author_list = serializers.ListField()

4.多表关联反序列化保存

新增图书接口

新增图书接口
     前端传入的数据格式:{name:红楼梦,price:19,publish:1,authors:[1,2]}
    
视图类
class BookView(APIView):
    def post(self, request):
        ser = BookSerializer(data=request.data)
        if ser.is_valid():
            ser.save()
            return Response({'code': 100, 'msg': '新增成功'})
        else:
            return Response({'code': 101, 'msg': ser.errors})


序列化类
class BookSerializer(serializers.Serializer):
    name和price  既用来序列化,又用来反序列化   即写又读 ,不用加read_only,write_only
    name = serializers.CharField(max_length=8)
    price = serializers.CharField()

    只用来做序列化   只读  read_only
    publish_detail = serializers.DictField(read_only=True)
    author_list = serializers.ListField(read_only=True)

    只用来做反序列化  只写  write_only
    publish = serializers.CharField(write_only=True)
    authors = serializers.ListField(write_only=True)

    新增要重写create方法
    def create(self, validated_data):
        validated_data 校验过后的数据,{name:红楼梦,price:19,publish:1,authors:[1,2]}
        新增一本图书
        book = Book.objects.create(name=validated_data.get('name'), price=validated_data.get('price'),
                                   publish_id=validated_data.get('publish'))

        作者也要关联上
        book.authors   add remove set clear....
        book.authors.add(*validated_data.get('authors'))
        book.authors.add(1,2)
        return book

修改图书接口

视图类
class BookDetailView(APIView):
    def put(self, request, pk):
        book = Book.objects.filter(pk=pk).first()
        ser = BookSerializer(data=request.data, instance=book)
        if ser.is_valid():
            ser.save()
            return Response({'code': 100, 'msg': '修改成功'})
        else:
            return Response({'code': 101, 'msg': ser.errors})
                
序列化类
反序列化的多表关联的保存
class BookSerializer(serializers.Serializer):
    name和price  既用来序列化,又用来反序列化   即写又读 ,不用加read_only,write_only
    name = serializers.CharField(max_length=8)
    price = serializers.CharField()

    只用来做反序列化  只写  write_only
    publish = serializers.CharField(write_only=True)
    authors = serializers.ListField(write_only=True)

    修改要重写update
    def update(self, instance, validated_data):
       validated_data 校验过后的数据,{name:红楼梦,price:19,publish:1,authors:[1,2]}
        instance.name = validated_data.get('name')
        instance.price = validated_data.get('price')
        instance.publish_id = validated_data.get('publish')

        先清空,再add
        authors = validated_data.get('authors')
        instance.authors.clear()
        instance.authors.add(*authors)

        instance.save()

        return instance

5.反序列化字段校验

1.字段自己的:举例:name = serializers.CharField(max_length=8, error_messages={'max_length': '太长了'})
2.validators=[方法,]   忽略掉
3.局部钩子
4.全局钩子

6.ModelSerializer使用

ModelSerializer 继承自Serializer,帮我们完成了很多操作
	跟表模型强关联
	大部分情况,不用写create和update了
    如何使用

ModelSerializer的使用
class BookSerializer(serializers.ModelSerializer):
    跟表有关联
    class Meta:
        model = Book  跟book表建立了关系     序列化类和表模型类
        fields = '__all__'  序列化所有Book中的字段  id name price publish authors
        fields = ['name', 'price', 'publish_detail', 'author_list', 'publish', 'authors']  # 序列化所有Book中的name和price字段字段

        定制name反序列化时,最长不能超过8   给字段类加属性   方式一
        extra_kwargs = {'name': {'max_length': 8},
                        'publish_detail': {'read_only': True},
                        'author_list': {'read_only': True},
                        'publish': {'write_only': True},
                        'authors': {'write_only': True},
                        }

    如果Meta写了__all__ ,就相当于,复制了表模型中的所有字段,放在了这里,做了个映射
    name = serializers.CharField(max_length=32)
    price = serializers.CharField(max_length=32)

    定制name反序列化时,最长不能超过8   给字段类加属性  方式二,重写name字段
    name = serializers.CharField(max_length=8)

    同理,所有的read_only和wirte_only都可以通过重写或使用extra_kwargs传入

    终极,把这个序列化类写成跟之前一模一样项目
    publish_detail = serializers.SerializerMethodField(read_only=True)
    def get_publish_detail(self, obj):
        return {'name': obj.publish.name, 'addr': obj.publish.addr}
    author_list = serializers.SerializerMethodField(read_only=True)
    def get_author_list(self, obj):
        l = []
        for author in obj.authors.all():
            l.append({'name': author.name, 'phone': author.phone})
        return l

    局部钩子和全局钩子跟之前完全一样
    def validate_name(self, name):
        if name.startswith('sb'):
            raise ValidationError('不能sb')

        else:
            return name

标签:serializers,name,max,publish,CharField,序列化,drf
From: https://www.cnblogs.com/yueq43/p/17087204.html

相关文章

  • drf3
    今日内容概要APIView执行流程Request对象源码分析序列化器介绍和快速使用反序列化基于序列化器编写5个接口反序列化的校验今日内容详细APIView执行流程'''基于A......
  • drf4
    今日内容概要序列化类常用字段和字段参数序列化高级用法之source序列化高级用法之定制字段的两种方式多表关联反序列化保存反序列化字段校验其他ModelSerializer使......
  • django之drf(部分讲解)
    序列化类常用字段和字段参数drf在Django字段类型的基础上派生了自己的字段类型以及字段参数序列化器的字段类型用于处理原始值和内部数据类型直接的转换还可以用于验证......
  • python之路62 drf从入门到成神 3 序列化类常用字段和字段参数、序列化高级用法之sour
    作业#原生的django中request中没有datafromdjango.shortcutsimportrender,HttpResponseimportjson#通过装饰器做,装饰器视图函数的,以后都会有requestdefwr......
  • drf 03
    APIView执行流程基于APIView+JsonResponse编写接口#APIView是drf提供给使用者的一个类,在使用drf写视图类,继承都是这个类及其子类#APIView继承了Django原生的view#......
  • 一篇文章极速复习drf知识点
    serializers.py文件对象->json序列化json->对象反序列化write_only实例:fromrest_framework.serializersimportModelSerializerfromrest_frameworkimp......
  • drf 序列化与反序列化 接口
    基于APIView编写5个接口之前是基于django的原生View编写接口现在用基于drf的APIView编写接口#drf提供了一个APIView类,以后用drf写视图类都是继承这个类或其子类,APIVie......
  • drf入门——APIView执行流程、Request对象源码分析、序列化器、反序列化及其校验
    drf入门——APIView执行流程、Request对象源码分析、序列化器、反序列化及其校验目录drf入门——APIView执行流程、Request对象源码分析、序列化器、反序列化及其校验APIV......
  • drf APIView执行流程,Request对象源码分析,序列化器介绍与使用
    昨日内容回顾restful规范1接口使用https协议传输数据保证数据的安全性2接口带api标识3接口带版本信息4接口地址即资源,尽量使用名字,或复数,特殊情况可以使用动词5接口......
  • DRF - 源码分析和序列化器
    目录一、APIView1.基于APIView+JsonResponse写接口2.基于drf的APIView+Response写接口二、Request对象源码分析三、序列化器的基本使用1.序列化2.序列化器介绍3.序列化类......