什么是分页?
在 Web 应用程序中,当我们从数据库中检索大量数据时,为了避免一次性返回所有数据,通常需要将数据分成多个页面。这就是分页的基本概念:将数据分成多个页面,每个页面包含一定数量的数据。
在 Django REST Framework(DRF)中,分页是指将 API 查询结果划分为多个页面,每个页面包含一定数量的对象,以便在不降低性能和效率的情况下处理大量数据。
分页器
DRF 提供了多种分页器,可以根据不同的需求进行选择。分页器可以在视图集合中使用,以将查询结果分成多个页面,并将每个页面的数据返回给客户端。
以下是 DRF 内置的分页器:
PageNumberPagination
: 基于页码的分页器,将查询结果分成多个页面,并将每个页面的数据返回给客户端。客户端可以通过page
查询参数指定要返回的页面。LimitOffsetPagination
: 基于限制和偏移量的分页器,将查询结果分成多个页面,并将每个页面的数据返回给客户端。客户端可以通过limit
和offset
查询参数指定要返回的数据范围。CursorPagination
: 基于游标的分页器,将查询结果分成多个页面,并将每个页面的数据返回给客户端。客户端可以使用上一页和下一页的游标链接,从而避免使用基于页码的分页器中的一些常见问题。
PageNumberPagination
示例
以下是一个简单的使用 PageNumberPagination
分页器的示例:
from rest_framework.pagination import PageNumberPagination
class BookPagination(PageNumberPagination):
page_size = 10
page_size_query_param = 'page_size'
max_page_size = 100
class BookViewSet(viewsets.ModelViewSet):
queryset = Book.objects.all()
serializer_class = BookSerializer
pagination_class = BookPagination
在这个例子中,我们创建了一个名为 BookPagination
的分页器类,并设置了每页返回的对象数量为 10。我们还为客户端指定了可以在查询参数中使用的 page_size
参数,并设置了最大页面大小为 100。最后,我们将 BookPagination
分页器类添加到 BookViewSet
视图集合中。
现在,当客户端发起请求时,我们的 BookViewSet
视图集合将使用 BookPagination
分页器将查询结果划分为多个页面,并将每个页面的数据返回给客户端。客户端可以在查询参数中指定 page
参数来请求不同的页面。