序列化组件的介绍
1. 序列化 序列化器会把模型对象转换成字典,经过response以后变成json字符串
2. 反序列化 把客户端发送过来的是数据,经过request以后变成字典,序列化器可以把字典转换成模型
3. 反序列化 完成数据校验功能
简单实用
1 写一个序列化的类,继承Serializer
2 在类中写要序列化的字段,想序列化哪个字段,就在类中写哪个字段
3 在视图类中使用, 导入--》实例化得到序列化类的对象, 把要序列化的对象传入
4 序列化类的对象.data 是一个字典
5 把字典返回, 如果不使用rest_framework提供的Response,就得使用JsonResponse
序列化类的字段类型
有很多,不需要都记住 主要是为了跟django的字段类型对上号
只需要记住:CharField, IntegerField, DateField...
序列化组件修改数据
1 写一个序列化的类, 继承Serializer
2 在类中写要反序列化的字段, 想反序列化哪个字段, 就在类中写哪个字段,字段的属性(max_length..)
max_length 最大长度
min_lenght 最小长度
allow_blank 是否允许为空
trim_whitespace 是否截断空白字符
max_value 最小值
min_value 最大值
3 在视图类中使用,导入==》实例化得到序列化类的对象,把要修改的对象传入,修改的数据传入
boo_ser = BookSerializer(instance=book,data=request.data)
4 数据校验 if boo_ser.is_vaild()
5 如果校验通过,就保存
boo_ser.save()
6 如果不通过 逻辑自己写
7 如果字段的校验规则不够,可以写钩子函数(局部和全局)
def validate_price(self, data):
if float(data)>10:
return data
else:
raise ValidationError('价格太低,保存失败')
def validate(self, attrs):
print(attrs)
author = attrs.get('author')
publish = attrs.get('publish')
if author == publish:
raise ValidationError('作者名字和出版社名称不能一致')
else:
return attrs
8 还有第三种校验 使用字段
def check_author(data):
if data.startwith('sb'):
raise ValidationError('作者名字不能以sb开始')
else:
return data
author = serializers.CharField(validators=[check_author])
read_only 和write_only
read_only 表名该字段仅用于序列化输出, 默认False,如果设置成True Postman中可以看到该字段,修改时,不需要传该字段
write_only 表明该字段仅用于反序列化输入, 默认False,如果设置成True Postman中get看不到该字段 ,修改时要传该字段
以下的了解就行
required 表明该字段在反序列化时必须输入,默认True
default 反序列化时使用的默认值
allow_null 表明该字段是否允许传入None,默认False
validators 该字段使用的验证器
error_messages 包含错误编号与错误信息的字典
label 用于HTML展示API页面时,显示的字段名称
help_text 用于HTML展示API页面时,显示的字段帮助提示信息
查询所有
class BooksView(APIView):
def get(self, request):
response_msg = {'status': 1001, '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()),
新增数据
class BooksView(APIView):
def post(self, request):
response_msg = {'status': 1001, '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'] = 1002
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()),
删除一个数据
class BooksView(APIView):
def delete(self,request,pk):
res = Book.objects.filter(pk=pk).delete()
return Response({'status': 1001, 'msg': '删除成功'})
re_path('books/(?P<pk>\d+)', views.BookView.as_view()),
模型类序列化器
class BookModelSerializer(serializers.ModelSerializer):
class Meta:
model = Book
fields = '__all__'
read_only_fields=('price')
Serializer高级用法
source的使用
1 可以改字段名字 xxx = serializers.CharField(source='title')
2 可以.跨表 publish=serializers.CharField(source='publish.email')
3 可以执行方 pub_date=serializers.CharField(source='test') test时Book表模型中的方法
SerializerMethodField()的使用
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
补充
补充自己封装 接口的Response对象
class mymessage:
def __init__(self):
self.status = 1001
self.msg = '成功'
@property
def get_dict(self):
print(self.__dict__)
if __name__ == '__main__':
res = mymessage()
res.status = 101
res.msg = '查询失败'
print(res.get_dict)