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官方博客简单分页效果

这里,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 类的常用方法中已有介绍。最终我们得到如下的分页效果:

Django 简单分页效果

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

进一步拓展

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

高级分页效果图

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

仅仅使用 Django Pagination 内置的方法无法实现这样的效果,需要我们写一些额外的代码来拓展 Pagination 的功能。接下来我们将详细说明该如何拓展 Pagination 以实现一个完善的分页效果。

总结

本章节的代码位于:Step19: simple pagination

如果遇到问题,请通过下面的方式寻求帮助。

  • 在下方评论区留言。
  • 将问题的详细描述通过邮件发送到 djangostudyteam@163.com,一般会在 24 小时内回复。
  • Pythonzhcn 社区的新手问答版块 发布帖子。

-- EOF --


16 条评论 / 9 人参与
Peng-Xu

为什么显示分页效果无效呢,把源代码下载下来在本地运行,没有任何报错,但就是分页效果出不来啊!


huyang233 Peng-Xu

第一,可能是类视图里没写好

第二,可能是index里的效果写错了

第三,分页数据太大了,改成1,2这种小数字试试,没有下一页他不会自动分页的


彭志鹏

尝试了下不用类视图做的

```views.py

def index(request): 

post_list=Post.objects.all() 

paginator=Paginator(post_list,5) 

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,'blog/index.html',context={'contacts':contacts})

```

```index.html

div class="pagination-simple"> 

 {% if contacts.has_previous %} 

 <a href="?page={{contacts.previous_page_number }}">上一页</a> 

 {% endif %} 

 <span class="current">第{{ contacts.number }}页/共{{ contacts.paginator.num_pages }}页</span> 

 {% if contacts.has_next %} <a href="?page={{ contacts.next_page_number }}">下一页</a> 

 {% endif %}

 </div>

```


Alan

怎么弄都没有分页的效果,不知道错在哪里了


Alan Alan

好了,是我的nginx代理有问题


DawnOct
这相当于是,提前将所有的数据加载进内存了. 没有达到分页加载数据啊..

追梦人物 [博主] DawnOct
为什么呢?

DawnOct 追梦人物 [博主]
我的意思是, 比如数据库里有1000条数据, 通过contact_list = Contacts.objects.all()将1000条数据读取出来了, 然后只是在页面展示的时候,做了分页. 这样的话,如果数据库有一百万条, 而用户只需要看前两条的页面,这样是不是体验会不太好? 我对分页的理解是, 用户点击了第二页,再去数据库读取第二页数据.

追梦人物 [博主] DawnOct
Contacts.objects.all() 在没有被 evaluated(求值?) 时,是没有 hit 数据库的。虽然我没有看过 Pagination 的源码,但我猜测在内部实现中肯定用了数据库的 offset,这样真正从数据库取的数据就是用户请求的那一页的数据。

DawnOct 追梦人物 [博主]
神奇~~~ 感谢楼主... 期待楼主有机会讲解一下django rest framework

追梦人物 [博主] DawnOct
那个我就没用过了,目前还没碰到类似需求。

rsd 追梦人物 [博主]

context.get("paginator")打印了一下paginator.__dict__,它竟然查的全部。。。


dengwen168
博主,您好,看你的教程设置数据库的时候设置了一个tag字段,请问一下下次能不能写个教程介绍一下,如何像其他cms那样,在一个区块显示所有的tags?谢谢!

追梦人物 [博主] dengwen168
嗯,相关教程正在撰写中。

kuaidanian
感谢,正在学习博主的教程,受益颇多,准备就以博主的教程搭建自己的博客,希望博主以后能多写一些教程,支持博主。

追梦人物 [博主] kuaidanian
感谢支持,会一直写的。