Django REST Framework-如何使用分页

在 Web 开发中，处理大量数据是非常常见的。但是，如果一次性返回所有数据，不仅会增加服务器的负担，而且还会影响客户端的响应时间。为了解决这个问题，分页被广泛应用于 Web 应用程序中，特别是在 RESTful API 中。

在 Django REST Framework 中，分页器是一种允许我们将查询结果划分为多个页面，并将每个页面的数据返回给客户端的工具。

基于页码的分页器

基于页码的分页器将查询结果划分为多个页面，并使用页码来标识每个页面。客户端可以在查询参数中指定要请求的页面数，以及每个页面返回的对象数量。Django REST Framework 中内置了两种基于页码的分页器：PageNumberPagination 和 LimitOffsetPagination。

PageNumberPagination

PageNumberPagination 分页器是基于页码的分页器，允许客户端使用页码和每页返回的对象数量来请求不同的数据范围。以下是一个简单的使用 PageNumberPagination 分页器的示例：

from rest_framework.pagination import PageNumberPagination

class BookPagination(PageNumberPagination):
    page_size = 10
    page_query_param = 'page'
    max_page_size = 100

class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    pagination_class = BookPagination

在这个例子中，我们创建了一个名为 BookPagination 的分页器类，并指定了默认的页面大小为 10，并将 page_query_param 属性设置为 page，以便使用 page 参数作为页码参数。我们还为客户端指定了可以在查询参数中使用的 page 和 page_size 参数，并设置了最大页面大小为 100。最后，我们将 BookPagination 分页器类添加到 BookViewSet 视图集合中。

现在，当客户端发起请求时，我们的 BookViewSet 视图集合将使用 BookPagination 分页器将查询结果划分为多个页面，并将每个页面的数据返回给客户端。客户端可以在查询参数中指定 page 和 page_size 参数来请求不同的数据范围。

LimitOffsetPagination

LimitOffsetPagination 分页器也是一种基于页码的分页器，但与 PageNumberPagination 不同的是，它允许客户端指定一个偏移量和每页返回的对象数量来请求数据。以下是一个简单的使用 LimitOffsetPagination 分页器的示例：

from rest_framework.pagination import LimitOffsetPagination

class BookPagination(LimitOffsetPagination):
    default_limit = 10
    limit_query_param = 'limit'
    offset_query_param = 'offset'
    max_limit = 100

class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    pagination_class = BookPagination

在这个例子中，我们创建了一个名为 BookPagination 的分页器类，并指定了默认的页面大小为 10，并将 limit_query_param 和 offset_query_param 分别设置为 limit 和 offset，以便客户端可以使用 limit 和 offset 参数来请求数据。我们还指定了最大限制为 100，并将 BookPagination 分页器类添加到 BookViewSet 视图集合中。

现在，当客户端发起请求时，我们的 BookViewSet 视图集合将使用 LimitOffsetPagination 分页器将查询结果划分为多个页面，并将每个页面的数据返回给客户端。客户端可以在查询参数中指定 limit 和 offset 参数来请求不同的数据范围。

基于游标的分页器

基于游标的分页器与基于页码的分页器不同，它使用一个游标来标识要返回的数据范围。在客户端发送第一次请求时，服务器返回一组数据和一个游标。客户端使用这个游标来请求下一组数据。以下是一个简单的使用 CursorPagination 分页器的示例：

from rest_framework.pagination import CursorPagination

class BookPagination(CursorPagination):
    page_size = 10
    ordering = 'title'

class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    pagination_class = BookPagination

在这个例子中，我们创建了一个名为 BookPagination 的分页器类，并指定了默认的页面大小为 10，并将 ordering 属性设置为 title，以便按标题排序。最后，我们将 BookPagination 分页器类添加到 BookViewSet 视图集合中。

现在，当客户端发起请求时，我们的 BookViewSet 视图集合将使用 CursorPagination 分页器将查询结果划分为多个页面，并将每个页面的数据返回给客户端。客户端可以使用 next 和 previous 参数来请求下一页和上一页。

在 Django REST Framework 中，分页器是一种将查询结果划分为多个页面并将每个页面的数据返回给客户端的工具。Django REST Framework 中内置了两种分页器，即基于页码的分页器和基于游标的分页器。在使用分页器时，我们可以指定默认的页面大小、页面参数和最大页面大小等属性，以及按特定的字段排序等选项。