mixins

mixins有五个工具类文件，一共提供了五个工具类，六个工具方法：单查、群查、单增、单删、单整体改、单局部改

则视图可以通过继承相应的扩展类来复用代码，减少自己编写的代码量。

这五个扩展类需要搭配GenericAPIView父类，因为五个扩展类的实现需要调用GenericAPIView提供的序列化器与数据库查询的方法。

搭配GenericAPIView的目的:

1. 路由调用GenericAPIView父类APIView的as_view()方法
2. 调用APIView的dispatch完成方发
3. 需要GenericAPIView类提供的几个类属性和方法

ListModelMixin

功能: 群查

列表视图扩展类，提供list(request, *args, **kwargs)方法快速实现列表视图，返回200状态码。

该Mixin的list方法会对数据进行过滤和分页。

源代码：

class ListModelMixin(object):"""List a queryset."""def list(self, request, *args, **kwargs):# 过滤queryset = self.filter_queryset(self.get_queryset())# 分页page = self.paginate_queryset(queryset)if page is not None:serializer = self.get_serializer(page, many=True)return self.get_paginated_response(serializer.data)# 序列化serializer = self.get_serializer(queryset, many=True)return Response(serializer.data)

RetrieveModelMixin

功能: 单查

详情视图扩展类，提供retrieve(request, *args, **kwargs)方法，可以快速实现返回一个存在的数据对象。

如果存在，返回200， 否则返回404。

源代码：

class RetrieveModelMixin(object):"""Retrieve a model instance."""def retrieve(self, request, *args, **kwargs):# 获取对象，会检查对象的权限instance = self.get_object()# 序列化serializer = self.get_serializer(instance)return Response(serializer.data)

CreateModelMixin

功能: 单增

创建视图扩展类，提供create(request, *args, **kwargs)方法快速实现创建资源的视图，成功返回201状态码。

如果序列化器对前端发送的数据验证失败，返回400错误。

源代码：

class CreateModelMixin(object):"""Create a model instance."""def create(self, request, *args, **kwargs):# 获取序列化器serializer = self.get_serializer(data=request.data)# 验证serializer.is_valid(raise_exception=True)# 保存self.perform_create(serializer)headers = self.get_success_headers(serializer.data)return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)def perform_create(self, serializer):serializer.save()def get_success_headers(self, data):try:return {'Location': str(data[api_settings.URL_FIELD_NAME])}except (TypeError, KeyError):return {}

UpdateModelMixin

功能: 单个对象整体修改或单个对象局部修改

更新视图扩展类，提供update(request, *args, **kwargs)方法，可以快速实现更新一个存在的数据对象。

同时也提供partial_update(request, *args, **kwargs)方法，可以实现局部更新。

成功返回200，序列化器校验数据失败时，返回400错误。

源代码：

class UpdateModelMixin(object):"""Update a model instance."""def update(self, request, *args, **kwargs):partial = kwargs.pop('partial', False)instance = self.get_object()serializer = self.get_serializer(instance, data=request.data, partial=partial)serializer.is_valid(raise_exception=True)self.perform_update(serializer)if getattr(instance, '_prefetched_objects_cache', None):# If 'prefetch_related' has been applied to a queryset, we need to# forcibly invalidate the prefetch cache on the instance.instance._prefetched_objects_cache = {}return Response(serializer.data)def perform_update(self, serializer):serializer.save()def partial_update(self, request, *args, **kwargs):kwargs['partial'] = Truereturn self.update(request, *args, **kwargs)

DestroyModelMixin

功能: 删除单个对象

删除视图扩展类，提供destroy(request, *args, **kwargs)方法，可以快速实现删除一个存在的数据对象。

成功返回204，不存在返回404。注意,直接从数据库中将数据删除

源代码：

class DestroyModelMixin(object):"""Destroy a model instance."""def destroy(self, request, *args, **kwargs):instance = self.get_object()self.perform_destroy(instance)return Response(status=status.HTTP_204_NO_CONTENT)def perform_destroy(self, instance):instance.delete()

案例

• urls.py

urlpatterns = [url(r'^v3/books/$', views.BookMixinGenericAPIView.as_view()),url(r'^v3/books/(?P.*)/$', views.BookMixinGenericAPIView.as_view()),
]

• views.py

from rest_framework.mixins import ListModelMixin,RetrieveModelMixin,CreateModelMixin,UpdateModelMixin
class BookMixinGenericAPIView(ListModelMixin, RetrieveModelMixin, CreateModelMixin, UpdateModelMixin, GenericAPIView):# 继承GenericAPIView的目的:# 1.路由调用GenericAPIView父类APIView的as_view()方法# 2.调用APIView的dispatch完成方发# 3.需要GenericAPIView类提供的几个类属性和方法queryset = models.Book.objects.filter(is_delete=False)serializer_class = serializers.BookModelSerializerdef get(self, request, *args, **kwargs):if 'pk' in kwargs:# 单查:RetrieveModelMixin 中的retrieve()方法,内部是调用了GenericAPIView的get_object()方法response = self.retrieve(request, *args, **kwargs)else:# 群查:ListModelMixin 中的list()方法,内部是调用了GenericAPIView的get_serializer(queryset, many=True)方法response = self.list(request, *args, **kwargs)# mixins提供的方法响应的数据默认是Response# response.data即可拿到响应的数据print(response.data)  # {'字段':'字段值',...}return APIResponse(results=response.data)# 单增:CreateModelMixin 中的create()方法内部是调用了GenericAPIView的get_serializer(data=request.data)方法完成序列化,在保存def post(self, request, *args, **kwargs):response = self.create(request, *args, **kwargs)return APIResponse(results=response.data)# 单 整体改: UpdateModelMixin 中的update()方法内部是调用了GenericAPIView的get_object()拿到具体对象,使partial=False到达整体改def put(self, request, *args, **kwargs):response = self.update(request, *args, **kwargs)return APIResponse(results=response.data)# 单 局部改: UpdateModelMixin 中的update()方法内部是调用了GenericAPIView的get_object()拿到具体对象,使partial=True到达局部改def patch(self, request, *args, **kwargs):response = self.partial_update(request, *args, **kwargs)return APIResponse(results=response.data)

generics 

工具视图都是GenericAPIView的子类，且不同的子类继承了不同的工具类，重写了请求方法

工具视图的功能如果直接可以满足需求，只需要继承工具视图，提供queryset与serializer_class即可

ListCreateAPIView

功能: 群查,单增

提供方法: get, post

源码:

class ListCreateAPIView(mixins.ListModelMixin,mixins.CreateModelMixin,GenericAPIView):"""Concrete view for listing a queryset or creating a model instance."""def get(self, request, *args, **kwargs):return self.list(request, *args, **kwargs)def post(self, request, *args, **kwargs):return self.create(request, *args, **kwargs)

UpdateAPIView

功能: 单个对象整体修改或单个对象局部修改

提供方法: put, patch

源码:

class UpdateAPIView(mixins.UpdateModelMixin,GenericAPIView):"""Concrete view for updating a model instance."""def put(self, request, *args, **kwargs):return self.update(request, *args, **kwargs)def patch(self, request, *args, **kwargs):return self.partial_update(request, *args, **kwargs)

RetrieveUpdateAPIView

功能: 单查,单个对象整体修改或单个对象局部修改

提供方法: get, put, patch

源码:

class RetrieveUpdateAPIView(mixins.RetrieveModelMixin,mixins.UpdateModelMixin,GenericAPIView):"""Concrete view for retrieving, updating a model instance."""def get(self, request, *args, **kwargs):return self.retrieve(request, *args, **kwargs)def put(self, request, *args, **kwargs):return self.update(request, *args, **kwargs)def patch(self, request, *args, **kwargs):return self.partial_update(request, *args, **kwargs)

RetrieveDestroyAPIView

功能: 单查,单删

提供方法: get, delete

注意: 一般会重写destroy方法

源码:

class RetrieveDestroyAPIView(mixins.RetrieveModelMixin,mixins.DestroyModelMixin,GenericAPIView):"""Concrete view for retrieving or deleting a model instance."""def get(self, request, *args, **kwargs):return self.retrieve(request, *args, **kwargs)def delete(self, request, *args, **kwargs):return self.destroy(request, *args, **kwargs)

案例

urls.py

urlpatterns = [url(r'^v4/books/$', views.BookListCreatePIView.as_view()),url(r'^v4/books/(?P.*)/$', views.BookListCreatePIView.as_view()),
]

views.py

from rest_framework.generics import ListCreateAPIView, UpdateAPIView
class BookListCreatePIView(ListCreateAPIView, UpdateAPIView):# 根据不同的请求能完成 群查,单个对象整体修改或单个对象局部修改queryset = models.Book.objects.filter(is_delete=False)serializer_class = serializers.BookModelSerializer

本文来自互联网用户投稿，文章观点仅代表作者本人，不代表本站立场，不承担相关法律责任。如若转载，请注明出处。 如若内容造成侵权/违法违规/事实不符，请点击【内容举报】进行投诉反馈！