博客

详解Django的 paginate_queryset() 函数：对查询结果进行分页

  • Post category:Python

Django中的paginate_queryset()函数是用于实现分页功能的核心函数之一。该函数的作用是将指定的查询集(QuerySet)按照给定的每页记录数进行分页，并返回包含当前页码、前一页页码、后一页页码、总页数、当前页记录列表和总记录数等信息的Paginator对象。

该函数的使用方法非常简单。需要先导入Paginator类和EmptyPage异常类，并在视图函数中使用Paginator类来创建分页器对象，然后调用paginate_queryset()函数对查询集进行分页，最终获取分页后的查询结果。下面是该函数的标准使用方法及其参数列表：

from django.core.paginator import Paginator, EmptyPage

def my_view(request):
    records_per_page = 10  # 每页显示记录数
    queryset = queryset.filter(status='published')  # 过滤查询集

    paginator = Paginator(queryset, records_per_page)  # 创建分页器对象
    current_page = request.GET.get('page', 1)  # 获取当前页码（默认为第一页）

    try:
        records_list = paginator.page(current_page)  # 获取当前页的记录列表
    except EmptyPage:
        records_list = paginator.page(paginator.num_pages)  # 如果当前页码不存在，则重定向到最后一页

    # 其它代码...

其中，Paginator构造函数的参数列表为(queryset, per_page)，第一个参数为查询集，第二个参数为每页显示的记录数。queryset和per_page参数均为必需参数，并且要求queryset必须实现order_by()方法和count()方法，以便Paginator对象能够正确的进行分页。

下面是两个使用示例：

示例一

下面是一个使用paginate_queryset()函数实现分页的示例。假设有一个名为Post的模型，其中包含了所有的博客文章，我们需要对这些文章进行分页并在页面上显示出来。

from django.core.paginator import Paginator, EmptyPage
from django.shortcuts import render
from myapp.models import Post

def post_list(request):
    records_per_page = 20  # 每页显示20条记录
    post_list = Post.objects.filter(status='published').order_by('-pub_date')  # 查询所有已发布的文章，并按照发布日期降序排序

    paginator = Paginator(post_list, records_per_page)  # 创建分页器对象
    current_page = request.GET.get('page', 1)  # 获取当前页码（默认为第一页）

    try:
        records = paginator.page(current_page)  # 获取当前页的记录列表
    except EmptyPage:
        records = paginator.page(paginator.num_pages)  # 如果当前页码不存在，则重定向到最后一页

    context = {'records': records}
    return render(request, 'post_list.html', context)

上述代码中，我们首先从数据库中查询出所有已发布的文章，并按照发布日期进行排序。然后，我们使用Paginator类将查询结果进行分页，并将分页后的结果赋值给records变量。最后，我们将分页后的记录列表渲染到post_list.html页面中。

示例二

下面是另一个使用paginate_queryset()函数实现分页的示例。假设我们需要在后台管理系统中实现分页功能，以方便管理员管理大量的数据表记录。

from django.core.paginator import Paginator, EmptyPage
from django.contrib.auth.decorators import login_required
from django.shortcuts import render
from myapp.models import MyModel

@login_required
def my_model_list(request):
    records_per_page = 20  # 每页显示20条记录
    obj_list = MyModel.objects.all().order_by('-id')  # 查询所有记录，并按照ID降序排序

    paginator = Paginator(obj_list, records_per_page)  # 创建分页器对象
    current_page = request.GET.get('page', 1)  # 获取当前页码（默认为第一页）

    try:
        records = paginator.page(current_page)  # 获取当前页的记录列表
    except EmptyPage:
        records = paginator.page(paginator.num_pages)  # 如果当前页码不存在，则重定向到最后一页

    context = {'records': records}
    return render(request, 'my_model_list.html', context)

在这个示例中，我们使用了Django内置的@login_required装饰器来保护my_model_list视图函数，确保只有登录的管理员才能访问该页面。接着，我们查询了MyModel模型的所有记录，并按照ID降序排序。然后，我们使用Paginator类将查询结果进行分页，并将分页后的结果赋值给records变量。最后，我们将分页后的记录列表渲染到my_model_list.html页面中。

以上是Django的paginate_queryset()函数的作用和使用方法。该函数是实现分页功能的重要组成部分，能够帮助我们快速方便地对查询结果进行分页，并以统一的格式返回分页信息。

Tags: