如何在非通用视图/视图集中使用分页？

Question

我已经在SO文档中编写了一个示例，以统一上述问题的答案，但是由于文档将于2017年8月8日关闭，因此，我将遵循这一广受好评和讨论的元答案的建议，并将我的示例转换为自我回答发布。

当然，我也很高兴看到任何其他方法！！

题：

我想APIView在Django Rest Framework项目上使用非通用视图/视图集（例如：）。
当我阅读分页文档时：

仅在使用通用视图或视图集时才自动执行分页。如果您使用的是常规APIView，则需要自己调用分页API，以确保您返回分页响应。有关示例，请参见mixins.ListModelMixin和generics.GenericAPIView类的源代码。

我仍然可以继续使用非通用视图/视图集吗？
如何在其上执行分页？

Answer 1

我们可以找到解决方案而无需重新发明轮子：

1. 让我们看一下如何实现generics分页： django-rest-framework / rest_framework / generics.py。
   这也正是我们将要使用的观点！
   

2. 假设我们有一个全局分页设置，如下所示
   settings.py：

   REST_FRAMEWORK = {
   'DEFAULT_PAGINATION_CLASS': 
       'rest_framework.pagination.DESIRED_PAGINATION_STYLE',
   'PAGE_SIZE': 100
   

   }

3. 为了不使视图/视图集的代码膨胀，我们可以创建一个自定义的mixin来存储我们的分页代码：

   class MyPaginationMixin(object):
   
   @property
   def paginator(self):
       """
       The paginator instance associated with the view, or `None`.
       """
        if not hasattr(self, '_paginator'):
            if self.pagination_class is None:
                self._paginator = None
            else:
                self._paginator = self.pagination_class()
        return self._paginator
   
    def paginate_queryset(self, queryset):
        """
        Return a single page of results, or `None` if pagination 
        is disabled.
        """
        if self.paginator is None:
            return None
        return self.paginator.paginate_queryset(
            queryset, self.request, view=self)
   
    def get_paginated_response(self, data):
        """
        Return a paginated style `Response` object for the given 
        output data.
        """
        assert self.paginator is not None
        return self.paginator.get_paginated_response(data)
   

4. 然后views.py：

   from rest_framework.settings import api_settings
   

   from rest_framework.views import APIView

   from my_app.mixins import MyPaginationMixin

   class MyView(APIView, MyPaginationMixin):
   queryset = OurModel.objects.all()
   serializer_class = OurModelSerializer
   pagination_class = api_settings.DEFAULT_PAGINATION_CLASS

   # We need to override the get method to insert pagination
   def get(self, request):
       ...
       page = self.paginate_queryset(self.queryset)
       if page is not None:
           serializer = self.serializer_class(page, many=True)
           return self.get_paginated_response(serializer.data)
   

现在我们有了APIView分页。