博客

详解Django的 get_paginator() 函数：获取分页器

  • Post category:Python

下面我将为你详细讲解一下Django的get_paginator()函数的作用与使用方法的完整攻略。

1. get_paginator()函数的作用

get_paginator()函数是Django框架中的一个分页器函数，其主要作用是将查询出的所有数据进行分页展示，将数据按照每页固定的数量进行切割，然后在页面上呈现为多个页面。通过get_paginator()函数，可以使用户通过点击页面上的页面序号或翻页按钮实现跳转至不同页面展示不同数据的功能。

2. get_paginator()函数的使用方法

在Django框架中使用get_paginator()函数，需要导入from django.core.paginator import Paginator，然后创建一个Paginator对象，最后调用get_page()方法进行页面渲染，具体流程如下：

# 导入Paginator模块
from django.core.paginator import Paginator

def my_view(request):
    # 查询所有记录
    article_list = Article.objects.all()

    # 设置每页最多显示5条记录
    paginator = Paginator(article_list, 5)

    # 请求参数中获取当前的页码，如果没有则设置默认值为1
    page_number = request.GET.get("page", 1)

    # 获取要展示的页面对应的数据
    page_data = paginator.get_page(page_number)

    # 返回页面需要展示的数据
    return render(request, 'article.html', context={"page_data": page_data})

在上述代码中，首先是导入Paginator模块，然后查询所有的记录，并且通过Paginator对象进行分页处理。接着从请求参数中获取当前请求的页码，如果没有则默认页码为1。最后调用get_page()方法获取对应页面的数据，并在渲染的页面中展示页面数据。

3. 实例

下面给出两个使用实例说明：

3.1 一个简单的分页实现

假设我们有一个博客网站，要将所有的文章按照10条一页的方式进行展示。首先导入Paginator模块并查询所有的文章数据：

from django.core.paginator import Paginator
from .models import Article

def article_list(request):
    article_list = Article.objects.all()
    paginator = Paginator(article_list, 10)

    page_number = request.GET.get('page')
    page_obj = paginator.get_page(page_number)

    return render(request, 'article_list.html', {'page_obj': page_obj})

在视图函数中，我们首先查询所有的文章数据，并且将其传入Paginator对象中，指定每页展示10条数据。接着从请求参数中获取当前页码号，并通过get_page()方法获取对应页面的数据。最后将数据渲染至前端页面即可。

3.2 在前端页面中展示分页信息

在博客网站中，我们希望在分页的每一个页面中展示出当前页面是第几页，和总共有多少页的信息。那么我们需要在视图函数中进行一些修改：

def article_list(request):
    article_list = Article.objects.all()
    paginator = Paginator(article_list, 10)

    page_number = request.GET.get('page')
    page_obj = paginator.get_page(page_number)

    context = {
        'page_obj': page_obj,
        'total_pages': paginator.num_pages,
        'current_page': page_obj.number,
    }
    return render(request, 'article_list.html', context)

在上述代码中，我们在context字典中增加了”current_page”和”total_pages”两个字段，分别表示当前页面的页数和总共有多少页，然后在渲染的页面中使用Django的模板语言进行字符串拼接展示。

在前端HTML中，我们可以这样展示：

{% if page_obj.has_previous %}
    <a class="page-link" href="?page=1">&laquo;First</a>
{% endif %}

{% if page_obj.number > 1 %}
    <a class="page-link" href="?page={{ page_obj.previous_page_number }}">&lsaquo;&lsaquo;Prev</a>
{% endif %}

<span> 第 {{ current_page }}/{{ total_pages }} 页 </span>

{% for page_num in page_obj.paginator.page_range %}
    {% if page_num == page_obj.number %}
        <a class="page-link active" href="?page={{ page_num }}">{{ page_num }}</a>
    {% elif page_num > page_obj.number|add:'-5' and page_num < page_obj.number|add:'5' %}
        <a class="page-link" href="?page={{ page_num }}">{{ page_num }}</a>
    {% endif %}
{% endfor %}

{% if page_obj.has_next %}
    <a class="page-link" href="?page={{ page_obj.next_page_number }}">&rsaquo;&rsaquo;Next</a>
{% endif %}

{% if page_obj.has_next %}
    <a class="page-link" href="?page={{ page_obj.paginator.num_pages }}">&raquo;Last</a>
{% endif %}

在上述HTML代码中，我们通过page_obj.has_previous、page_obj.has_next判断当前页面是否有上一页、下一页，然后通过page_obj.previous_page_number、page_obj.next_page_number获取前一页、后一页的页码号进行跳转。在展示当前页面数和总共有多少页数时，我们使用了current_page和total_pages两个变量，分别对应我们在视图函数中传递的值。

Tags: