1. 序列化器的作用
就是数据和模型类对象之间的转换(即
data<---->model
之间的转化),数据是前端传过来的数据,转换为模型类对象之后,才可以使用rest
框架保存到数据库。将数据查询出来的是模型对象,只有转化为一定的格式,比如json
格式之后,才可以返回给前端。
DRF
的序列化:就是把后端的models
对象通过DRF
序列化处理,变成前端能识别的数据DRF
的反序列化:就是前端的提交的数据通过DRF
的反序列化,进行对数据的校验,之后变成models
对象保存到数据库
在开发REST API
接口时,视图中做的最主要有三件事:
- 将请求的数据(如
JSON
格式)转化我模型类对象——反序列化 - 操作数据库
- 将模型类对象转化为响应的数据(如
JSON
格式)——序列化
在开发REST API
接口时,我们在视图中需要做的最核心的事是:
- 将数据库数据序列化为前端所需要的的格式,并返回;
- 将前端发送的数据反序列化为模型类对象,并保存到数据库中。
总之,序列化器就是一个中转站,主要进行对数据的转换,和对数据的校验(比如,前端传过来的数据格式正确之后,才能保存到数据库)。
2. DRF提供的序列化器
rest
框架提供的每一个类都可以实现序列化和反序列化。
2.1 Serializer类
Serializer
类是底层序列化类,高级的序列化类的底层功能是由它实现的。- 针对单表,多表的单查群查和单增单改操作。
- 在使用
Serializer
类时,反序列化中的插入和更新数据库操作都要自己重写父类的create
和update
方法。
2.2 ModelSerializer类
- ModelSerializer类是高级的序列化类,完成针对单表、多表的单查群查和单增单改操作序列化和反序列化。
- 在使用ModelSerializer类时,反序列化中的插入和更新数据库操作不需要重写
create
和update
方法。
2.3 ListSerializer类
- ListSerializer类是群操作序列化类,辅助完成单表、多表的群增和群改操作。
2.4 ModelSerializer和Serializer的区别
ModelSerializer
序列化器就是在基类Serializer
上面封装了一个,总之,以后使用ModelSerializer
就可以了。
ModelSerializer
与常规的Serializer
相同,但提供了:
- 基于模型类自动生成一系列字段
- 包含默认的
create()
和update()
的实现 - 基于模型类自动为
Serializer
生成validators
,比如unique_together
3. DRF的序列化和反序列化的使用方法
在对应的app
下,新建一个专门用来处理序列化和反序列化的py
文件,通过导入DRF
的序列化类,让自定义的类继承序列化类中的一个类即可。其实DRF
的序列化和反序列化和django
的forms
组件的用法差不多。
# serializer.py
from snippetsapp.models import Snippet
class SnippetSerializer(serializer.ModelSerializer):
class Meta:
model = Snippet
fields = ('id', 'url', 'title', 'code', 'lineons', 'owner', 'highlighted')
read_only_fields = ('owner', 'highlighted')
因为序列化家族中的Serializer
类封装程度没有ModelSerializer
类完全,所以ModelSerializer
类使用起来更佳的友好、简便。
3.1 序列化的使用——序列化类文件的写法
3.1 .1 继承基类Serializer的序列化器
如果类继承的是Serializer
,也就是继承了基类,那这个序列化器的写法就是和model
里面差不多,格式如下:
# bookInfoSerializer.py
class BookInfoSerializer(serializers.Serilizer):
'''图书数据序列化器'''
id = serializers.IntegerFiled(label='ID', read_only=True)
btitle = serializers.CharField(label='名称', max_length=20, validators=[about_django])
bpub_date = serializers.DateField(label='发布日期', required=True)
bread = serializers.IntegerField(label='阅读量', required=False)
bcomment = serializers.IntegerField(label='评论量', required=False)
image = serializers.ImageField(label='图片', required=False)
heroinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)
序列化器中的字段不一定和model
里面的字段个数一样,可多可少。返回多少字段是根据序列化器中的规定的。
3.1.2 继承ModelSerializer的序列化器
如果是继承了ModelSerializer
,写法就变成如下格式:
#SnippetSerializer.py
from rest_framework import serializers
from .models import Snippet
class SnoppetSerializer(serilizers.ModelSerializer):
class Meta:
model = Snippet # model:指明该序列化器处理字段从模型类Snipppet参考生成
fileds = '__all__' # fields:指明该序列化器包含模型类中的哪些字段,'__all__'代表包含所有字段
depth = 2 # depth:指明序列化递归深度
read_only_fields = ('id') # read_only_fields:指明只读字段
3.2 反序列化的使用
在view
里面写逻辑的时候,比如我们将查询出来的数据,要返回给前端,那么就需要序列化查询出来的数据,在此就需要使用序列化器,使用方法如下:
# 如果直接给instance形参传递参数展示做序列化
serializer = BookInfoSerializer(instance = book)
serializer.data # 获取到序列化后的数据
如果前端传过来数据,进行反序列化应该怎么处理,将instance
这个属性变成data
属性就行,就是属性不一样,其他的都一样。
具体源码如下:
# Serializer的构造方法为:
Serializer(instance = None, data = empty, **kwargs)
使用方法总结如下:
- 用于序列化时:
- 将模型类对象传入
instance
参数- 模型
- 查询集
- 字典
Serializer(book)
- 序列化 == 模型数据 -->
python
字典(用于输出,返回数据给前端)
- 将模型类对象传入
- 用于反序列化时:
Serializer(data = data)
- 将要反序列化的数据传入
data
参数 - 反序列化 == 前端发送的数据–> 数据校验–>
python
字典–>save
–> 入库
将查询出来的数据返回给前端,有可能查询出多条数据,处理方法如下:
book_data = serializers.BookModelSerializer(book_obj).data # 单条数据序列化
book_data = serializers.BookModeSerializer(book_query, many=True).data
# 不管是一条还是多条,只要数据是被[]嵌套,都要写many=True
3.2.1 反序列化view
里面的格式
data = {
'btitle': '三国',
'bpub_date': '1991-11-11'
}
serializer = BookInfoSerializer(data = data)
serializer.is_valid() # 调用序列化器的校验方法 True或False
serializer.is_valid(raise_exception=True) # raise_exception=True如果多指定这个,将来校验出错后,会自动抛出错误信息
serializer.errors # 获取校验的错误信息
serializer.validate_data # 获取反序列化校验后的数据还是字典
3.2.2 反序列化追加校验逻辑
反序列化首先要对前端传过来的数据进行校验,但是REST
框架给的校验的属性不够,我们可以定义自己的校验逻辑,比如,我们要校验前端传给后端的name
字段里面有没有非法字符,处理逻辑如下:
class BookModelDeserializer(ModelSerializer):
#一些只参与反序列化的字段,但是不是与数据库关联的,自定义不入库的反序列化的字段
# re_name = seializers.CharField(write_only=True)
class Meta:
model = models.Book
fields = ('name', 'price', 'publish', 'authors') #没有默认值的字段必须序列化,为其传值
# extra_kwargs 用来完成反序列化字段的 系统校验规则
extra_kwargs = {
'name': {
'required': True, #设置name字段必填
'min_length': 1,
'error_messages': {
'required': '必填项',
'min_length': '太短',
}
}
}
# 以下就是自定义的校验规则
# 局部钩子校验单个字段 validate_字段名
def validate_name(self, value): #value是字段name的值
# 书名不能包含 g 字符
if 'g' in value.lower():
raise ValidationError('该g书不能出版')
return value
# 全局钩子 (对多个字段进行一起校验)
def validate(self, attrs):
publish = attrs.get('publish') #publish如果是外键字段,这个就是publish对象
name = attrs.get('name')
if models.Book.objects.filter(name=name, publish=publish):
raise ValidationError({'book': '该书已存在'})
return attrs
# 注意:ModelSerializer类已经帮我们实现了 create 与 update 方法,不需要写create就能创建
在序列化类中添加自定义校验规则的格式:validate_字段名
3.2.3 反序列化后的新增更新操作
# views.py
# 如果校验成功
serializer.save() # 当调用序列化器的save方法时,会执行序列化器中的create方法或者update方法
如果序列化器继承的类是Serializer,那么还必须重写create()
和update()
方法
def create(self, validated_data):
# validated_data 得来的是反序列化校验后的字典数据
'''当调用序列化器的save方法时,如果当创建序列化器对象时没有给instance传参数'''
pass
def update(self, instance, validated_data):
'''如果创建序列化器时给instance传了参数,再调用序列化器的save方法时实际会调用当前的update'''
pass
3.3 关联数据的序列化的实现
demo
:一本书的model
,书的详情的model
。我们就需要在详情model
里面有一个外键,关联书的model
,如果序列化器继承的是Serilizer
,name
在序列化的文件中的写法格式如下:
class HeroInfoSerializer(serializer.Serializer):
'''英雄数据序列化器'''
GENDER_CHOICE = (
(0, 'female'),
(1, 'male')
)
id = serializers.IntegerFiled(label='ID', read_only=True)
hname = serializers.CharField(label='名称', max_length=20)
hgender = serializers.ChoiceField(choice=GENDER_CHOICE, label='性别', required=False)
hcomment = serializers.CharField(label='描述信息', max_length=200, required=False, allow_null=True)
hbook = serializers.PrimaryKeyRelatedField(label='书籍', read_only=True)
hbook = serializers.PrimaryKeyRelatedField(label='书籍', queryset=BookInfo.objects.all())
3.4 views文件视图类的写法
# DRF序列化过程
# 视图类序列化过程
# 1)ORM操作得到数据
# 2)将数据序列化成可以返回给前端的数据格式
# 3)返回数据给前端
# DRF反序列化过程
# 视图类反序列化的过程
# 1)从请求对象中获取前端提交的数据
# 2)交给序列化类完成反序列化(数据的校验,is_validate()方法)
# 3)借助序列化类完成数据入库
# 4)返回给前端处理结果
4. Serializer类:序列化与反序列化
- 针对单表、多表的单查群查和单增单改操作
- 下面的序列化和反序列化可以写在一个类中,此时就要在字段类中加入
write_only
或者read_only
4.1 views.py
# views.py
"""
# 视图类序列化过程,就是三步
# 1)ORM操作得到数据
# 2)将数据序列化成可以返回给前台的数据
# 3)返回数据给前台
"""
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_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) # many默认是false,many的意思就是括号内传的对象是单个还是多个,多个就要把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,
})
4.2 serializers.py
在app
下新建serializers.py
文件,用来序列化和反序列化处理
# serializers.py
# 导入DRF的序列化家中的serializers类
from rest_framework import serializers
from django.conf import settings
from . import models
# 序列化操作*********************************************************
"""
1)设置序列化字段,字段名与字段类型要与处理的model类属性名对应一只(参与序列化的字段不需要设置条件,因为只是后端提供数据给前端)
2)想要给前端哪些数据,就序列化哪些数据即可,没写的字段不会参与序列化,也就不会提供给前端
3)自定义序列化字段(方法一),字段类为固定的SerializerMethodField(),字段的值由 get_自定义字段名(self, model_obj) 方法提供,所以你要手动写这个方法,并返回一个值作为自定义的字段的值(一般值都与参与序列化的model对象(model_obj)有关),自定义的序列化字段默认read_only=True,且不可修改
"""
class UserSerializer(serializers.Serializer):
# 1)字段名与字段类型要与处理的model类对应
# 2)不提供的字段,就不参与序列化给前台
# 3)可以自定义序列化字段,采用方法序列化,方法固定两个参数,第二个参数就是参与序列化的model对象
# (注意:不建议自定义字段名与模型类中的字段名重名,由get_自定义字段名方法的返回值提供字段值)
username = serializers.CharField()
# sex = serializers.IntegerField() # sex是模型类中定义为有chioce属性的字段
# 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方法实现改入库,返回入库成功的对象
"""
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
5. ModelSerializer类:序列化与反序列化
- 针对单表、多表的单查群查和单增单改操作
5.1 views.py
# views.py
from rest_framework.views import APIView
from rest_framework.response import Response
from django.conf import settings
from . import 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,
})
5.2 serializers.py
在app
下新建serializers.py
文件,用来序列化和反序列化处理。
ModelSerializer类的序列化和反序列化都在一起做,所以需要我们根据不同情况对相应的字段进行 序列化还是反序列化还是既需要序列化又需要反序列化 的限制。
# serializers.py
""" ModelSerializer类序列化与反序列化总结
1)序列化类继承ModelSerializer,所以需要在配置类Meta中进行序列化和反序列化的配置
2)model配置:绑定序列化相关的模型表
3)fields配置:采用 插拔式 设置所有参与序列化与反序列化字段
4)extra_kwargs配置(配置系统字段的校验条件、错误信息和该字段的序列化、反序列化选择):
划分系统字段为三种:只读,即只序列化(read_only)、只写,即只反序列化(write_only)、可读可写,即序列化和反序列化都有(为空就是可读又可写)
字段是否必须:required=True/False
选填字段(模型表中有默认值的字段):若在extra_kwargs进行配置,一般设置required=False(当然具体情况具体分析),前端不提供则用默认值,前端提供,则用提供的
5)自定义序列化字段:(自定义的序列化字段默认read_only=True,且不可修改)
第一种(不提倡):在序列化类中用SerializerMethodField()来实现,若是以此方法自定义了序列化字段,则必须在field中配置该字段,否则报错
第二种(提倡):在模型类中用@property来实现,可插拔
6)自定义反序列化字段:
同Serializer类,且校验条件只能在其定义时字段类的括号中设置,或是在钩子中设置,而在extra_kwargs中对其设置是无效的
自定义的反序列化字段必须设置 write_only=True
自定义的反序列化字段最后要pop出来
7)局部钩子,全局钩子都同Serializer类用法一致。(在配置类Meta外部配置钩子)
8)不需要重写create和update方法
"""
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': { # 当在settings文件中配置了国际化文字为中文后,就不需要再自己写中文的错误信息了,在前端会自动转成中文的错误信息
'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类已提供,且支持所有关系下的连表操作
5.3 models.py
# models.py
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 = 'old_boy_user'
verbose_name_plural = '用户表'
def __str__(self): # 不要在这里进行连表操作,比如admin页面可能会崩溃
return self.username
6. DRF项目结构
- project
- project:
__init__.py
-------------------初始化文件- settings.py-----------------------项目配置文件
- urls.py-----------------------------项目路由配置文件
- wsgi.py----------------------------python服务网关接口
- manage.py----------------------------命令行工具
- app1:
__init__.py
--------------------初始化文件- admin.py--------------------------用于设置当前App的后台管理功能
- app.py------------------------------app配置文件
- migrations------------------------数据库迁移文件
- models.py------------------------模型类文件
- views.py---------------------------视图层文件
- urls.py------------------------------路由配置文件
- serializers.py---------------------序列化器文件
- test.py------------------------------自动化测试的模块,用于实现单元测试
- app2:
__init__.py
--------------------初始化文件- admin.py--------------------------用于设置当前App的后台管理功能
- app.py------------------------------当前app配置文件
- migrations------------------------数据库迁移文件
- models.py------------------------模型类文件
- views.py---------------------------视图层文件
- urls.py------------------------------路由配置文件
- serializers.py---------------------序列化器文件
- test.py------------------------------自动化测试的模块,用于实现单元测试
- project:
7. 总结
7.1 序列化总结
序列化:将模型转换成JSON
数据
序列化器的类应该单独创建一个serializers.py
- 定义序列化器类(模型名/类视图名
Serializer
)继承Serializer
- 定义序列化器中的字段参照模型(序列化器中的字段可以比模型多或少,如果表示是模型中的字段,在序列化器中这个字段名应该和模型中字段名一致)
- 如果在多里面关联序列化一(外键),如果是在一里面关联序列化多(多的一方模型名小写
_set
) - 如果在一的一方关联序列化多时,需要指定关联字段
many=True
- 将要序列化模型或查询集传给序列化器的
instance
参数,如果传的是多个查询集,指定many=True
- 获取序列化后的数据,序列化对象
.data
属性
7.2 反序列化总结
反序列化:拿到前端传入的数据–>序列化器的data
–>调用序列化器的.is_valid()
方法进行数据校验–>调用序列化器的.save()
方法
- 获取前端传入的
JSON
字典数据 - 创建序列化器,给序列化器的data参数传参(要以关键字方式传递)
- 调用序列化器的
.is_valid(raise_exception=True)
进行校验,如果校验出错,会自动抛出错误信息 - 调用序列化器的
.save()
方法,调用save时会判断当初始创建序列化器时是否传入instance
- 如果传入了
instance
,也传了data
,那么调用save
实际调用序列化器中的update
方法,反之就是调用序列化器的create
方法