一、序列化组件介绍
基于原生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