通过 Django Pagination 实现简单分页功能


Posted in Python onNovember 11, 2019

通过 Django Pagination 实现简单分页功能

作者:HelloGitHub-追梦人物

文中所涉及的示例代码,已同步更新到 HelloGitHub-Team 仓库

当博客上发布的文章越来越多时,通常需要进行分页显示,以免所有的文章都堆积在一个页面,影响用户体验。

Django 内置的 Pagination 能够帮助我们实现简单的分页功能,在上一篇教程中我们使用脚本批量生成了几百篇博客文章,正好用于测试分页效果。

Paginator 类的常用方法

分页功能由 Django 内置的 Paginator 类提供,这个类位于 django.core.paginator 模块,需要使用它时,只需在适当的地方导入这个类即可:

from django.core.paginator import Paginator

下面的代码摘自 Django 的官方文档中 Pagination 的示例,只需实例化一个 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 的官方文档。

用 Paginator 给文章列表分页

使用上面的一些方法,我们可以实现一个类似于 Django 官方博客一样的简单分页效果,效果如下。

通过 Django Pagination 实现简单分页功能

这里 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 官方推荐的姿势:类视图 中的内容,我们已将视图函数转换成了类视图。而类视图 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 class="pagination-simple">
 <!-- 如果当前页还有上一页,显示一个上一页的按钮 -->
 {% if page_obj.has_previous %}
  <a href="?page={{ page_obj.previous_page_number }}">上一页</a>
 {% endif %}
 <!-- 显示当前页面信息 -->
 <span class="current">第 {{ 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 查询参数。

最终我们得到如下的分页效果:

通过 Django Pagination 实现简单分页功能

当然这只是一个简单示例,分页导航处的视觉效果并不是很好看,你可以自行为其添加 CSS 样式使其看上去更加美观。

进一步拓展

使用 Django 内置的 Pagination 只能实现上面的简单分页效果,但通常更加高级的分页效果应该像下图这样:

通过 Django Pagination 实现简单分页功能

当前页面高亮显示,且显示当前页面前后几页的页码,始终显示第一页和最后一页的页码,中间可能还有省略号的效果,表示还有未显示的页码。

仅仅使用 Django Pagination 内置的方法无法实现这样的效果,需要自己写分页逻辑或者借助第三方库。接下来我们将详细说明如何借助第三方库拓展 Pagination 以实现一个完善的分页效果。

总结

以上所述是小编给大家介绍的通过 Django Pagination 实现简单分页功能,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对三水点靠木网站的支持!
如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!

Python 相关文章推荐
linux系统使用python监控apache服务器进程脚本分享
Jan 15 Python
python自动裁剪图像代码分享
Nov 25 Python
浅谈python正则的常用方法 覆盖范围70%以上
Mar 14 Python
Python控制Firefox方法总结
Jun 03 Python
使用python制作一个为hex文件增加版本号的脚本实例
Jun 12 Python
python 有效的括号的实现代码示例
Nov 11 Python
python实现将一维列表转换为多维列表(numpy+reshape)
Nov 29 Python
Python生态圈图像格式转换问题(推荐)
Dec 02 Python
python读取dicom图像示例(SimpleITK和dicom包实现)
Jan 16 Python
VScode连接远程服务器上的jupyter notebook的实现
Apr 23 Python
Python 判断时间是否在时间区间内的实例
May 16 Python
浅谈keras保存模型中的save()和save_weights()区别
May 21 Python
python机器学习实现决策树
Nov 11 #Python
Python SQLAlchemy入门教程(基本用法)
Nov 11 #Python
django中间键重定向实例方法
Nov 10 #Python
Java文件与类动手动脑实例详解
Nov 10 #Python
python语言线程标准库threading.local解读总结
Nov 10 #Python
Python 脚本拉取 Docker 镜像问题
Nov 10 #Python
Python如何优雅获取本机IP方法
Nov 10 #Python
You might like
php cookie的操作实现代码(登录)
2010/12/29 PHP
php 判断是否是中文/英文/数字示例代码
2013/09/30 PHP
PHP jpgraph库的配置及生成统计图表:折线图、柱状图、饼状图
2017/05/15 PHP
Laravel接收前端ajax传来的数据的实例代码
2017/07/20 PHP
PHP通过get方法获得form表单数据方法总结
2018/09/12 PHP
JScript中的&quot;this&quot;关键字使用方式补充材料
2007/03/08 Javascript
javascript 硬盘序列号+其它硬件信息
2008/12/23 Javascript
javascript中获取下个月一号,是星期几
2012/06/01 Javascript
js实现的切换面板实例代码
2013/06/17 Javascript
使用jquery实现的一个图片延迟加载插件(含图片延迟加载原理)
2014/06/05 Javascript
给js文件传参数(详解)
2014/07/13 Javascript
jQuery获得指定元素坐标的方法
2015/04/14 Javascript
浅谈JavaScript中变量和函数声明的提升
2016/08/09 Javascript
JS实现快速比较两个字符串中包含有相同数字的方法
2017/09/11 Javascript
bootstrap响应式导航条模板使用详解(含下拉菜单,弹出框)
2017/11/17 Javascript
jQuery实现常见的隐藏与展示列表效果示例
2018/06/04 jQuery
动态内存分配导致影响Javascript性能的问题
2018/12/18 Javascript
微信小程序使用map组件实现获取定位城市天气或者指定城市天气数据功能
2019/01/22 Javascript
微信小程序mpvue点击按钮获取button值的方法
2019/05/29 Javascript
浅谈layui使用模板引擎动态渲染元素要注意的问题
2019/09/14 Javascript
JS数组方法reduce的用法实例分析
2020/03/03 Javascript
[00:33]2016完美“圣”典风云人物:BurNIng宣传片
2016/12/10 DOTA
Python HTML解析器BeautifulSoup用法实例详解【爬虫解析器】
2019/04/05 Python
python跳出双层for循环的解决方法
2019/06/24 Python
Django 开发环境与生产环境的区分详解
2019/07/26 Python
Python龙贝格法求积分实例
2020/02/29 Python
keras分类模型中的输入数据与标签的维度实例
2020/07/03 Python
python创建文本文件的简单方法
2020/08/30 Python
Python 打印自己设计的字体的实例讲解
2021/01/04 Python
Python基于opencv的简单图像轮廓形状识别(全网最简单最少代码)
2021/01/28 Python
为什么会有内存对齐
2016/10/10 面试题
《美丽的小路》教学反思
2014/02/26 职场文书
成龙霸王洗发水广告词
2014/03/14 职场文书
家长会主持词开场白
2015/05/29 职场文书
Python Django搭建文件下载服务器的实现
2021/05/10 Python
Python实现双向链表基本操作
2022/05/25 Python