文章目录
- 0.思路引导
- 1.Paginator 类的常用方法
- 2.用 Paginator 给文章列表分页
- 3.在模板中设置分页导航
- 4.效果展示
0.思路引导
1)当博客上发布的文章越来越多时,通常需要进行分页显示,以免所有的文章都堆积在一个页面,影响用户体验。
2)Django 内置的 Pagination 能够帮助我们实现简单的分页功能
1.Paginator 类的常用方法
分页功能由 Django 内置的 Paginator 类提供,这个类位于 django.core.paginator 模块,需要使用它时,只需在适当的地方导入即可:
from django.core.paginator import Paginator
使用时需实例化一个 Paginator 对象,并在实例化时传入一个需要分页的列表对象,就可以得到分页后的对象。
# 对 item_list 进行分页,每页包含 2 个数据。
>>> item_list = ['john', 'paul', 'george', 'ringo']
>>> p = Paginator(item_list, 2)
具体的使用请查看官方文档
2.用 Paginator 给文章列表分页
Django 的官方文档中给出了一个在视图函数中对列表进行分页的示例,下面的视图函数获取一个联系人列表并对其分页:
from django.core.paginator import Paginator, EmptyPage, PageNotAnInteger
from django.shortcuts import renderdef 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 已经帮我们写好了上述的分页逻辑,我们只需通过指定 paginate_by 属性来开启分页功能即可,即在类视图中指定 paginate_by 属性的值:
文件位置:blog/views.py
class IndexView(ListView):model = Posttemplate_name = 'blog/index.html'context_object_name = 'post_list'# 指定 paginate_by 属性后开启分页功能,其值代表每一页包含多少篇文章paginate_by = 10
这里我们设置了每 10 篇文章一页。
3.在模板中设置分页导航
接下来便是在模板中设置分页导航,比如上一页、下一页的按钮,以及显示一些页面信息。
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 %}
另外需要注意的是,请求目的页,是通过 page 查询参数传递给 django 视图,django 会根据 page 的值返回对应页面的文章列表,所以上一页和下一页超链接的 href 属性指向的 url 带上了 page 查询参数。