开云-通过 Django Pagination 实现简单分页

经由过程 Django Pagination 实现简单分页 时候：2024-12-13 21:04:30 手机看文章

扫描二维码随时随地手机看文章

当博客上发布的文章愈来愈多时，凡是需要进行分页显示，以避免所有的文章都聚积在一个页面，影响用户体验。

Django 内置的 Pagination 可以或许帮忙我们实现简单的分页功能，在上一篇教程[3]中我们利用剧本批量生成了几百篇博客文章，正好用在测试分页结果。

Paginator 类的经常使用方式

分页功能由 Django 内置的 Paginator类供给，这个类位在 django.core.paginator模块，需要利用它时，只需在恰当的处所导入这个类便可：

from django.core.paginator import Paginator

下面的代码摘自 Django 的官方文档中 Pagination[4] 的示例，只需实例化一个 Paginator对象，并在实例化时传入一个需要分页的列表对象，便可以获得分页后的对象。

# 对 item_list 进行分页，每页包括 2 个数据。 item_list = ['john', 'paul', 'george', 'ringo'] p = Paginator(item_list, 2)

取特定页的数据：

# 取第 2 页的数据 page2 = p.page(2) page2.object_list['george', 'ringo']

查询特定页确当前页码数：

 page2.number 2 

查看分页后的总页数：

 p.num_pages 2 

查看某一页是不是还上一页，和查询该页上一页的页码：

# 查询第二页是不是还上一页 page2.has_previous() True # 查询第二页上一页的页码 page2.previous_page_number() 1

查看某一页是不是还下一页，和查询该页下一页的页码：

# 查询第二页是不是还下一页 page2.has_next() False # 查询第二页下一页的页码 page2.next_page_number() Traceback (most recent call last): ... EmptyPage: That page contains no results

更多方式和属性请参阅 Django Pagination 的官方文档[5]。

用 Paginator 给文章列表分页

利用上面的一些方式，我们可以实现一个近似在 Django 官方博客一样的简单分页结果，结果以下。

这里 Django 的官方文档中给出了一个在视图函数中对列表进行分页的示例，这个视图函数获得一个联系人列表并对其分页：

from django.core.paginator import Paginator, EmptyPage, PageNotAnInteger from django.shortcuts import render def listing(request):  contact_list = Contacts.objects.all()  paginator = Paginator(contact_list, 25) # 每页显示 25 个联系人  page = request.GET.get('page') try:    contacts = paginator.page(page) except PageNotAnInteger: # 假如用户要求的页码号不是整数，显示第一页    contacts = paginator.page(1) except EmptyPage: # 假如用户要求的页码号跨越了最年夜页码号，显示最后一页    contacts = paginator.page(paginator.num_pages) return render(request, 'list.html', {'contacts': contacts})

这就是在视图函数中利用分页的代码逻辑，你可以把它当作一个模板利用在本身的任何需要分页的视图函数。不外在我们的博客项目中，我们没必要写这些代码了。回首在 Django 官方保举的姿式：类视图[6] 中的内容，我们已将视图函数转换成了类视图。而类视图 ListView已帮我们写好了上述的分页逻辑，我们只需经由过程指定 paginate_by属性来开启分页功能便可，即在类视图中指定 paginate_by属性的值：

blog/views.py class IndexView(ListView): model = Post template_name = 'blog/index.html' context_object_name = 'post_list' # 指定 paginate_by 属性后开启分页功能，其值代表每页包括几多篇文章 paginate_by = 10 

这里我们设置了每 10 篇文章一页。

在模板中设置分页导航

接下来即是在模板中设置分页导航，好比上一页、下一页的按钮，和显示一些页面信息。我们这里设置和 Django 官方博客那样的分页导航样式（具体的样式见上图）。ListView传递了以下和分页有关的模板变量供我们在模板中利用：

paginator，即 Paginator的实例。 page_obj，当前要求页面分页对象。 is_paginated，是不是已分页。只有当分页后页面跨越两页时才算已分页。 object_list，要求页面的对象列表，和 post_list等价。所以在模板中轮回文章列表时可以选 post_list，也能够选 object_list。

模板中利用示例：

templates/blog/index.html{% if is_paginated %} div {% if page_obj.has_previous %} a href="?page={{ page_obj.previous_page_number }}" 上一页a {% endif %} span 第 {{ page_obj.number }} 页 / 共 {{ paginator.num_pages }} 页span {% if page_obj.has_next %} a href="?page={{ page_obj.next_page_number }}" 下一页a {% endif %} div {% endif %}

此中 {{ }}模板变量中的内容，其寄义已在文章开首部门的 Paginator 类的经常使用方式中已有介绍。别的还要留意一点，要求哪个页面经由过程 page查询参数传递给 django 视图，django 会按照 page的值返回对应页面的文章列表，所以上一页和下一页超链接的 href 属性指向的 url 带上了 page 查询参数。

终究我们获得以下的分页结果：

固然这只是一个简单示例，分页导航处的视觉结果其实不是很都雅，你可以自行动其添加 CSS 样式使其看上去加倍美不雅。 进一步拓展

利用 Django 内置的 Pagination 只能实现上面的简单分页结果，但凡是加倍高级的分页结果应当像下图如许：

当前页面高亮显示，且显示当前页眼前后几页的页码，始终显示第一页和最后一页的页码，中心可能还省略号的结果，暗示还未显示的页码。

仅仅利用 Django Pagination 内置的方式没法实现如许的结果，需要本身写分页逻辑或借助第三方库。接下来我们将具体申明若何借助第三方库拓展 Pagination 以实现一个完美的分页结果。

欲知详情，请下载word文档 下载文档