drf-五大方法(重要)
Posted mqhpy
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了drf-五大方法(重要)相关的知识,希望对你有一定的参考价值。
序列化类
#BookListSerializer是BookModelSerializer子序列化类
class BookListSerializer(serializers.ListSerializer):
# 自定义的群增群改辅助类,没有必要重写create方法
def create(self, validated_data):
return super().create(validated_data)
#获取视图类中的validated_data_list进行for循环
def update(self, instance_list, validated_data_list):
return [
#将取出来的结果给了 self.child.update
self.child.update(instance_list[index], attrs) for index, attrs in enumerate(validated_data_list)
#序列化类
class BookModelSerializer(serializers.ModelSerializer):
class Meta:
# ModelSerializer默认配置了ListSerializer辅助类,帮助完成群增群改
# list_serializer_class = serializers.ListSerializer
# 如果只有群增,是不需要自定义配置的,但要完成群改,必须自定义配置
list_serializer_class = BookListSerializer
model = models.Book
fields = ['name', 'price', 'publish', 'authors', 'publish_info', 'author_list']
extra_kwargs = {
'publish': {
'write_only': True
},
'authors': {
'write_only': True
}
}
# 外键字段默认显示的是外键值(int类型),不会自己进行深度查询
# 深度查询方式:
# 1)子序列化:必须有子序列化类配合,不能反序列化了
# 2)配置depth:自动深度查询的是关联表的所有字段,数据量太多
# 3)插拔式@property:名字不能与外键名同名
#例如:在models中
@property
def publish_info(self): # 单个数据
# from .serializers import PublishModelSerializer
# return PublishModelSerializer(self.publish).data
return {
'name': self.publish.name,
'address': self.publish.address,
}
@property
def author_list(self):
author_list_temp = [] # 存放所有作者格式化成数据的列表
authors = self.authors.all() # 所有作者
for author in authors: # 遍历处理所有作者
author_dic = {
'name': author.name,
}
try: # 有详情才处理详情信息
author_dic['mobile'] = author.detail.mobile
except:
author_dic['mobile'] = '无'
author_list_temp.append(author_dic) # 将处理过的数据添加到数据列表中
return author_list_temp # 返回处理后的结果
视图类查方法get
class BookAPIView(PAIView):
def get(self,request,*args,**kwargs):
pk = Kwargs.get('pk')
#单查
if pk:
#从数据源库查数据
book_obj=models.Book.objects.filter(is_delete=False,pk=pk).first()
#将查好的数据进行序列化
book_ser=serializers.BookModelSerializer(book_obj)
else:
#群查
#群查数据库
book_query=models.Books.objects.filter(is_delete=False).all()
#将数据库中的数据进行序列化
book_ser=serializers.BookModelSerializer(book_query,many=True)
#返回结果
return APIResponse(results=book_ser.data)
#也可以写成return Response(data=book_ser.data)
视图函数删方法delete
class BookAPIView(APIView):
def delete(self, request, *args, **kwargs):
"""
单删:接口:/books/(pk)/ 数据:空
群删:接口:/books/ 数据:[pk1, ..., pkn]
逻辑:修改is_delete字段,修改成功代表删除成功,修改失败代表删除失败
"""
pk = kwargs.get('pk')
if pk:
pks = [pk] # 将单删格式化成群删一条
else:
pks = request.data # 群删
try: # 数据如果有误,数据库执行会出错
rows = models.Book.objects.filter(is_delete=False, pk__in=pks).update(is_delete=True)
except:
return APIResponse(1, '数据有误')
if rows:
return APIResponse(0, '删除成功')
return APIResponse(1, '删除失败')
视图函数增方法post
class BookAPIView(APIView):
def post(self, request, *args, **kwargs):
"""
单增:接口:/books/ 数据:{...}
群增:接口:/books/ 数据:[{...}, ..., {...}]
逻辑:将数据给系列化类处理,数据的类型关系到 many 属性是否为True
"""
#利用isinstance函数判断是不是字典类型,若是则是单增
if isinstance(request.data, dict):
many = False
#利用isinstance函数判断是不是列表类型,若是则是群增
elif isinstance(request.data, list):
many = True
#否则视为错误
else:
return Response(data={'detail': '数据有误'}, status=400)
# 在内部源码save中若data有数据就执行create操作,如果有instance就操作update操作
book_ser = serializers.BookModelSerializer(data=request.data, many=many)
# 在is_valid源码中将raise_exception设置为True会自动获取内部的报错信息
book_ser.is_valid(raise_exception=True)
book_obj_or_list = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_obj_or_list, many=many).data)
视图函数整体改方法put
class BookAPIView(APIView):
def put(self, request, *args, **kwargs):
"""
单改:接口:/books/(pk)/ 数据:{...}
群增:接口:/books/ 数据:[{pk, ...}, ..., {pk, ...}]
逻辑:将数据给系列化类处理,数据的类型关系到 many 属性是否为True
"""
pk = kwargs.get('pk')
if pk: # 单改
try:
# 与增的区别在于,需要明确被修改的对象,交给序列化类
book_instance = models.Book.objects.get(is_delete=False, pk=pk)
except:
return Response({'detail': 'pk error'}, status=400)
book_ser = serializers.BookModelSerializer(instance=book_instance, data=request.data)
# 在is_valid源码中将raise_exception设置为True会自动获取内部的报错信息
book_ser.is_valid(raise_exception=True)
book_obj = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_obj).data)
else: # 群改
# 分析(重点):
# 1)数据是列表套字典,每个字典必须带pk,就是指定要修改的对象,如果有一条没带pk,整个数据有误
# 2)如果pk对应的对象已被删除,或是对应的对象不存在,可以认为整个数据有误(建议),可以认为将这些错误数据抛出即可
request_data = request.data
try:
pks = []
for dic in request_data:
pk = dic.pop('pk') # 解决分析1,没有pk pop方法就会抛异常
pks.append(pk)
book_query = models.Book.objects.filter(is_delete=False, pk__in=pks).all()
if len(pks) != len(book_query):
raise Exception('pk对应的数据不存在')
except Exception as e:
return Response({'detail': '%s' % e}, status=400)
book_ser = serializers.BookModelSerializer(instance=book_query, data=request_data, many=True)
book_ser.is_valid(raise_exception=True)
# 在内部源码save中若data有数据就执行create操作,如果有instance就操作update操作
book_list = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_list, many=True).data)
视图函数局部改方法patch
class BookAPIView(APIView):
# 局部单改群改,其实与整体改就差一个partial=True!!!!
def patch(self, request, *args, **kwargs):
pk = kwargs.get('pk')
if pk: # 单改
try:
book_instance = models.Book.objects.get(is_delete=False, pk=pk)
except:
return Response({'detail': 'pk error'}, status=400)
# 设置partial=True的序列化类,参与反序列化的字段,都会置为选填字段
# 1)提供了值得字段发生修改。
# 2)没有提供的字段采用被修改对象原来的值
# 设置context的值,目的:在序列化完成自定义校验(局部与全局钩子)时,可能需要视图类中的变量,如请求对象request
# 可以通过context将其传入,在序列化校验方法中,self.context就能拿到传入的视图类中的变量
book_ser = serializers.BookModelSerializer(instance=book_instance, data=request.data, partial=True, context={'request': request})
book_ser.is_valid(raise_exception=True)
book_obj = book_ser.save() #在save中如果有instance就走update(改),如果没有就走create(增)
return APIResponse(results=serializers.BookModelSerializer(book_obj).data)
else: # 群改
request_data = request.data
try:
pks = []
for dic in request_data:
pk = dic.pop('pk')
pks.append(pk)
book_query = models.Book.objects.filter(is_delete=False, pk__in=pks).all()
if len(pks) != len(book_query):
raise Exception('pk对应的数据不存在')
except Exception as e:
return Response({'detail': '%s' % e}, status=400)
book_ser = serializers.BookModelSerializer(instance=book_query, data=request_data, many=True, partial=True)
book_ser.is_valid(raise_exception=True)
book_list = book_ser.save()
return APIResponse(results=serializers.BookModelSerializer(book_list, many=True).data)
以上是关于drf-五大方法(重要)的主要内容,如果未能解决你的问题,请参考以下文章