五个扩展类

五个扩展类

作用

• 封装了对数据进行曾删改查的实现，可以通过继承其中的一个或多个扩展类来复用代码
• 这五个扩展类需要搭配GenericAPIView (或者是后面的 GenericViewSet)一起使用：五个扩展类的需要调用GenericAPIView提供的序列化器与数据库查询的方法

扩展类	作用	封装的方法	状态码（成功，失败）
ListModelMixin	查询多条数据	list	200
CreateModelMixin	新增一条数据	create	201，400
RetrieveModelMixin	查询一条数据	retrieve	200，404
UpdateModelMixin	更新一条数据	update，partial_update	200，400
DestroyModelMixin	删除一条数据	destroy	204，404

案例： 基于GeniricAPIView和扩展类，封装REST API

# users/urls.py
url(r'^departments2/$', views.DepartmentListAPIView2.as_view()),
url(r'^departments2/(?P<pk>\d+)/$', views.DepartmentDetailView2.as_view()),

# users/views.py
class DepartmentListAPIView2(
        ListModelMixin, CreateModelMixin, GenericAPIView):

    queryset = Department.objects.all()
    serializer_class = DepartmentSerializer

    def get(self, request):
        # 调用ListModelMixin的方法,查询多条数据
        return self.list(request)

    def post(self, request):
        # 调用CreateModelMixin的方法, 新增部门
        return self.create(request)


class DepartmentDetailAPIView2(
        RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin, GenericAPIView):

    queryset = Department.objects.all()
    serializer_class = DepartmentSerializer

    def get(self, request, pk):
        # 调用RetrieveModelMixin的方法，查询一条数据
        return self.retrieve(request, pk)

    def put(self, request, pk):
        # 调用UpdateModelMixin的方法，修改部门
        return self.update(request, pk)

    def delete(self, request, pk):
        # 调用DestroyModelMixin的方法，数据部门
        return self.destroy(request, pk)

扩展类源码参考

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)

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 {}

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)

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)

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()