一、五个扩展类
1.ListModelMixin
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)
2.CreateModelMixin
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 {}
3.RetrieveModelMixin
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)
4.UpdateModelMixin
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'] = True return self.update(request, *args, **kwargs)
5.DestroyModelMixin
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()
二、使用案例
from rest_framework.response import Response from rest_framework.mixins import ListModelMixin, CreateModelMixin, RetrieveModelMixin, UpdateModelMixin,DestroyModelMixin from rest_framework.generics import GenericAPIView from book.models import BookInfo from drf_book.serializer import BookSerializer class BooksMixinView(ListModelMixin, CreateModelMixin, GenericAPIView): """ 获取所有图书和保存图书 """ # 指定查询集属性 queryset = BookInfo.objects.all() # 指定序列化器 serializer_class = BookSerializer def get(self, request): """ 获取所有图书 :param request: :return: """ return self.list(request) def post(self, request): """ 保存图书 :param request: :return: """ return self.create(request) class BookMixinView(RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin, GenericAPIView): """ 获取单一图书数据 更新图书 删除图书 """ # 指定查询集属性 queryset = BookInfo.objects.all() # 指定序列化器 serializer_class = BookSerializer def get(self, request, pk): """ 获取单一图书数据 :param request: :param pk: :return: """ return self.retrieve(request) def put(self, request, pk): """ 更新图书 :param request: :param pk: :return: """ return self.update(request) def delete(self, request, pk): """ 删除图书 :param request: :param pk: :return: """ return self.destroy(request)
总结
mixin 类提供用于提供基本视图行为的操作。请注意，mixin 类提供操作方法，而不是直接定义处理程序方法，例如 和 。这允许更灵活的行为组合。.get().post()
mixin 类可以从 中导入。rest_framework.mixins
1、ListModelMixin
提供一个方法，该方法实现列出查询集。.list(request, *args, **kwargs)
如果填充了查询集，这将返回一个响应，并将查询集的序列化表示形式作为响应的正文。可以选择对响应数据进行分页。200 OK
2、CreateModelMixin
提供一个方法，该方法实现创建和保存新的模型实例。.create(request, *args, **kwargs)
如果创建了一个对象，这将返回一个响应，并将该对象的序列化表示形式作为响应的主体。如果表示形式包含名为 的键，则响应的标头将填充该值。201 CreatedurlLocation
如果为创建对象提供的请求数据无效，则将返回响应，并将错误详细信息作为响应的正文。400 Bad Request
3、RetrieveModelMixin
提供一个方法，该方法实现在响应中返回现有模型实例。.retrieve(request, *args, **kwargs)
如果可以检索对象，则返回响应，并将对象的序列化表示形式作为响应的主体。否则，它将返回 .200 OK404 Not Found
4、UpdateModelMixin
提供一个方法，该方法实现更新和保存现有模型实例。.update(request, *args, **kwargs)
还提供了一个方法，该方法与该方法类似，只是更新的所有字段都是可选的。这允许支持 HTTP 请求。.partial_update(request, *args, **kwargs)updatePATCH
如果更新了对象，这将返回响应，并将对象的序列化表示形式作为响应的主体。200 OK
如果为更新对象提供的请求数据无效，则将返回响应，并将错误详细信息作为响应的正文。400 Bad Request
5、DestroyModelMixin
提供一个方法，该方法实现删除现有模型实例。.destroy(request, *args, **kwargs)
如果删除对象，则返回响应，否则将返回 .204 No Content404 Not Found
