Django REST framework序列化器详解:普通序列化器与模型序列化器的选择与运用

在这里插入图片描述

系列文章目录

  • Django入门全攻略:从零搭建你的第一个Web项目
  • Django ORM入门指南:从概念到实践,掌握模型创建、迁移与视图操作
  • Django ORM实战:模型字段与元选项配置,以及链式过滤与QF查询详解
  • Django ORM深度游:探索多对一、一对一与多对多数据关系的奥秘与实践
  • 跨域问题与Django解决方案:深入解析跨域原理、请求处理与CSRF防护
  • Django视图层探索:GET/POST请求处理、参数传递与响应方式详解
  • Django路由与会话深度探索:静态、动态路由分发,以及Cookie与Session的奥秘
  • Django API开发实战:前后端分离、Restful风格与DRF序列化器详解
  • Django REST framework序列化器详解:普通序列化器与模型序列化器的选择与运用
  • 还在写0.0…

文章目录

  • 系列文章目录
  • 前言
  • 一、普通序列化器-Serializer
    • 1. 普通序列化器编写方式
    • 2. 普通序列化器序列化
    • 3. 普通序列化器反序列化创建
    • 4. 普通序列化器反序列化更新
    • 5. 普通序列化器完整代码
  • 二、模型序列化器-ModelSerializer
    • 1. 模型序列化器编写方式
    • 2. 模型序列化器反序列化创建、更新
    • 3. 模型序列化器与普通序列化器的对比


前言

    在 Django REST framework 中,数据序列化至关重要。本文将探讨 普通序列化器模型序列化器,了解它们的基本功能和差异,帮助您根据项目需求选择合适的序列化器。


Response是不能直接返回ORM数据的,所以需要我们进行序列化操作,可以通过手动将其转为字典或JSON,也可以使用DRF所提供的序列化器,一般建议使用序列化器
如果你经常使用的是自己去将数据封装为JSON,那么常见的代码模型就像这样

data = models.objects.all()
json_data = {}
for d in data:json_data['age'] = d.agejson_data['name'] = d.name
return Response(json_data)

随字段越来越多,工作量会越来越大,而且有关于时间(DateTimeField、DateField)等字段类型的序列化直接通过JSON也是不行的,需要自己手动编写JSON的序列化器,非常麻烦,于是乎 DRF 就提供了更为便捷的两种序列化器,普通序列化器模型序列化器


一、普通序列化器-Serializer

1. 普通序列化器编写方式

导包:from rest_framework import serializers

普通序列化器,可以按照给定字段,将所匹配的ORM数据字段转换为JSON数据,不光可以对一条数据,也可以对一个QuerySet所对应的结果集


例如:

用户表 UserModel:

#models.py
from django.db import models# Create your models here.
class UserModel(models.Model):name = models.CharField(max_length=50)phone = models.CharField(max_length=11)password = models.CharField(max_length=30)info = models.CharField(max_length=100, null=True)def __str__(self):return self.nameclass Meta:db_table = 'user'

普通序列化器UserSerializer定义如下:

#userSerializer.py
class UserSerializer(serializers.Serializer):name = serializers.CharField(max_length=50)phone = serializers.CharField(validators=[validators_phone])password = serializers.CharField(max_length=30)info = serializers.CharField(max_length=100,default="默认值")

序列化器的使用分两个阶段:
1、在客户端请求时,使用序列化器可以完成对数据的反序列化(将字典格式的数据转化为模型对象)。
2、在服务器响应时,使用序列化器可以完成对数据的序列化(将模型对象转化为字典格式的数据)。


2. 普通序列化器序列化

序列化就是将ORM数据放入序列化器加工,诞生出JSON数据对象,序列化器对象的data属性即为处理好的 JSON 数据对象

1、单条数据的序列化:

  • 单挑数据的序列化很简单,直接通过序列化器类对象的参数instance传入查询得到的结果即可
#views.py
class UserIdView(APIView):def get(self, request, id):user = UserModel.objects.get(pk=id)usSer = UserSerializer(instance=user)return Response({"message": "get测试成功!", "data": usSer.data})

2、多条数据的序列化:

  • 如果使用像filterall这样的一些ORM方法,获取到的是QuerySet结果集,不是单独数据对象,那么使用序列化器时,需要传入many=True参数,用来表示:传入的不止一条数据。
#views.py
class UserView(APIView):def get(self, request):users = UserModel.objects.all()usSer = UserSerializer(instance=users, many=True)return Response({"message":"get测试成功!","data":usSer.data})

Serializer属性中选项参数

选项参数名称作用
max_length最大长度
min_length最小长度
allow_blank是否允许为空
trim_whitespace是否截断空白字符
max_value最大值
min_value最小值
通用参数名称作用
read_only该字段仅用于序列化输出,需要序列化输出时设置:read_only=True;默认为False
write_only该字段仅用于反序列输入,需要序列化输入时设置:write_only=True;默认为False
required该字段表示在反序列化输入时必须输入
default反序列化时使用的默认值
allow_null表明该字段是否允许传入None,默认False
validators对字段进行校验,定义在字段中
error_message当字段校验不通过时,报error_message的value值
label用于HTML展示API页面时,显示的字段名称
help_text用于HTML展示API页面时,显示的字段帮助提示信息

3. 普通序列化器反序列化创建

反序列化的概念很简单,就是把JSON等数据变为ORM数据对象,甚至是入库或者是修改

DRF要求序列化器必须对数据进行校验,才能获取验证成功的数据或保存成模型类对象


  1. 在操作过程中,反序列化首先需要通过data 传参
  2. 接着调用is_valid进行校验,验证成功返回True,反之返回False
    • 如果校验失败,还可以通过结果的errors 属性返回错误值
    • is_valid调用后方法会进行字段属性(max_value=10)的校验、自定义的校验等等
  3. 对校验过后的对象调用save方法,这个save方法会触发序列化器中的create方法
    • 普通序列化器中create方法默认是没有实现的,需要手动根据模型类进行编写

如果需要自定义校验规则,可以通过validators实现:

#userSerializer.py
from rest_framework import serializers
from app.models import UserModel
import redef validators_phone(values):r_phone = r"^1[3-9]\d{9}$"if re.match(r_phone, values):print("手机号匹配成功!")else:print("手机号匹配失败,抛出异常!")raise serializers.ValidationError("手机号匹配失败!不满足规则!")class UserSerializer(serializers.Serializer):name = serializers.CharField(max_length=50)phone = serializers.CharField(validators=[validators_phone])password = serializers.CharField(max_length=30)info = serializers.CharField(max_length=100,default="默认值")

比如现在,需要提交数据用到创建User的接口,此时可以这么做
为了能够保证数据成功入库,默认的普通序列化器是不具备入库功能的,需要编写create方法

#userSerializer.py
class UserSerializer(serializers.Serializer):name = serializers.CharField(max_length=50)phone = serializers.CharField(validators=[validators_phone])password = serializers.CharField(max_length=30)info = serializers.CharField(max_length=100,default="默认值")def create(self, validated_data):object = UserModel.objects.create(**validated_data)return object#具体来说,**validated_data的作用是:解包字典。
#它将validated_data字典中的键值对解包为一系列的关键字参数。

成功之后,就可以通过像之前一样的数据提交,编写视图完成数据入库,序列化器可以直接处理request所提交的数据data,并且可以剔除在request.data中其他多余的字段,只会处理序列化器里的字段

# views.py
class UserView(APIView):def post(self, request):ser = UserSerializer(data=request.data) # 传参data,进行反序列化if ser.is_valid():print("校验成功!")ser.save()return Response({"message":"[POST]信息添加成功!"})else:print("校验失败!")return Response({"message": ser.errors})

4. 普通序列化器反序列化更新

反序列化经过校验的数据,不光可以用来创建数据,还可以用来更新数据

  • 更新首先需要一个已经存在的数据,所以需要通过instance参数传递已有的一个ORM对象
  • 还需要待更新的新值,那么就需要传data参数
  • 之后同样需要is_valid方法调用,检查即将更新进入的数据是否合法
  • 最终save触发序列化器中的update方法

默认普通序列化器是没有自带对于数据的更新方法的,现在需要在序列化器里创建update方法

# userSerializer.py
class UserSerializer(serializers.Serializer):name = serializers.CharField(max_length=50)phone = serializers.CharField(validators=[validators_phone])password = serializers.CharField(max_length=30)info = serializers.CharField(max_length=100,default="默认值")def update(self, instance, validated_data):# instance 要更新的数据,validated_data 是新数据instance.name = validated_data.get('name', instance.name)instance.phone = validated_data.get('phone', instance.phone)instance.password = validated_data.get('password', instance.password)instance.info = validated_data.get('info', instance.info)instance.save()return instance#获取字段值:
#validated_data.get('name') 尝试从 validated_data 字典中获取键为 'name' 的值。
#validated_data 是由序列化器在验证请求数据后生成的一个字典,它包含了经过验证的字段和它们的值。#默认值机制:
#get 方法有一个可选的第二个参数,即默认值。如果 'name' 这个键不存在于validated_data 中,get 方法将返回这个默认值。
#在这个例子中,如果请求数据中没有包含 'name' 字段,那么默认值就是 instance.name,即当前模型实例的 name 字段的值。

然后通过PUT传递要更新数据的ID,以及更新后的值,来为某条数据更新

class UserIdView(APIView):def put(self, request, id):user = UserModel.objects.get(pk=id)ser = UserSerializer(instance=user, data=request.data)if ser.is_valid():print("校验成功!")ser.save()return Response({"message": "[PUT]信息修改成功!"})else:print("校验失败!")return Response({"message": ser.errors})

5. 普通序列化器完整代码

models.py:

from django.db import models# Create your models here.
class UserModel(models.Model):name = models.CharField(max_length=50)phone = models.CharField(max_length=11)password = models.CharField(max_length=30)info = models.CharField(max_length=100, null=True)def __str__(self):return self.nameclass Meta:db_table = 'user'

userSerializer.py:

from rest_framework import serializers
from app.models import UserModel
import redef validators_phone(values):r_phone = r"^1[3-9]\d{9}$"if re.match(r_phone, values):print("手机号匹配成功!")else:print("手机号匹配失败,抛出异常!")raise serializers.ValidationError("手机号匹配失败!不满足规则!")class UserSerializer(serializers.Serializer):name = serializers.CharField(max_length=50)phone = serializers.CharField(validators=[validators_phone])password = serializers.CharField(max_length=30)info = serializers.CharField(max_length=100,default="默认值")def create(self, validated_data):object = UserModel.objects.create(**validated_data)return objectdef update(self, instance, validated_data):# instance 要更新的数据,validated_data 是新数据instance.name = validated_data.get('name', instance.name)instance.phone = validated_data.get('phone', instance.phone)instance.password = validated_data.get('password', instance.password)instance.info = validated_data.get('info', instance.info)instance.save()return instance

views.py:

from rest_framework.views import APIView
from rest_framework.response import Response
from app.models import UserModel
from app.serializer.userSerializer import UserSerializer
from django.shortcuts import render# Create your views here.class UserView(APIView):def get(self, request):users = UserModel.objects.all()usSer = UserSerializer(instance=users, many=True)return Response({"message":"get测试成功!","data":usSer.data})def post(self, request):ser = UserSerializer(data=request.data) # 传参data,进行反序列化if ser.is_valid():print("校验成功!")ser.save()return Response({"message":"[POST]信息添加成功!"})else:print("校验失败!")return Response({"message": ser.errors})class UserIdView(APIView):def get(self, request, id):user = UserModel.objects.get(pk=id)usSer = UserSerializer(instance=user)return Response({"message": "get测试成功!", "data": usSer.data})def put(self, request, id):user = UserModel.objects.get(pk=id)ser = UserSerializer(instance=user, data=request.data)if ser.is_valid():print("校验成功!")ser.save()return Response({"message": "[PUT]信息修改成功!"})else:print("校验失败!")return Response({"message": ser.errors})

urls.py:

from django.urls import path
from app.views import UserView,UserIdViewurlpatterns = [path('user/', UserView.as_view()),path('user/<int:id>/', UserIdView.as_view()),
]

二、模型序列化器-ModelSerializer

1. 模型序列化器编写方式

之前的普通序列化器,很明显可以感觉到,如果模型类字段少了,还行,但是模型字段越来越多,那么开发者序列化器里所要复刻的字段也要越来越多,很麻烦, 而且还得手动实现updatecreate方法,而且光写了序列化器字段还不行,还得有字段属性

于是乎,有了现在的与模型类关联的序列化器,可以更加方便的进行字段映射以及内置方法的编写


模型类关联序列化器大概总结有如下三个特性,一个缺点:

  • 特点:
    • 基于模型类自动生成一系列字段
    • 自动生成的系列字段,同时还包含uniquemax_length等属性校验
    • 包含默认的createupdate的实现
  • 缺点:
    • 不会自动映射模型类字段的default属性

模型类关联序列化器用的是新的序列化器基类

from rest_framework.serializers import ModelSerializer

用户模型类依旧使用上文中的UserModel.py文件

按照之前的普通序列化写法,你需要同步一个字段,并将字段属性也要记得同步,非常麻烦,但通过与模型类关联的序列化器就很简单了。

  1. 首先通过继承ModelSerializer基类
  2. 通过序列化器元类属性中的model属性关联模型类
  3. 通过序列化器元类属性中的fields属性指明序列化器需要处理的字段
# userModelSerializer.py
from rest_framework import serializers
from app.models import UserModelclass UserModelSerializer(serializers.ModelSerializer):# 不需要再重写 create 和 update 方法了,可查看ModelSerializer源码class Meta:model = UserModelfields = '__all__' # 指明所有模型类字段# exclude = ('password',) # 排除掉的字段# read_only_fields = ('name','info') # 只用于序列化的字段# fields = ('name','phone','password','info')# extra_kwargs = {#     'info':{'min_length':5, 'required':True},# } #修改原有字段的选项参数

模型类关联的序列化器和普通的序列化器使用方法一样,使用序列化器返回当前所有的商品数据,还是像之前一样传入instance参数即可,还要记得由于是多个商品,不是单独数据,要记得加many=True参数

2. 模型序列化器反序列化创建、更新

模型序列化器的创建就更简单了,不需要手动实现create方法,大致流程如下:

  1. 为序列化器绑定数据ser=Serializer(data=request.data)
  2. 校验数据,ser.is_valid()
  3. 存储入库,ser.save()

创建用户接口:

from rest_framework.views import APIView
from rest_framework.response import Response
from app.models import UserModel
from app.serializer.userModelSerializer import UserModelSerializer# Create your views here.class UserView(APIView):def get(self, request):users = UserModel.objects.all()usSer = UserModelSerializer(instance=users, many=True)return Response({"message":"get测试成功!","data":usSer.data})def post(self, request):ser = UserModelSerializer(data=request.data) # 传参data,进行反序列化if ser.is_valid():print("校验成功!")ser.save()return Response({"message":"[POST]信息添加成功!"})else:print("校验失败!")return Response({"message": ser.errors})

注意: 反序列化自动生成的字段属性中,不会包含原始模型类字段中的default字段属性


更细用户信息接口:
更新某一个商品数据,模型序列化器也是自带了update方法

class UserIdView(APIView):def get(self, request, id):user = UserModel.objects.get(pk=id)usSer = UserModelSerializer(instance=user)return Response({"message": "get测试成功!", "data": usSer.data})def put(self, request, id):user = UserModel.objects.get(pk=id)ser = UserModelSerializer(instance=user, data=request.data)if ser.is_valid():print("校验成功!")ser.save()return Response({"message": "[PUT]信息修改成功!"})else:print("校验失败!")return Response({"message": ser.errors})

3. 模型序列化器与普通序列化器的对比

  • 序列化时,将模型类对象传入instance参数
    • 序列化结果使用序列化器对象的data属性获取得到
  • 反序列化创建时,将要被反序列化的数据传入data参数
    • 反序列化一定要记得先使用is_valid校验
  • 反序列化更新时,将要更新的数据对象传入instance参数,更新后的数据传入data参数
  • 模型序列化器普通序列化器更加方便,自动生成序列化映射字段,createupdate方法等
  • 关联外键序列化,字段属性外键为时要记得加many=True

在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/bicheng/28791.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【unity笔记】二、海洋系统Crest Ocean System基础

1. 创建海平面 首先确定项目中导入了HDRP插件。这里使用Crest Ocean System HDRP插件。 在场景下创建空对象&#xff0c;这里命名为Ocean。将 OceanRenderer 组件分配给Ocean。该组件将生成海洋几何图形并执行所有必需的初始化。其中Global Wind Speed 属性可以调节风浪大小。…

vuedraggable在vue2.0和vue3.0 中的应用

文章目录 vuedraggable在vue2.0中的应用在vue3.0中的应用 vuedraggable Vue.Draggable是一款基于Sortable.js实现的vue拖拽插件。支持移动设备、拖拽和选择文本、智能滚动&#xff0c;可以在不同列表间拖拽、不依赖jQuery为基础、vue 2过渡动画兼容、支持撤销操作&#xff0c;…

部署远程控制台访问服务Rttys,第一部分客户端(安装CMAKE)

背景&#xff1a;现公司有一需求&#xff0c;需要开发一个程序&#xff0c;实现页面点击按钮后跳转&#xff0c;远程连接到指定的虚拟机&#xff0c;并可以进行linux命令操作&#xff0c;在网上找了很多文章&#xff0c;发现都没有详细的步骤和部署问题处理&#xff0c;所以自己…

Web渗透信息收集进阶

网站敏感目录与文件 网站敏感目录表示网站目录中容易被恶意人员利用的一些目录。通常恶意人员都是通过工具扫描&#xff0c;来扫出网站的敏感目录&#xff0c;敏感目录是能够得到其他网页的信息&#xff0c;从而找到后台管理页面&#xff0c;尝试进入后台等&#xff0c;扫描网…

33、matlab矩阵分解汇总:LU矩阵分解、Cholesky分解、QR分解和SVD分解

1、矩阵分解简介 矩阵分解是指将一个矩阵分解成子矩阵或其他形式的矩阵表示的过程。常见的矩阵分解方法包括LU分解、QR分解、奇异值分解&#xff08;SVD&#xff09;、特征值分解等。 LU分解&#xff1a;将一个矩阵分解为一个下三角矩阵L和一个上三角矩阵U的乘积&#xff0c;…

淘宝评论电商API接口,揭示用户真实评价

随着互联网的快速发展&#xff0c;电子商务已经成为了人们生活中不可或缺的一部分。淘宝作为中国最大的在线购物平台&#xff0c;拥有数以亿计的消费者和商家。而用户评价作为消费者了解商品和服务的重要途径&#xff0c;对于商家的信誉和销售有着至关重要的影响。因此&#xf…

PMP证书有何用?

PMP证书有何用&#xff1f; PMP项目管理专业人士资格认证证书对从事或希望从事项目管理工作的人员有重要意义&#xff0c;具体体现在以下几个方面&#xff1a; 1. 提供职业机会&#xff1a; PMP是项目管理领域的国际认可标准&#xff0c;拥有该证书的人在求职时具备了更强的…

【node】同步获取盘符名

功能 获取电脑所有磁盘的盘符名字&#xff0c;并返回数组 代码 var showLetter2 function () {//返回所有盘符&#xff0c;同步var arr;var { execSync } require(node:child_process);//获取模块var str execSync(wmic logicaldisk get caption).toString();//将返回的变…

goframe目录文件解析

goframe 目录分块 ├─api ├─hack ├─internal │ ├─cmd │ ├─consts │ ├─controller │ ├─dao │ ├─logic │ ├─model │ │ ├─do │ │ └─entity │ ├─packed │ └─service ├─manifest │ ├─config │ ├─deploy │ │ └─kustomize │ │ ├…

LabVIEW伺服电机可应用在哪些领域

LabVIEW与伺服电机的结合&#xff0c;得益于LabVIEW强大的图形编程能力和伺服电机的高精度、高响应速度&#xff0c;广泛应用于多个领域。以下是一些主要应用领域&#xff1a; 1. 工业自动化 数控机床控制 LabVIEW用于控制伺服电机在数控机床中的运动&#xff0c;实现高精度的…

【CSS】background-origin作用是什么,怎么使用

background-origin属性在CSS中用于设置背景图片的定位区域&#xff0c;即决定背景图片从哪里开始定位。它有三个主要的属性值&#xff0c;分别表示背景图片相对于不同元素区域的定位起点&#xff1a; 属性值及意义&#xff1a; padding-box&#xff1a;背景图片相对于内边距框&…

JAVA小知识20:万字详解List与ArrayList

一、集合简介 1.1、什么是集合&#xff1f; 可同时存储多个元素的数据结构就是集合。 1.2、为什么要有集合&#xff1f; 我们可以使用数组同时存储多个元素&#xff0c;但是数组有个弊端。数组创建之后长度就会固定&#xff0c;如需扩容则需要手动扩容&#xff0c;我们需要…

图像的对比度和亮度

目标 访问像素值用0来初始化矩阵cv::saturate_cast像素转换提高一张图像的亮度 原理 图像处理 图像变换可以被视作两个步骤&#xff1a; 点操纵&#xff08;像素转换&#xff09;相邻区域转换&#xff08;以面积为基础&#xff09; 像素转换 在这种图像处理的转换过程中…

oracle发送邮件附件的步骤?怎么配置发信?

oracle发送邮件附件的操作指南&#xff1f;Oracle邮件服务如何&#xff1f; 在Oracle数据库中&#xff0c;发送电子邮件附件是一项常见的任务&#xff0c;特别是在需要自动化通知或报表分发的情况下。AokSend将介绍如何使用Oracle数据库发送带有附件的电子邮件。以下是详细的步…

智能呼叫中心服务的三个时代呼叫系统升级

在不同的时代发展背景下对智能服务的诉求和认知都是不同的&#xff0c;相应的每个时代认知下的系统和运营也是不同的&#xff0c;唯有认知、系统、运营相结合才能构造出智能时代。 1、智能时代 1.0 在智能服务的 1.0 时代我们将智能服务定义为自助服务工具&#xff0c;传统的服…

iOS KeychainAccess的了解与使用

KeychainAccess 是一个用于 iOS、macOS、tvOS 和 watchOS 上的 Swift 密钥链访问库。它提供了一个简单且安全的 API,用于在设备的密钥链中存储和检索数据。 KeychainAccess 的一些主要特点包括: 简单易用的 API&#xff1a;该库提供了一个直观的 API,可以轻松地将数据存储和检…

RTSP/Onvif安防监控平台EasyNVR抓包命令tcpdump使用不了,该如何解决?

安防视频监控汇聚EasyNVR智能安防视频监控平台&#xff0c;是基于RTSP/Onvif协议的安防视频平台&#xff0c;可支持将接入的视频流进行全平台、全终端分发&#xff0c;分发的视频流包括RTSP、RTMP、HTTP-FLV、WS-FLV、HLS、WebRTC等格式。平台可提供的视频能力包括&#xff1a;…

实现虚拟机的难点

一、背景 目前的虚拟机有很多&#xff0c;例如VMWare、VitrualBox、QEMU、JVM、Python虚拟机等等。 二、虚拟机的作用 在一台已有的计算机中&#xff0c;忽略实际操作系统种类和硬件的型号&#xff0c;用一些接口库来搭建一台用户想要的&#xff0c;虚拟的程序运行环境。 例如…

LVS负载均衡集群企业级应用实战-LVS-DR(四)

目录 LVS-DR 一. 环境准备 二. 对虚拟主机操作 三. 对真实服务器操作 四. 打开网页测试 LVS-DR 一. 环境准备 三台虚拟机&#xff0c;都要在同一网段内&#xff0c;统一关闭防火墙和selinux&#xff0c;时间同步&#xff0c;配置好YUM源。系统用centos和roucky都行。 主…

vue3+vant4中表单内嵌picker的默认值设置

vue3vant4中表单内嵌picker的默认值设置 头一次用vant就在表单默认值上费劲了&#xff0c;搞下来代码量比antd系列的代码量大。废话不说&#xff0c;直接上代码&#xff0c;将这三段代码直接复制到一个组件中即可看到效果。早上5点多就起来捣鼓这玩意&#xff0c;上午以为完成…