一:序列化组件介绍
1. 序列化,序列化器会把模型对象转换成字典,经过response以后变成json字符串
2. 反序列化,把客户端发送过来的数据,经过request以后变成字典,序列化器可以把字典转成模型
3. 反序列化,完成数据校验功能
1.简单使用
1 写一个序列化的类,继承Serializer
2 在类中写要序列化的字段,想序列化哪个字段,就在类中写哪个字段
3 在视图类中使用,导入--》实例化得到序列化类的对象,把要序列化的对象传入
4 序列化类的对象.data 是一个字典
5 把字典返回,如果不使用rest_framework提供的Response,就得使用JsonResponse
class BookSerializer(serializers.Serializer):
name=serializers.CharField()
price=serializers.CharField()
author=serializers.CharField()
publish=serializers.CharField()
class BookView(APIView):
def get(self,request,pk):
book=Book.objects.filter(id=pk).first()
book_ser=BookSerializer(book)
return Response(book_ser.data)
re_path('books/(?P<pk>d+)', views.BookView.as_view()),
2.序列化类的字段类型
有很多,不需要都记住
只需要记住:CharField,IntegerField,DateField。。。
3.序列化字段选项
4.序列化组件修改数据
1 写一个序列化的类,继承Serializer
2 在类中写要反序列化的字段,想反序列化哪个字段,就在类中写哪个字段,字段的属性(max_lenth......)
max_length 最大长度
min_lenght 最小长度
allow_blank 是否允许为空
trim_whitespace 是否截断空白字符
max_value 最小值
min_value 最大值
3 在视图类中使用,导入--》实例化得到序列化类的对象,把要要修改的对象传入,修改的数据传入
boo_ser=BookSerializer(book,request.data)
boo_ser=BookSerializer(instance=book,data=request.data)
4 数据校验 if boo_ser.is_valid()
5 如果校验通过,就保存
boo_ser.save()
6 如果不通过,逻辑自己写
7 如果字段的校验规则不够,可以写钩子函数(局部和全局)
def validate_price(self, data):
if float(data)>10:
return data
else:
raise ValidationError('价格太低')
def validate(self, validate_data):
print(validate_data)
author=validate_data.get('author')
publish=validate_data.get('publish')
if author == publish:
raise ValidationError('作者名字跟出版社一样')
else:
return validate_data
8 可以使用字段的author=serializers.CharField(validators=[check_author]) ,来校验
-写一个函数
def check_author(data):
if data.startswith('sb'):
raise ValidationError('作者名字不能以sb开头')
else:
return data
-配置:validators=[check_author]
class Book(models.Model):
id=models.AutoField(primary_key=True)
name=models.CharField(max_length=32)
price=models.DecimalField(max_digits=5,decimal_places=2)
author=models.CharField(max_length=32)
publish=models.CharField(max_length=32)
from rest_framework import serializers
from rest_framework.exceptions import ValidationError
def check_author(data):
if data.startswith('sb'):
raise ValidationError('作者名字不能以sb开头')
else:
return data
class BookSerializer(serializers.Serializer):
name=serializers.CharField(max_length=16,min_length=4)
price=serializers.CharField()
author=serializers.CharField(validators=[check_author])
publish=serializers.CharField()
def validate_price(self, data):
if float(data)>10:
return data
else:
raise ValidationError('价格太低')
def validate(self, validate_data):
print(validate_data)
author=validate_data.get('author')
publish=validate_data.get('publish')
if author == publish:
raise ValidationError('作者名字跟出版社一样')
else:
return validate_data
def update(self, instance, validated_data):
instance.name=validated_data.get('name')
instance.price=validated_data.get('price')
instance.author=validated_data.get('author')
instance.publish=validated_data.get('publish')
instance.save()
return instance
class BookView(APIView):
def get(self,request,pk):
book=Book.objects.filter(id=pk).first()
book_ser=BookSerializer(book)
return Response(book_ser.data)
def put(self,request,pk):
response_msg={'status':100,'msg':'成功'}
book = Book.objects.filter(id=pk).first()
boo_ser=BookSerializer(instance=book,data=request.data)
if boo_ser.is_valid():
boo_ser.save()
response_msg['data']=boo_ser.data
else:
response_msg['status']=101
response_msg['msg']='数据校验失败'
response_msg['data']=boo_ser.errors
return Response(response_msg)
re_path('books/(?P<pk>d+)', views.BookView.as_view()),
5.read_only和write_only
read_only 表明该字段仅用于序列化输出,默认False,如果设置成True,postman中可以看到该字段,修改时,不需要传该字段
write_only 表明该字段仅用于反序列化输入,默认False,如果设置成True,postman中看不到该字段,修改时,该字段需要传
required 表明该字段在反序列化时必须输入,默认True
default 反序列化时使用的默认值
allow_null 表明该字段是否允许传入None,默认False
validators 该字段使用的验证器
error_messages 包含错误编号与错误信息的字典
二:增删改查
1.查询所有
class BooksView(APIView):
def get(self,request):
response_msg = {'status': 100, 'msg': '成功'}
books=Book.objects.all()
book_ser=BookSerializer(books,many=True)
response_msg['data']=book_ser.data
return Response(response_msg)
path('books/', views.BooksView.as_view()),
2.新增数据
class BooksView(APIView):
def post(self,request):
response_msg = {'status': 100, 'msg': '成功'}
book_ser = BookSerializer(data=request.data)
if book_ser.is_valid():
book_ser.save()
response_msg['data']=book_ser.data
else:
response_msg['status']=102
response_msg['msg']='数据校验失败'
response_msg['data']=book_ser.errors
return Response(response_msg)
def create(self, validated_data):
instance=Book.objects.create(**validated_data)
return instance
path('books/', views.BooksView.as_view()),
3.删除一个数据
class BookView(APIView):
def delete(self,request,pk):
ret=Book.objects.filter(pk=pk).delete()
return Response({'status':100,'msg':'删除成功'})
re_path('books/(?P<pk>d+)', views.BookView.as_view()),
4.模型类序列化器
class BookModelSerializer(serializers.ModelSerializer):
class Meta:
model=Book
fields='__all__'
extra_kwargs = {
'price': {'write_only': True},
}
三:源码分析
1.many=True的实际用途
book_ser=BookModelSerializer(books,many=True)
book_one_ser=BookModelSerializer(book)
print(type(book_ser))
print(type(book_one_ser))
def __new__(cls, *args, **kwargs):
if kwargs.pop('many', False):
return cls.many_init(*args, **kwargs)
return super().__new__(cls, *args, **kwargs)
2.Serializer高级用法
1 可以改字段名字 xxx=serializers.CharField(source='title')
2 可以.跨表publish=serializers.CharField(source='publish.email')
3 可以执行方法pub_date=serializers.CharField(source='test') test是Book表模型中的方法
1 它需要有个配套方法,方法名叫get_字段名,返回值就是要显示的东西
authors=serializers.SerializerMethodField()
def get_authors(self,instance):
authors=instance.authors.all()
ll=[]
for author in authors:
ll.append({'name':author.name,'age':author.age})
return ll