zoukankan      html  css  js  c++  java
  • 序列化组件

    三流

    import sys
    #标准输出流
    sys.stdout.write('123
    ')
    sys.stdout.write('456
    ')
    #标准输入流
    res=sys.stdin.readline()
    print(res)
    #标准错误流:将括号内数据作为错误输出
    sys.stderr.write('abc
    ')
    sys.stderr.write('xyz
    )
    

    注意:每个流之间为异步提交,流内为同步提交.

    JSON文件格式

    JSON 值可以是:
    • 数字(整数或浮点数)
    • 字符串(在双引号中)
    • 逻辑值(true 或 false)
    • 数组(在方括号中)
    • 对象(在花括号中)
    • null
    JSON 语法规则:
    • 数据在名称/值对中
    • 数据由逗号分隔
    • 花括号保存对象
    • 方括号保存数组

    为什么要使用序列化器

    drf中的response方法只能接收json数格式,并将json数据解析为二进制格式发送给前端,也可以更以更方便的方法对数据进行验证以及数据库操作.

    序列化家族

    1. Serializer类,底层是序列化类,(了解原理)
    2. ModelSerializer类,模型序列化类(核心)
    3. ListSerializer类:群操作序列化类(辅助类)

    手动序列化

    前后端交互,通过json格式文件进行传输,使用djangoORM语句将对象从数据库中找出来进行交互,需要手动序列化转为json格式再进行交互.

    class UserV1APIView(APIView):
        # 单查群查
        def get(self, request, *args, **kwargs):
            pk = kwargs.get('pk')
            if pk:
                user_dic = models.User.objects.filter(is_delete=False, pk=pk).values('username', 'sex', 'img').first()
                if not user_dic:
                    return Response({
                        'status': 1,
                        'msg': 'pk error',
                    }, status=400)
    
                user_dic['img'] = '%s%s%s' % (settings.BASE_URL, settings.MEDIA_URL, user_dic.get('img'))
                return Response({
                    'status': 0,
                    'msg': 'ok',
                    'results': user_dic
                })
            else:
                user_query = models.User.objects.filter(is_delete=False).values('username', 'sex', 'img').all()
                for user_dic in user_query:
                    user_dic['img'] = '%s%s%s' % (settings.BASE_URL, settings.MEDIA_URL, user_dic.get('img'))
                user_list = list(user_query)
                return Response({
                    'status': 0,
                    'msg': 'ok',
                    'results': user_list
                })
    

    Serializer序列化类

    序列化

    新建serializers.py文件,文件中进行Serializer类的操作

    from rest_framework import serializers
    from django.conf import settings
    from . import models
    class UserSerializer(serializers.Serializer):
        # 1)字段名与字段类型要与处理的model类对应
        # 2)不提供的字段,就不参与序列化给前台
        # 3)可以自定义序列化字段,采用方法序列化,方法固定两个参数,第二个参数就是参与序列化的model对象
        #       (严重不建议自定义字段名与数据库字段名重名,由get_自定义字段名方法的返回值提供字段值)
        username = serializers.CharField()
        # sex = serializers.IntegerField()
        # sex = serializers.SerializerMethodField()  # 不建议这样命名
        gender = serializers.SerializerMethodField()
    
        def get_gender(self, obj):
            return obj.get_sex_display()
    
        # 注:在高级序列化与高级视图类中,drf默认帮我们处理图片等子资源
        icon = serializers.SerializerMethodField()
    
        def get_icon(self, obj):
            return '%s%s%s' % (settings.BASE_URL, settings.MEDIA_URL, obj.img)
    

    使用改名显示字段,官方建议使用在models类中定义属性方法

    #models中
        # 第二种自定义序列化字段(插拔式,提倡使用)
        @property
        def gender(self):
            return self.get_sex_display()
    
        @property
        def icon(self):
            from django.conf import settings
            return '%s%s%s' % (settings.BASE_URL, settings.MEDIA_URL, self.img)
    

    总结:

    1. 设置序列化字段,字段名与字段类型要与处理的model类属性名对应(只参与序列化的类型不需要设置条件)

    2. model类中有的字段,但在序列化中没有对应字段,该类字段不参与序列化

    3. 自定义序列化字段(方法一),字段类型为SerializerMethodField(),值有 get_自定义字段名(self, model_obj) 方法提供,

      一般值都与参与序列化的model对象(model_obj)有关

    反序列化

    views中设置data=request.data

        def post(self, request, *args, **kwargs):
            user_ser = serializers.UserModelSerializer(data=request.data)
            if user_ser.is_valid():
                # 入库
                user_obj = user_ser.save()
                return Response({
                    'status': 0,
                    'msg': 'ok',
                    'results': serializers.UserModelSerializer(user_obj).data
                })
            else:
                return Response({
                    'status': 1,
                    'msg': user_ser.errors,
                })
    

    serializer中

    class UserDeSerializer(serializers.Serializer):
        # 自定义 系统校验字段
        username = serializers.CharField(min_length=3, max_length=16, error_messages={
            'min_length': '太短',
            'max_length': '太长'
        })
        password = serializers.CharField(min_length=3, max_length=16)
    
        # 不写,不参与反序列化,写就必须参与反序列化(但可以设置required=False取消必须)
        # required=False的字段,前台不提供,走默认值,提供就一定进行校验;不写前台提不提供都采用默认值
        sex = serializers.BooleanField(required=False)
    
        # 自定义校验字段:从设置语法与系统字段没有区别,但是这些字段不能参与入库操作,需要在全局钩子中,将其取出
        re_password = serializers.CharField(min_length=3, max_length=16)
    
        # 局部钩子:
        #   方法就是 validate_校验的字段名(self, 校验的字段数据)
        #   校验规则:成功直接返回value,失败抛出校验失败信息
        def validate_username(self, value):
            if 'g' in value.lower():
                raise serializers.ValidationError('名字中不能有g')
            return value
    
        # 全局钩子:
        #   方法就是 validate(self, 所有的校验数据)
        #   校验规则:成功直接返回attrs,失败抛出校验失败信息
        def validate(self, attrs):
            password = attrs.get('password')
            re_password = attrs.pop('re_password')
            if password != re_password:
                raise serializers.ValidationError({'re_password': '两次密码不一致'})
            return attrs
    
        # 在视图类中调用序列化类的save方法完成入库,Serializer类能做的增入库走create方法,改入库走update方法
        # 但Serializer没有提供两个方法的实现体
        def create(self, validated_data):
            return models.User.objects.create(**validated_data)
    
        # instance要被修改的对象,validated_data代表校验后用来改instance的数据
        def update(self, instance: models.User, validated_data):
            # 用户名不能被修改
            validated_data.pop('username')
            models.User.objects.filter(pk=instance.id).update(**validated_data)
            return instance
    

    对于数据的校验,需要通过自定义系统方法,自定义局部以及全局钩子的方法进行校验.还需要自己写create以及update方法.

    ModelSerializer序列化类

    class UserModelSerializer(serializers.ModelSerializer):
        # 第一种自定义序列化字段:该字段必须在fields中设置
        # gender = serializers.SerializerMethodField()
        # def get_gender(self, obj):
        #     return obj.get_sex_display()
    
    
        # 自定义反序列化字段同Serializer类,且规则只能在此声明中设置,或是在钩子中设置,
        #       在extra_kwargs中对其设置的无效
        # 注:自定义反序列化字段与系统字段,设置规则一样,所以必须设置 write_only
        re_password = serializers.CharField(min_length=3, max_length=16, write_only=True)
    
        class Meta:
            model = models.User
            # fields采用 插拔式 设置所有参与序列化与反序列化字段
            fields = ('username', 'gender', 'icon', 'password', 'sex', 're_password')
            extra_kwargs = {
                'username': {  # 系统字段不设置read_only和write_only,默认都参加
                    'min_length': 3,
                    'max_length': 10,
                    'error_messages': {
                        'min_length': '太短',
                        'max_length': '太长'
                    }
                },
                'gender': {
                    'read_only': True,  # 自定义的序列化字段默认就是read_only,且不能修改,可以省略
                },
                'password': {
                    'write_only': True,
                },
                'sex': {  # 像sex有默认值的字段,为选填字段('required': True可以将其变为必填字段)
                    'write_only': True,
                    # 'required': True
                }
            }
    
    
        # 局部全局钩子同Serializer类,是与 Meta 同缩进的
        def validate_username(self, value):
            if 'g' in value.lower():
                raise serializers.ValidationError('名字中不能有g')
            return value
    
        def validate(self, attrs):
            password = attrs.get('password')
            re_password = attrs.pop('re_password')
            if password != re_password:
                raise serializers.ValidationError({'re_password': '两次密码不一致'})
            return attrs
    
        # create和update方法不需要再重写,ModelSerializer类已提供,且支持所有关系下的连表操作
    

    总结:

    1. 序列化类继承ModelSerializer,所以需要在配置类Meta中进行配置
    2. model配置:绑定序列化相关的Model表
    3. fields配置:采用 插拔式 设置所有参与序列化与反序列化字段
    4. extra_kwargs配置: 划分系统字段为三种:只读(read_only)、只写(write_only)、可读可写(不设置) 字段是否必须:required 选填字段:在extra_kwargs进行配置,但不设置required,且有默认值
    5. 自定义序列化字段: 第一种(不提倡):在序列化类中用SerializerMethodField()来实现 第二种(提倡):在模型类中用@property来实现,可插拔
    6. 自定义反序列化字段: 同Serializer类,且规则只能在此声明中设置,或是在钩子中设置,在extra_kwargs中对其设置的无效 自定义反序列化字段与系统字段,设置规则一样,所以必须设置 write_only
    7. 局部钩子,全局钩子同Serializer类
    8. 不需要重写create和update方法

    子序列化

    1. 只能在序列化中使用,因为外键字段不可以反序列化写入数据库

    2. 字段名必须是外键(正反向都可)字段

      因为相对于自定义序列化外键字段,自定义序列化字段是不能参与反序列化的,而子序列化必须为外键名,所以就无法入库

    3. 外键关联多条数据时,需要明确many=True

    4. 单项操作,作为子类的系类的类必须写在上方,

    class BookModelSerializer(serializers.ModelSerializer):
        class Meta:
            model = models.Book
            fields = '__all__'
    
     
    class PublishModelSerializer(serializers.ModelSerializer):
        # 子序列化:
        # 1)只能在序列化中使用
        # 2)字段名必须是外键(正向反向)字段
        #   因为相对于自定义序列化外键字段,自定义序列化字段是不能参与反序列化的,而子序列化必须为外键名,所以就无法入库
        # 3)在外键关联数据是多条时,需要明确many=True
        # 4)是单向操作,因为作为子系列的类必须写在上方,所以不能产生逆方向的子序列化
        books = BookModelSerializer(many=True)
        class Meta:
            model = models.Publish
            # fields = '__all__'
            fields = ['name', 'address', 'books'] #不写上面的相当于直接反向将books直接全部查出来
    

    exclude=['xxx']属性,在全部中去除xxx属性,序列化发送给前端

    depth =1 表示查询深度为1,即将本表的一层外键字段对应的表记录战术出来

    class PublishModelSerializer(serializers.ModelSerializer):   
        class Meta:
            model = models.Publish
            fields = ['name', 'address', 'books']
    
            # 了解配置
            # fields = '__all__'
            # exclude = ['name']
            # depth = 2  # 自动深度,值代表深度次数,但是被深度的外键采用__all__,显示所以字段
    
    

    其中,fields和exclude不可以同时使用

    ListSerializer序列化类

    只重写了list群create方法,没写update方法

    ModelSerializer默认配置了ListSerializer辅助类,帮助完成群增群改

    配置类中配置
    #自定义配置listSerialzer类方法
    class BookListSerializer(serializers.ListSerializer):
        # 自定义的群增群改辅助类,没有必要重写create方法
        def create(self, validated_data):
            return super().create(validated_data)
    
        def update(self, instance_list, validated_data_list):
            return [
                self.child.update(instance_list[index], attrs) for index, attrs in enumerate(validated_data_list)
            ]
    
    #默认
    class Meta:
        list_serializer_class = serializers.ListSerializer
    #自定义
    class Meta:
        # 如果只有群增,是不需要自定义配置的,但要完成群改,必须自定义配置
        list_serializer_class = BookListSerializer
    

    前台可以必传数据的要求

    fields中写了,又无默认值,而extra_kwargs中也没设置required=False.就一定要传给后台值.

    序列化对象方法属性

    • book_ser.is_valid(raise_exception=True),设置系统校验,不符合格式直接抛异常

    • book_ser.data 返回序列化对象字段的所有信息

    • 序列化组件属性参数:

      book_ser = serializers.BookModelSerializer(
      instance=book_instance, 
      data=request.data, 
      many=True,
      partial=True, 
      context={'request': request}
      )
      

      instance表示被修改的数据

      data表示序列化传入的数据

      partial表示参与序列化的字段,可以为选填字段

      context表示给序列化类方法里面带参数,常用来将request对象传入

      many=True表示可以传入多个值

  • 相关阅读:
    spark机器学习从0到1特征抽取–Word2Vec(十四)
    spark机器学习从0到1特征抽取–CountVectorizer(十三)
    spark机器学习从0到1特征提取 TF-IDF(十二)
    spark机器学习从0到1机器学习工作流 (十一)
    vant ui中area组件踩坑记录
    免费CDN:jsDelivr+Github 使用方法
    使用vue-quill-editor实现富文本编辑器
    数组添加元素到特定位置
    scoop——强大的Windows命令行包管理工具
    radio单选框样式
  • 原文地址:https://www.cnblogs.com/agsol/p/12117083.html
Copyright © 2011-2022 走看看