通过 Django Pagination 实现简单分页功能
作者:HelloGitHub-追梦人物
文中所涉及的示例代码,已同步更新到HelloGitHub-Team仓库
当博客上发布的文章越来越多时,通常需要进行分页显示,以免所有的文章都堆积在一个页面,影响用户体验。
Django内置的Pagination能够帮助我们实现简单的分页功能,在上一篇教程中我们使用脚本批量生成了几百篇博客文章,正好用于测试分页效果。
Paginator类的常用方法
分页功能由Django内置的Paginator类提供,这个类位于django.core.paginator模块,需要使用它时,只需在适当的地方导入这个类即可:
fromdjango.core.paginatorimportPaginator
下面的代码摘自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(mostrecentcalllast): ... EmptyPage:Thatpagecontainsnoresults
更多方法和属性请参阅DjangoPagination的官方文档。
用Paginator给文章列表分页
使用上面的一些方法,我们可以实现一个类似于Django官方博客一样的简单分页效果,效果如下。
这里Django的官方文档中给出了一个在视图函数中对列表进行分页的示例,这个视图函数获取一个联系人列表并对其分页:
fromdjango.core.paginatorimportPaginator,EmptyPage,PageNotAnInteger fromdjango.shortcutsimportrender deflisting(request): contact_list=Contacts.objects.all() paginator=Paginator(contact_list,25)#每页显示25个联系人 page=request.GET.get('page') try: contacts=paginator.page(page) exceptPageNotAnInteger: #如果用户请求的页码号不是整数,显示第一页 contacts=paginator.page(1) exceptEmptyPage: #如果用户请求的页码号超过了最大页码号,显示最后一页 contacts=paginator.page(paginator.num_pages) returnrender(request,'list.html',{'contacts':contacts})
这就是在视图函数中使用分页的代码逻辑,你可以把它当做一个模板应用于自己的任何需要分页的视图函数。不过在我们的博客项目中,我们不必写这些代码了。回顾在Django官方推荐的姿势:类视图中的内容,我们已将视图函数转换成了类视图。而类视图ListView已经帮我们写好了上述的分页逻辑,我们只需通过指定paginate_by属性来开启分页功能即可,即在类视图中指定paginate_by属性的值:
blog/views.py classIndexView(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 {%ifis_paginated%}{%ifpage_obj.has_previous%} 上一页 {%endif%} 第{{page_obj.number}}页/共{{paginator.num_pages}}页 {%ifpage_obj.has_next%} 下一页 {%endif%}
其中{{}}模板变量中的内容,其含义已在文章开头部分的Paginator类的常用方法中已有介绍。另外还要注意一点,请求哪一个页面通过page查询参数传递给django视图,django会根据page的值返回对应页面的文章列表,所以上一页和下一页超链接的href属性指向的url带上了page查询参数。
最终我们得到如下的分页效果:
当然这只是一个简单示例,分页导航处的视觉效果并不是很好看,你可以自行为其添加CSS样式使其看上去更加美观。
进一步拓展
使用Django内置的Pagination只能实现上面的简单分页效果,但通常更加高级的分页效果应该像下图这样:
当前页面高亮显示,且显示当前页面前后几页的页码,始终显示第一页和最后一页的页码,中间可能还有省略号的效果,表示还有未显示的页码。
仅仅使用DjangoPagination内置的方法无法实现这样的效果,需要自己写分页逻辑或者借助第三方库。接下来我们将详细说明如何借助第三方库拓展Pagination以实现一个完善的分页效果。
总结
以上所述是小编给大家介绍的通过DjangoPagination实现简单分页功能,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对毛票票网站的支持!
如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!
声明:本文内容来源于网络,版权归原作者所有,内容由互联网用户自发贡献自行上传,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任。如果您发现有涉嫌版权的内容,欢迎发送邮件至:czq8825#qq.com(发邮件时,请将#更换为@)进行举报,并提供相关证据,一经查实,本站将立刻删除涉嫌侵权内容。