首页 > 其他分享 >drf-序列化组件

drf-序列化组件

时间:2023-08-30 19:00:16浏览次数:38  
标签:None False min max length 组件 序列化 drf

一、序列化组件介绍

  基于原生django写接口:json格式数据要自己序列化,urlencoded:传过来的数据要用for循环来取出值,在定义成字典的形式,比较麻烦。

借助于drf提供的序列化组件来完成快速序列化

使用步骤:

1 先在配置文件中注册 :

    INSTALLED_APPS = [

      'rest_framework',

    ]

2. 写一个序列化类:新建一个py文件(serializer.py)

Django REST framework中的Serializer使用类来定义,须继承自rest_framework.serializers.Serializer。

  -继承drf提供的serializers.Serializer
  -在类中写要序列化的字段:字段类---》跟之前学过的models.py中的字段类完全对应,但是比models多

Serializer:序列化器

作用:

1. 序列化,序列化器会把模型对象转换成字典,经过response以后变成json字符串
2. 反序列化,把客户端发送过来的数据,经过request以后变成字典,序列化器可以把字典转成模型
3. 反序列化,完成数据校验功能

3. 在视图函数中,使用序列化类

  多条:serializer=UserSerializer(instance=users,many=True)

  单条:serializer=UserSerializer(instance=user)

4. 拿到序列化后的数据

  serializer.data  可能是列表(多条),可能是字典(单条)

5.使用drf提供的Response 返回

  from rest_framework.response import Response

二、序列化组件快速使用之序列化

1. 路由

  urlpatterns = [

   path('users/',UserView.as_view()),

  path('users/<int:pk>',UserDetailView.as_view()),

  ]

2. 视图类

from .models import User
from .serializer import UserSerializer
from rest_framework.response import Response
class UserView(APIView):
    def get(self,request):
        users=User.objects.all()
        # 之前用for循环,现在用序列化类
        # 传了两个参数:instance 要序列化的对象(qs,单个对象)many=True表示序列化多条,如果不写就是序列化一条           
        ser=UserSerializer(instance=users,many=True)
        # 拿到序列化后的数据  ser.data--->多条就是列表  单条字典           
        return Response(ser.data)
class UserDetailView(APIView):
    def get(self,request,pk):       
        user=User.objects.all().filter(pk=pk).first()
        # 传了两个参数:instance 要序列化的对象   many=True表示序列化多条        
       ser=UserSerializer(instance=user)
       return Response(ser.data)            

 3. 序列化类

写序列化类

from rest_framework import serializers

# 继承drf提供的serializers.Serializer
class UserSerializer(serializers.Serializer):
    # 写要序列化的字段
    name = serializers.CharField()
    # hobby = serializers.CharField()
    # password=serializers.CharField()
    age=serializers.IntegerField()

三、常用字段类和参数

1. 常用字段类

写序列化类的时候,写了CharField,IntegerField 跟django中的models中类似

序列化类中的和models中的一一对应,但是序列化中多一些(ListField、DictField)

常用字段类型:

字段字段构造方式
BooleanField BooleanField()
NullBooleanField NullBooleanField()
CharField CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)
EmailField EmailField(max_length=None, min_length=None, allow_blank=False)
RegexField RegexField(regex, max_length=None, min_length=None, allow_blank=False)
SlugField SlugField(maxlength=50, min_length=None, allow_blank=False) 正则字段,验证正则模式 [a-zA-Z0-9-]+
URLField URLField(max_length=200, min_length=None, allow_blank=False)
UUIDField UUIDField(format=’hex_verbose’) format: 1) 'hex_verbose' 如"5ce0e9a5-5ffa-654b-cee0-1238041fb31a" 2) 'hex' 如 "5ce0e9a55ffa654bcee01238041fb31a" 3)'int' - 如: "123456789012312313134124512351145145114" 4)'urn' 如: "urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a"
IPAddressField IPAddressField(protocol=’both’, unpack_ipv4=False, **options)
IntegerField IntegerField(max_value=None, min_value=None)
FloatField FloatField(max_value=None, min_value=None)
DecimalField DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) max_digits: 最多位数 decimal_palces: 小数点位置
DateTimeField DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)
DateField DateField(format=api_settings.DATE_FORMAT, input_formats=None)
TimeField TimeField(format=api_settings.TIME_FORMAT, input_formats=None)
DurationField DurationField()
ChoiceField ChoiceField(choices) choices与Django的用法相同
MultipleChoiceField MultipleChoiceField(choices)
FileField FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ImageField ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ListField ListField(child=, min_length=None, max_length=None)
DictField DictField(child=)

2. 常用字段参数

字段类上,是可以传参数,是做反序列化校验用的

所有字段都可以用通用的,非常重要:read_only,write_only,default,required,allow_null

选项参数:

参数名称作用
max_length 最大长度
min_lenght 最小长度
allow_blank 是否允许为空
trim_whitespace 是否截断空白字符
max_value 最小值
min_value 最大值

通用参数:

参数名称说明
read_only 表明该字段仅用于序列化输出,默认False
write_only 表明该字段仅用于反序列化输入,默认False
required 表明该字段在反序列化时必须输入,默认True
default 反序列化时使用的默认值
allow_null 表明该字段是否允许传入None,默认False
validators 该字段使用的验证器
error_messages 包含错误编号与错误信息的字典
label 用于HTML展示API页面时,显示的字段名称
help_text 用于HTML展示API页面时,显示的字段帮助提示信息

三、序列化组件之校验

序列化组件:

  1. 序列化,序列化器会把模型对象转换成字典,经过response以后变成json字符串

  2. 反序列化,把客户端发送过来的数据,经过request以后变成字典,序列化器可以把字典转成模型

  3. 反序列化,完成数据校验功能

反序列化之校验:

xxx.is_valid()

  1. 字段自己的校验规则(字段类的属性上)

  2. 局部钩子(给某个字段加校验规则)

  3. 全局钩子

反序列化保存

xx.save():

  必须序列化类中重写create,自己看保存到哪个表

def create(self, validated_data):  # validated_data:前端传入,校验过后的数据
    user = User.objects.create(**validated_data)
    return user

 

标签:None,False,min,max,length,组件,序列化,drf
From: https://www.cnblogs.com/Lucky-Hua/p/17668035.html

相关文章

  • drf-day3
    内容回顾1、前端编码格式urlencoded:body体中:username=lqz&password=123 django 的request.POST取出值json格式:body体中:{"username":"lqz","password":"123"} django 的request.POST取不出值,从request.body-->自己做反序列化form-data:body中......
  • vue菜单组件中图标跟随菜单高亮变化颜色
    问题在vue左侧菜单中,使用设计师的svg图标有时候不能跟随菜单高亮而改变颜色未高亮时显示灰色菜单高亮时图标显示白色原因svg中图标的颜色设计师给了固定的颜色,所以不会接收父元素给定的颜色解决给svg图标的颜色属性为currentColor......
  • 智能界面组件DevExpress BI Dashboard — 新的导出功能(v23.1)
    在DevExpressv23.1发布周期中,官方扩展了DevExpressBIDashboard项的导出功能,这些增强功能适用于WinForms、WPF和Web平台,包括以下选项:将自定义Dashboard项导出到Excel并自定义导出的文档本身在导出期间自定义PivotGridDashboard项DevExpressv23.1正式版下载DevExpress技......
  • Bugku-web35(序列化)
    访问css样式之后得到提示:扒下代码::<?phperror_reporting(0);$KEY='ctf.bugku.com';include_once("flag.php");$cookie = $_COOKIE['BUGKU'];if(isset($_GET['20260'])){    show_source(__FILE__);}elseif (unserialize($cookie) ......
  • Bugku-web安慰奖(序列化)
    php序列化的一个题目;;参考博客:https://blog.csdn.net/weixin_44190459/article/details/116648636目前还没有搞明白怎么一回事:<?phpclassctf{protected$username='admin';protected$cmd='tacflag.php';}$ctf=newctf();echoserialize($ctf);;?>......
  • Python drf day02
    restful规范restful规范是什么,如何来的?是一种定义WebAPI接口的设计风格,尤其适用于前后端分离的应用模式中的规范RoyFielding的博士论文提出的restful规范的具体内容1.数据的安全保障--》url链接一般都采用https协议进行传输,它比http安全2.接口特征表现--》url中带api......
  • drf-restful规范
    RESTfulAPI规范简介: REST全称是RepresentationalStateTransfer,中文意思是表述(编者注:通常译为表征性状态转移)。它首次出现在2000年RoyFielding的博士论文中。""" RESTful是一种定义WebAPI接口的设计风格,尤其适用于前后端分离的应用模式中。"""这种风格的理念认为后端......
  • drf入门
    drf入门规范1、Web开发模式​ 1.1、前后端混合开发模式:​ 1.2、前后端分离开发模式2、API接口#api接口:通过网络,规定了前后端信息交互规则的url链接,也就是前后端信息交互的媒介 -https://www.baidu.com/books/--->json格式数据--->接口#拿到的是json格式的数据 -https......
  • 小程序组件使用
    在小程序中,父子组件之间可以通过属性和事件来进行数据的传递。使用属性传递数据:父组件可以通过在子组件的标签上绑定属性,将数据传递给子组件。子组件可以在组件的properties属性中定义接收父组件传递的属性,并在组件内部使用。父组件通过改变绑定的属性的值,可以实现向子组......
  • RESTful API规范,序列化,Django Rest_Framework
    一.RESTfulAPI规范REST全称是RepresentationalStateTransfer,中文意思是表述(编者注:通常译为表征性状态转移)。它首次出现在2000年RoyFielding的博士论文中。RESTful是一种定义WebAPI接口的设计风格,尤其适用于前后端分离的应用模式中。这种风格的理念认为后端开发任......