drf框架序列化

Posted 2020-11-23 shaozheng

目录

• drf框架序列化 |反序列化:
  • 序列化与反序列化：
  • drf序列化与反序列化:
  • 序列化:
    • models.py
    • Serializers.py
    • Serializer 反序列化：
    • views.py:
    • ModelSerializers 指定表模型：
    • 自定义反序列化方法：

drf框架序列化 |反序列化:

序列化与反序列化：

序列化：对象转换为字符串用于传输
反序列化：字符串转换为对象用于使用

序列化是为了保持对象在内存中的状态，并且可以把保存的对象状态再读出来

    a、数据持久化：比如一个电商平台，有数万个用户并发访问的时候会产生数万个session 对象，这个时候内存的压力是很大的。我们可以把session对象序列化到硬盘中,需要时在反序列化，减少内存压力。
    
    b、网络传输：我们将系统拆分成多个服务之后，服务之间传输对象，不管是何种类型的数据，都必须要转成二进制流来传输，接受方收到后再转为数据对象。

     序列化是将对象状态转换为可保持或传输的格式的过程。与序列化相对的是反序列化，它将流转换为对象。这两个过程结合起来，可以轻松地存储和传输数据。

drf序列化与反序列化:

    序列化：Model类对象转换为字符串用于传输
    反序列化：字符串转换为Model类对象用于使用

模块： from rest_framework import serializers

使用drf的序列化组件：
    1 新建一个序列化类继承Serializer
    2 在类中写要序列化的字段
    
在视图中使用序列化的类：
    1 实例化序列化的类产生对象,在产生对象的时候，传入需要序列化的对象（queryset）
    2 对象.data
    3 return Response(对象.data)

高级用法：
    source：可以指定字段（name publish.name），可以指定方法。
    SerializerMethodField搭配方法使用（get_字段名字）
    read_only:反序列化时，不传
    write_only：序列化时，不显示

序列化和反序列化使用的分类:
        前后端交互主要有get,post,puch,put,deleter
        其中用到序列化的get
        用到反序列化的剩下四中: post,puch,put,deleter

序列化:

models.py

from django.db import models

class User(models.Model):
    SEX_CHOICES = {
        (0,'女'),
        (1,'男')   # 取值取第一个get_sex_display()  去第二个值
    }
    username = models.CharField(max_length=64,verbose_name='用户名',blank=True,unique=True )   
    password = models.CharField(max_length=64,verbose_name='密码')
    sex = models.IntegerField(choices=SEX_CHOICES,default=0,verbose_name='性别')
    img = models.ImageField(upload_to='img',default='img/default.png',verbose_name='头像')

    id_delete = models.BooleanField(default=False,verbose_name='是否注销')
    create_time = models.DateTimeField(auto_now_add=True,verbose_name='注册时间')

    class Meta:      #配置类 ： 给所属类添加配置信息
        db_table = 'jason_drf'
        verbose_name_plural = '用户表'

    def __str__(self):   #注意 ： 不要在这里进行连表操作，比如admin页面可能会崩溃
        return self.username

    @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)

Serializers.py

-----Serializer不指定表模型：

    1.不能识别所用那张表
     2.在反序列化时： 重建create | update 文件
    3.支持单表操作


from django.conf import settings
from rest_framework.views import APIView
from rest_framework.response import  Response        
from . import serializers   # 单表操作
class UserAPIViews(APIView):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        if pk:   # 查询数据
            user_obj = models.User.objects.filter(is_delete=False, pk=pk).first()
            if not user_obj:
                return Response({
                    'status': 1,
                    'msg': 'pk error',
                }, status=400)

            # 序列化处理
            user_ser = serializers.UserSerializer(user_obj, many=False)  # many默认为False 表示一个对象

            #获取序列化内的数据
            user_obj_data = user_ser.data
            return Response({
                'status': 0,
                'msg': 'ok',
                'results': user_obj_data
            })
        else:
            user_query = models.User.objects.filter(is_delete=False).all()

            user_ser = serializers.UserSerializer(user_query, many=True)  # 序列化多个对象
            user_list_data = user_ser.data

            return Response({
                'status': 0,
                'msg': 'ok',
                'results': user_list_data
            })

Serializer 反序列化：

    #反序列化   (增加  | 更新)  :
    def post(self,request,*args,**kwargs):
        request_data = request.data    # 获取前端发送的数据
        #数据反序列化 （数据校验）
        user_ser = serializers.UserSerializer(data = request_data).data
        #数据入库
        if user_ser.is_valid():
            #判断数据是否符合要求：
            user_obj = user_ser.save()
            return Response({
                'status': 0,
                'msg': 'ok',
                'results': serializers.UserSerializer(user_obj).data  # 将入库得到的user对象重新序列化的数据返回给前台
            })
        else:
            return Response({
                'status': 1,
                'msg': user_ser.errors,
            })

views.py:

class UserAPIViewsS(APIView):
    # 单查群查
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        if pk:
            user_obj = models.User.objects.filter(is_delete=False, pk=pk).first()
            if not user_obj:
                return Response({
                    'status': 1,
                    'msg': 'pk error',
                }, status=400)
            user_ser = serializers.UserModelSerializer(user_obj,many=False)
            return Response({
                'status': 0,
                'msg': 'ok',
                'results': user_ser.data
            })
        else:
            user_query = models.User.objects.filter(is_delete=False).all()
            user_ser = serializers.UserModelSerializer(user_query, many=True)

            return Response({
                'status': 0,
                'msg': 'ok',
                'results': user_ser.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,
            })

ModelSerializers 指定表模型：

class UserAPIViewsS(APIView):
    # 单查群查
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        if pk:
            user_obj = models.User.objects.filter(is_delete=False, pk=pk).first()
            if not user_obj:
                return Response({
                    'status': 1,
                    'msg': 'pk error',class UserModelSerializer(serializers.ModelSerializer):
    # 封装自定义序列化：插拔式设计
    # 自定义反序列化： 区分 ： write_only = True
    re_password = serializers.CharField(min_length=3, max_length=16, write_only=True)

    class Meta:     # 配置
        model = models.User   # 配置使用的表
        # 配置所有参与序列化与反序列化字段
        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')

    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类已提供，且支持所有关系下的连表操作

自定义反序列化方法：

方法一： 
    自定义序列化字段 （要再次处理的字段）
    gender = serializers.SerializerMethodField()

    def get_gender(self,obj):   # obj ：单个表对象   获取第二值
        return obj.get_sex_display()

方法二： （插拔式）
    
    @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)