Django Pagination 简单分页
当博客上发布的文章越来越多时,通常需要进行分页显示,以免所有的文章都堆积在一个页面,影响用户体验。Django 内置的 Pagination 能够帮助我们实现简单的分页功能。
Paginator 类的常用方法
分页功能由 Django 内置的 Paginator
类提供。这个类位于 django/core/paginator.py,需要使用它时,只需在适当的地方导入这个类即可。下面的代码摘自 Django 的官方文档中 Pagination 的示例。
from django.core.paginator import Paginator
只需实例化一个 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()
django.core.paginator.EmptyPage: That page contains no results
更多方法和属性请参阅 Django Pagination 的官方文档。
用 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})
这就是在视图函数中使用分页的代码逻辑,你可以把它当做一个模板应用于自己的任何需要分页的视图函数。不过在我们的博客项目中,我们不必写这些代码了。回顾在 基于类的通用视图:ListView 和 DetailView 中的内容,我们已将视图函数转换成了类视图。而类视图 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 类的常用方法中已有介绍。最终我们得到如下的分页效果:
当然这只是一个简单示例,分页导航处的视觉效果并不是很好看,你可以自行为其添加 CSS 样式使其看上去更加美观。
进一步拓展
使用 Django 内置的 Pagination 只能实现上面的简单分页效果,但通常更加高级的分页效果应该像下图这样:
当前页面高亮显示,且显示当前页面前后几页的页码,始终显示第一页和最后一页的页码,中间可能还有省略号的效果,表示还有未显示的页码。
仅仅使用 Django Pagination 内置的方法无法实现这样的效果,需要我们写一些额外的代码来拓展 Pagination 的功能。接下来我们将详细说明该如何拓展 Pagination 以实现一个完善的分页效果。
总结
本章节的代码位于:Step19: simple pagination。
如果遇到问题,请通过下面的方式寻求帮助。
- 在下方评论区留言。
- 将问题的详细描述通过邮件发送到 djangostudyteam@163.com,一般会在 24 小时内回复。
- 在 Pythonzhcn 社区的新手问答版块 发布帖子。
- 玩玩文本挖掘-wordcloud、主题模型与文本分类
- Typecho 前台 getshell 漏洞分析
- 关于其他选择器以及选择器优先级详解
- 2016.05 第二周 群问题分享
- MyFlash——美团点评的开源MySQL闪回工具
- R语言关联规则可视化:扩展包arulesViz的介绍
- JS设置标签的内容和样式
- 大圣魔方——美团点评酒旅BI报表工具平台开发实践
- 详析获取标签
- 深度学习及AR在移动端打车场景下的应用
- R案例操作:RQDA和tm包结合进行文本挖掘
- 用Vue.js开发微信小程序:开源框架mpvue解析
- 分类模型的性能评估——以SAS Logistic回归为例: 混淆矩阵
- R语言,你要怎样画地图?
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- Transformers中的Beam Search高效实现
- 多边形裁剪图片升级啦!Cocos Creator !
- 使用curl进行服务器测试
- 打卡群刷题总结0805——不同的二叉搜索树
- 利用STS临时密钥服务快速搭建直传页面的实践
- Clickhouse在大数据分析平台-留存分析上的应用
- Rancher 高可用部署
- 为什么Web端登录需要验证码?
- 原创分享 TiDB 的列式存储引擎是如何实现的?
- Qt音视频开发5-vlc事件订阅
- matlab中使用VMD(变分模态分解)
- TKE中挂载文件到CFS子目录
- Nginx Ingress on TKE 部署最佳实践
- 腾讯地图点聚合开发-实现地图找房功能
- 机器学习Tips:关于Scikit-Learn的 10 个小秘密