DRF序列化
drf序列化家族
作用：使从数据库中取数据时的反射过程可控。
一、drf序列化类如何创建
- 在应用文件夹内新建一个py文件。命名随意，例如
exception.py。用来自定义序列化类； - 在文件中创建序列化类，类名最好包含对应的model表名以及系列化种类，如
UserSerializer； - 在类中定义属性与方法，属性包含你需要操作的model表的字段，方法包含你需要对一些属性进行进一步校验的钩子函数；
- 在需要用到序列化校验的视图函数views文件中导入已经写好的序列化类，在类中传入需要校验的对象，序列化类就会自动帮你校验对象中的数据；
- 校验完成后序列化类会给你返回一个Serializer对象
ser_obj，你可以通过ser_obj.data获取校验后的数据。
二、drf序列化类种类
1、Serializer类(了解)
底层序列化-了解的类
重点：单表序列化
1.1 Serializer类如何序列化
1.1.1 视图文件views.py序列化：
- 通过orm从数据库拿到数据；
- 将数据序列化成可以返回给前端的数据格式；
- 将序列化后的数据返回给前端。
from rest_framework.views import APIView
from rest_framework.response import Response
from app01 import models
from app01 import serializers
from rest_framework.status import *
# 使用serializer序列化器进行序列化
class CarV2APIView(APIView):
def get(self, request, *args, **kwargs):
pk = kwargs.get('pk')
if pk: # 单查
car_obj = models.Car.objects.filter(pk=pk, is_delete=False).first()
if not car_obj:
return Response({
'status': 1,
'msg': 'pk not found',
}, status=HTTP_400_BAD_REQUEST)
else:
car_serializer_obj = serializers.CarSerializer(car_obj) # many默认为false
return Response({
'status': 0,
'msg': 'ok',
'results': car_serializer_obj.data
}, status=HTTP_200_OK)
else: # 群查
car_query = models.Car.objects.filter(is_delete=False).all()
car_serializer_obj = serializers.CarSerializer(car_query, many=True)
return Response({
'status': 0,
'msg': 'data ok',
'results': car_serializer_obj.data
})
1.1.2 序列化文件exception.py序列化：
- 设置序列化字段，字段名与字段类型要与处理的model类属性名对应(只参与序列化的类型不需要设置条件)；
- model类中有的字段，但在序列化中没有对应字段，就不参与序列化；
- 自定义序列化字段(方法一)，字段类型为SerializerMethodField()，值由 get_自定义字段名(self, model_obj) 方法提供，
- 一般值都与参与序列化的model对象(model_obj)有关
# 自定义Serializer序列化类，用来取出数据库信息
class CarSerializer(serializers.Serializer):
#字段名与字段类型要与处理的model类对应
#不提供的字段，就不参与序列化给前台
name = serializers.CharField()
#可以自定义序列化字段，采用方法序列化，方法固定两个参数，第二个参数就是参与序列化的model对象
#严重不建议自定义字段名与数据库字段名重名，由get_自定义字段名方法的返回值提供字段值
car_color = serializers.SerializerMethodField()
def get_car_color(self,obj):
return obj.get_color_display()
price = serializers.DecimalField(10,2)
picture = serializers.SerializerMethodField()
def get_picture(self,obj):
return f'{settings.BASE_URL}{settings.MEDIA_URL}{obj.image}'
brand = serializers.CharField()
1.2 Serializer类如何反序列化
1.2.1 视图文件views.py反序列化过程：
- 从请求对象中获取前台提交数据request.data；
- 交给序列化类完成反序列化(数据的校验)；
- 序列化类完成数据入库；
- 将新生成的对象或信息返回给前台。
# 单群增V2版
class CarV2APIView(APIView):
def post(self, request, *args, **kwargs):
# 将前端传来的数据传入序列化组件进行校验
car_ser = serializers.CarDeSerializer(data=request.data)
if car_ser.is_valid():
# 数据通过校验则用save方法入库，返回创建的对象
car_obj = car_ser.save()
return Response({
'status': 0,
'msg': 'ok',
# 将汽车对象序列化一下再返回给前端，比较规范
'result': serializers.CarSerializer(car_obj).data
}, status=HTTP_200_OK)
else:
return Response({
'status': 1,
'msg': car_ser.errors,
}, status=HTTP_400_BAD_REQUEST)
1.2.2 序列化文件exception.py反序列化过程：
- 系统校验字段与自定义校验字段定义没有区别：字段 = serializers.字段类型(条件)
- 自定义校验字段是不能直接入库的，需要设置入库规则，或将其移除不入库(这类字段就是参与全局校验用的)
- 所有字段都可以设置对应局部钩子进行校验，钩子方法 validate_字段名(self, 字段值value) 规则：成功直接返回value，失败抛出校验失败信息ValidationError('错误信息')
- 一个序列化类存在一个全局钩子可以对所有字段进行全局校验，钩子方法 validate(self, 所有字段值字典attrs)
- 规则：成功直接返回attrs，失败抛出校验失败信息ValidationError({'异常字段', '错误信息'})
- 重写create方法实现增入库，返回入库成功的对象
- 重写update方法实现改入库，返回入库成功的对象
# 自定义反序列化类，用来接收前端数据，并存入数据库
# 和forms组件校验数据用法一样
class CarDeSerializer(serializers.Serializer):
# 反序列化中写的字段，会被反序列化校验；
# 括号内写校验规则，和forms组件写法一样
name = serializers.CharField(
max_length=10,
min_length=2,
error_messages={
'max_length': '车名不得超过10个字！',
'min_length': '车名不得少于2个字！',
'required': '车名必须写！'
}
)
# 不写的字段，就不必参与反序列化；
# 创建对象时，直接使用默认值
# 但如果传了值，就会使用传的值
# color =
price = serializers.DecimalField(10,2)
brand = serializers.CharField(
error_messages={
'required': '品牌名必须写！'
}
)
# 自定义校验字段：语法和模型字段没区别，
# 但不能入库，需要在全局钩子中取出
re_brand = serializers.CharField(
error_messages={
'required': '品牌名必须写！'
}
)
# 局部钩子 validate_name_字段名
def validate_name(self,value):
if value == '一给我里giaogiao':
raise serializers.ValidationError('禁止giaogiao！')
return value
# 全局钩子
def validate(self, attrs):
brand = attrs.get('brand')
# 将自定义字段移除
re_brand = attrs.pop('re_brand')
if brand != re_brand:
raise serializers.ValidationError({'re_brand':'两次输入品牌不一致！请重新输入！'})
return attrs
# 重写create方法，实现创建数据
# create和update都需要返回一个instance(obj)
def create(self, validated_data):
print(validated_data)
return models.Car.objects.create(**validated_data)
# 重写update方法，实现修改数据
# create和update都需要返回一个instance(obj)
def update(self, instance, validated_data):
validated_data.pop('name')
models.Car.objects.filter(pk=instance.id).update(**validated_data)
return instance
2、ModelSerializer类(重点，实用)
模型序列化类-核心类
重点：多表序列化
2.1 ModelSerializer类如何序列化与反序列化
2.1.1 视图文件views.py
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,
})
2.1.2 序列化文件exception.py
- 序列化类继承ModelSerializer，所以需要在配置类Meta中进行配置
- model配置：绑定序列化相关的Model表
- fields配置：采用 插拔式 设置所有参与序列化与反序列化字段
- extra_kwargs配置：
- 系统字段设置是否参与序列或反序列：只读(read_only)、只写(write_only)、可读可写(不设置)
- 字段是否必须：required
- 选填字段：在extra_kwargs进行配置，但不设置required，且有默认值
- 自定义序列化字段：
- 第一种(不提倡)：在序列化类中用SerializerMethodField()来设置自定义字段
- 第二种(提倡)：在模型类中用@property设置方法，从而可以通过fileds中的字段进行映射，进而完成自定义字段的可插拔式设计。
- 自定义反序列化字段：
- 同Serializer类，且规则只能在此声明中设置，或是在钩子中设置，在extra_kwargs中对其设置的无效
- 自定义反序列化字段与系统字段，设置规则一样，所以必须设置 write_only
- 局部钩子，全局钩子同Serializer类写法
- 不需要重写create和update方法
# modelserializer同时进行序列化和反序列化
class CarModelSerializer(serializers.ModelSerializer):
# 通过SerializerMethodField设置的字段为只读字段
car_color = serializers.SerializerMethodField()
def get_car_color(self,obj):
return obj.get_color_display()
re_brand = serializers.CharField(
write_only=True,
error_messages={
'required':'re_brand为必填字段！'
}
)
class Meta: # 声明
# 绑定需要进行序列化和反序列化的模型表
model = models.Car
# 设置模型表中需要进行序列化和反序列化的字段(容器，列表或元组)。
# 并且选项中的名称可以映射到模型类中不存在任何参数的属性或方法，
# 通过这种特性可以完成自定义字段的插拔式设计
fields = [
'name','car_color','price','image_path','brand','re_brand'
]
read_only_fields = ['car_color','image_path']
# 设置额外的序列化与反序列化的规则
extra_kwargs = {
'name':{
'min_length':2,
'max_length':10,
'error_messages':{
'min_length': '太短',
'max_length': '太长',
}
}
}
# depth可以用来设置字段进行外键关联查找的层数
# depth = 1
def validate(self, attrs):
brand = attrs.get('brand')
re_brand = attrs.pop('re_brand',False)
if not brand == re_brand:
raise serializers.ValidationError({'re_brand':'两次品牌不一致！'})
return attrs
# create和update方法不需要再重写，ModelSerializer类已提供，且支持所有关系下的连表操作
2.1.3 模型类文件models.py
class Car(models.Model):
color_choice = (
(0,'银色'),
(1,'红色'),
(2,'黑色'),
(3,'灰色'),
)
name = models.CharField(max_length=64,verbose_name='车名',unique=True)
color = models.IntegerField(choices=color_choice,default=0,verbose_name='颜色')
price = models.DecimalField(max_digits=10,decimal_places=2,verbose_name='价格')
image = models.ImageField(upload_to='img',default='img/default.jpg',verbose_name='头像')
brand = models.CharField(max_length=32,default='unknown')
is_delete = models.BooleanField(default=False,verbose_name='是否注销')
created_time = models.DateTimeField(auto_now_add=True,verbose_name='创建时间')
# 第二种自定义序列化字段（插拔式，提倡使用）
def image_path(self):
return f'{settings.BASE_URL}{settings.MEDIA_URL}{self.image}'
class Meta:
# db_table = 'carclass' 创建表时做表名
verbose_name_plural = '汽车表'
def __str__(self):
return self.name # 不要在这里进行连表操作，比如admin页面可能会崩溃
3、ListSerializer类
群操作序列化类-辅助类
重点：辅助完成单表多表群增群改操作
