drf的序列化器

三流

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

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

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)有关

反序列化

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方法

原文地址:https://www.cnblogs.com/agsol/p/12099445.html

时间: 2024-10-11 04:30:53

drf的序列化器的相关文章

drf序列化器serializers.SerializerMethodField()的用法

为什么DRF中有时候返回的json中图片是带域名的,有时候是不带域名的呢? 解析: 带域名的结果是在view中对模型类序列化的,DRF在序列化图片的时候 会检查上下文有没有request,如果有,就给图片加上域名, 比如说我们视图用的是apiview(): 我们需要序列化数据的时候,加  context={"request":request} TestSerilaizer(instance=instance, context={"request":request})

drf序列化器的实例

应用目录结构: views.py from django.shortcuts import render # Create your views here. from django.views import View from django.http import JsonResponse, QueryDict from bookset.models import BookInfo #导入序列化列 from .serializers import BookInfoSerializer #####

DRF序列化器的使用

序列化器的使用 序列化器的使用分两个阶段: 在客户端请求时,使用序列化器可以完成对数据的反序列化. 在服务器响应时,使用序列化器可以完成对数据的序列化. 序列化的基本使用 使用的还是上一篇博文中使用的数据库 先查询出一个学生对象 from students.models import Student student = Student.objects.get(id=3) 构造序列化器对象 from .serializers import StudentSerializer serializer

DRF框架之Serializer序列化器的序列化操作

在DRF框架中,有两种序列化器,一种是Serializer,另一种是ModelSerializer. 今天,我们就先来学习一下Serializer序列化器. 使用Serializer序列化器的开发步骤: 1. 定义Serializer序列化器 首先,我们要在子应用中,创建见一个serializers.py文件,用来编写Serializer序列化器代码. from rest_framework import serializers # 定义序列化器 class BookInfoSerializer

DRF项目之通过业务逻辑选择数据集和序列化器

在REST后台开发中,我们需要通过业务逻辑来选择数据集或者序列化器. 选择数据集: # 重写get_queryset实现通过业务逻辑选择指定数据集 def get_queryset(self): ''' 通过前段传递过来的keyword选择指定数据集 :return: ''' # 获取keyword keyword = self.request.query_params.get('keyword') # 通过前段传递过来的keyword选择指定数据集 if keyword: users = Us

序列化器的理解

其实就是Django RESTful Framework RESTful一种API的命名风格,主要因为前后端分离开发出现 前后端分离: 用户访问静态文件的服务器,数据全部由ajax请求给到 RESTful风格:数据应该是名词,而动词由HTTP的请求方式来体现 RESTful风格的API给前端返回 结果对象,无论什么请求方式 "' 特点: 反复重复 因为不论什么请求方式,都需要给前端返回对象内容,就是json格式的 所以每次如果有查询的结果对象都需要遍历成字典,和flask相同 如果不是get请求

DRF的序列化

DRF视图 APIview django中写CBV的时候是继承View,而rest_framework继承的是APIView,那么他们两个有什么不同 urlpatterns = [ url(r'^book$', BookView.as_view()), url(r'^book/(?P<id>\d+)$', BookEditView.as_view()), ] 不管是View还是APIView最开始调用的都是as_view()方法,看源码有什么区别 我们能看到,APIView继承了View, 并

模型类序列化器

模型类序列化器 DRF提供了模型类序列化器: ModelSerializer 作用: 简化对应django模型类的序列化器的定义 ModelSerializer与常规的Serializer相同,但提供了: 基于模型类自动生成一系列字段 基于模型类自动为 Serializer 生成 validators,比如字段唯一的校验器 包含默认的 create() 和 update() 的实现 1. 定义 比如我们创建一个 DepartmentSerializer2 class DepartmentSeri

Cf序列化器-Serializer解析

Cf序列化器-Serializer 定义序列化器 Django REST framework中的Serializer使用类来定义,须继承自rest_framework.serializers.Serializer. 例如,我们已有了一个数据库模型类BookInfo class BookInfo(models.Model): btitle = models.CharField(max_length=20, verbose_name='名称') bpub_date = models.DateFiel