Django的Paginator和PageNumberPagination详解

摘要

今天我们来聊一聊Django中2个非常重要实用的工具——Paginator和PageNumberPagination。这2个工具在我们进行数据分页时，无疑是最好的伙伴。

Paginator

Paginator 是 Django 的基础分页类，主要用于对查询结果进行分页处理。它更适用于传统的 Django 视图，例如在模板中渲染一个包含分页信息的 HTML 页面。

假设我们有一个名为 Blog 的模型，现在我们要对其中的所有博客进行分页处理。
在我们的视图函数中，我们可以从请求中获取页码和每页数量的参数，然后使用Paginator对数据进行分页。

from django.core.paginator import Paginator
from django.http import JsonResponse
from .models import Blog

def blog_list(request):
    # 从查询参数中获取页面号
    page_number = request.GET.get('page', 1)
 
    # 从查询参数中获取每页需要显示的数据条数
    page_size = request.GET.get('page_size', 10)

    # 获取所有博客对象
    blogs = Blog.objects.all()

    # 创建一个 Paginator 对象，并设置每页需要显示的数据条数
    paginator = Paginator(blogs, page_size)

    # 获取请求页面的博客对象
    page = paginator.get_page(page_number)

    # 将博客对象列表转换为包含字典的列表
    blog_list = list(page.object_list.values())

    # 创建响应数据
    data = {
        'blogs': blog_list,                        # 博客列表
        'has_next': page.has_next(),                # 是否有下一页
        'has_previous': page.has_previous(),        # 是否有上一页
        'number': page.number,                      # 当前页号
        'num_pages': paginator.num_pages,           # 总页数
    }

    return JsonResponse(data)

PageNumberPagination

如果你在使用Django Rest Framework 构建RESTful API,你可能会更愿意使用PageNumberPagination。这是一个强大的分页类，提供了更多的配置选项，主要用于API视图。
PAgeNumberPagination 和Paginator的使用方式相似，但PageNumberPagination需要使用作为一个视图的属性来配置。这样，当你请求这个视图是，DRF就会自动对结果进行分页处理。
我们在 DRF 视图中定义 PageNumberPagination，并处理前端发送的页码和每页数量的参数。

from rest_framework.pagination import PageNumberPagination
from rest_framework import viewsets
from .models import Blog
from .serializers import BlogSerializer

class StandardResultsSetPagination(PageNumberPagination):
    page_size = 10
    page_size_query_param = 'page_size'
    max_page_size = 1000

class BlogViewSet(viewsets.ModelViewSet):
    queryset = Blog.objects.all()
    serializer_class = BlogSerializer
    pagination_class = StandardResultsSetPagination

Paginator与PageNumberPagination比较

Paginator 和 PageNumberPagination 的选择主要取决于你的应用场景。如果你正在创建一个传统的网页应用，Paginator 就够用了。如果你正在使用 DRF 创建 API，PageNumberPagination 则更适合。总的来说，Paginator 和 PageNumberPagination 都是用于分页的工具，但它们在用法和应用场景上有一些不同。Paginator 是 Django 的核心部分，可以直接用于对 QuerySet 进行分页处理。你可以通过创建 Paginator 对象，然后调用其方法来获取分页信息。这个过程需要你手动实现。而 PageNumberPagination 是 Django Rest Framework (DRF) 提供的分页工具，主要用于 API 视图。你可以通过在视图设置 pagination_class，DRF 将自动处理分页逻辑。

总结

好了，今天的内容就到这里。希望你们对Django的Paginator和DRF的PageNumberPagination有了更深的理解。记住，编程就像做一道美食，你需要正确地掌握配方并添加合适的调料。Paginator和PageNumberPagination就像是我们的厨师小帮手，它们帮助我们在处理大量数据时保持条理性和效率。使用它们，你的编程旅程将更加愉快。