rest_framework序列化与反序列化1

目录

• 自定义序列化过程
• 使用rest_framework 的序列化模块 serializers对视图类的数据进行序列化与反序列化
  • 序列化
  • 反序列化
• 使用ModelSerializer模型类完成序列化与反序列化

自定义序列化过程

自定义序列化的过程，对数据的单查与群查，序列化的过程：ORM操作得到数据，然后将数据序列化成前台可以使用的数据返回给前台。

from rest_framework.response import Response
from django.conf import settings
from rest_framework.views import APIView
from . import models


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')
            															#进行序列化的

            for user_dic in user_query:#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
            })

使用rest_framework 的序列化模块 serializers对视图类的数据进行序列化与反序列化

序列化

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

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

3）自定义序列化字段(方法一)，字段类型为SerializerMethodField()，值由 get_自定义字段名(self, model_obj) 方法提供，一般值都与参与序列化的model对象(model_obj)有关

#视图类
from . import serializers
class UserV2APIView(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_dic['img'] = '%s%s%s' % (settings.BASE_URL, settings.MEDIA_URL, user_dic.get('img'))
            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
            })
     
    
#自定义序列化类serializers
from rest_framework import serializers
from django.conf import settings
from . import models


class UserSerializer(serializers.Serializer):
    # 1）字段名与字段类型要与处理的model类对应
    # 2）不提供的字段，就不参与序列化给前台
    # 3）可以自定义序列化字段，采用方法序列化，方法固定两个参数，第二个参数就是参与序列化的model对象

    username = serializers.CharField()

    # 不建议自定义字段名与数据库字段名重名，最好使用get_自定义字段名方法的返回值提供字段值
    # 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)

反序列化

1）系统校验字段与自定义校验字段定义没有区别：

字段 = serializers.字段类型(条件)

2）自定义校验字段不能将数据直接写入数据库，它们只负责数据写入数据库前的校验。

3）所有的字段都可以设置对应的局部钩子进行校验，局部钩子的设置方法： validate_字段名(self, 字段值value)

规则：校验通过直接返回value，校验失败抛出校验失败信息：ValidationError('错误信息')

4）一个序列化类存在一个全局钩子可以对所有字段进行全局校验，使用方法： validate(self, 所有字段值字典attrs)

规则：校验成功直接返回attrs，校验失败抛出校验失败信息：ValidationError({'异常字段', '错误信息'})

5）重写create方法实现新增的数据写入数据库，返回写入成功的数据对象

6）重写update方法实现修改的的数据写入数据库，返回修改成功的数据对象

#视图类
from . import serializers
class UserV2APIView(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_dic['img'] = '%s%s%s' % (settings.BASE_URL, settings.MEDIA_URL, user_dic.get('img'))
            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
            })

    #单增
    def post(self,request,*args,**kwargs):
        request_data = request.data
        user_ser = serializers.UserDeSerializer(data=request_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,
            })

#继承drf的serializers.Serializer类自定义反序列化类
class UserDeSerializer(serializers.Serializer):

    #drf 校验字段
    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)

    # 自定义校验字段的数据类型、字段名和models类中字段是相同的，但是校验字段只对数据进行校验
    re_password = serializers.CharField(min_length=3,max_length=16)

    # 局部钩子：
    #   方法      validate_校验的字段名(self, 校验的字段数据)
    #   校验规则：校验通过直接返回value，校验失败抛出校验失败信息
    def validate_username(self,value):
        if 'b' in value.lower():
            raise serializers.ValidationError('名字中不能出现a')
        return value

    def validate(self, attrs):
        re_password = attrs.pop('re_password')#pop会将要pop的内容先取出，再pop
        password = attrs.get('password')
        if password != re_password:
            raise serializers.ValidationError({'re_password':'两次密码不一致'})
        return attrs

    # 在视图类中调用序列化类的save方法将数据写入数据库，而save方法会调用Serializer类的create、update方法将数据写入数据库，
    # 但是Serializer类只定义了空的create、update等操作数据库的方法，需要我们重写数据库的这些方法，才能完成将数据写入数据库的操作。
  
    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

使用ModelSerializer模型类完成序列化与反序列化

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

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

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

通过继承ModelSerializer类实现序列化与反序列化：

1）序列化类继承ModelSerializer，所以需要在配置类Meta中进行配置

2）model配置：绑定序列化相关的Model表

3）fields配置：采用插拔式设置所有参与序列化与反序列化字段

4）extra_kwargs配置：
划分系统字段为三种：只读(read_only)、只写(write_only)、可读可写(不设置时)

字段是否必须填写：required
选填字段：在extra_kwargs进行配置，不用设置required，默认required=False
只读只写等操作用于参加序列化与反序列化的字段，并不直接影响数据库的读写，所以我们可以在将确认密码等字段设置为只写，当使用全局钩子将其取出与密码进行的同时将其从钩子的attrs中删除。

5）自定义序列化字段：
第一种(不提倡)：在序列化类中用SerializerMethodField()来实现

第二种(提倡)：在模型类中用@property来实现，可插拔如下面的模型类和序列化类

#模型类
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='头像')
    # 开发中，数据不会直接删除，通过字段控制
    is_delete = models.BooleanField(default=False, verbose_name='是否注销')
    # 数据库数据入库，一般都会记录该数据第一次入库时间，有时候还会记录最后一次更新时间
    created_time = models.DateTimeField(auto_now_add=True, verbose_name='创建时间')

    # 第二种自定义序列化字段（插拔式，提倡使用）
    @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)


    class Meta:  # 配置类，给所属类提供配置信息
        db_table = 'user'
        verbose_name_plural = '用户表'

所谓可插拔就是在fields中添加了就默认该字段可以进行序列化和反序列化，不过前提是必须models里的字段，如果是自定义的序列化字段默认就是read_only，且不能修改，自定义字段如果不采用插拔式可以进行反序列化但只进行反序列化（用于数据校验）不能往数据库写。

#序列化类
class UserModelSerializer(serializers.ModelSerializer):
    #校验规则只能在定义时设置，或是在钩子中设置，在extra_kwargs中对其设置的无效
    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
            }
        }

6）自定义反序列化字段：

#和Serializer类相同，且校验规则只能在定义时设置，或是在钩子中设置，在extra_kwargs中对其设置的无效
 re_password = serializers.CharField(min_length=3, max_length=16, write_only=True)

#自定义反序列化字段与系统字段设置规则一样，所以必须设置write_only为True

7）局部钩子，全局钩子同Serializer类

   # 局部全局钩子同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
    #校验规则：局部钩子校验成功直接返回value，失败抛出失败信息，
    #全局钩子校验成功返回attrs，失败抛出校验失败信息

8）不需要重写create和update方法

ModelSerializer的create和update方法是已经写好的，在执行user_obj = user_ser.save()方法时会调用。

完整的采用继承ModelSerializer类的方式进行序列化和反序列化的视图类、序列化类、models类代码如下，该代码实现了通过浏览器向数据库查、单增数据：

#视图类
class UserV3APIView(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,
            })

#序列化类
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

#模型类
from django.db import models

class User(models.Model):
    SEX_CHOICES = (
        (0, '女'),
        (1, '男'),
    )

    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='头像')
    # 开发中，数据不会直接删除，通过字段控制
    is_delete = models.BooleanField(default=False, verbose_name='是否注销')
    # 数据库数据入库，一般都会记录该数据第一次入库时间，有时候还会记录最后一次更新时间
    created_time = models.DateTimeField(auto_now_add=True, verbose_name='创建时间')

    # 第二种自定义序列化字段（插拔式，提倡使用）
    @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)


    class Meta:  # 配置类，给所属类提供配置信息
        db_table = 'user'
        verbose_name_plural = '用户表'

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