分页功能是几乎所有的网站上都需要提供的功能,当你要展示的条目比较多时,必须进行分页,不但能减小数据库读取数据压力,也有利于用户浏览。
Django又很贴心的为我们提供了一个Paginator分页工具,但是不幸的是,这个工具功能差了点,不好添加CSS样式,所以前端的展示效果比较丑。如果你能力够,自己编写一个分页器,然后提交给Django官方吧,争取替代掉这个当前的分页器,我看好你哦!
但不管怎么样,当前的Paginator分页器,还是要学一下用一下的。
分页功能位于django.core.paginator
模块。
向Paginator
提供包含一些对象的列表,以及你想每一页显示几条,比如每页5条、10条、20条、100条等等,它就会为你提供访问的一系列API方法,示例如下:
>>> from django.core.paginator import Paginator >>> objects = ['john', 'paul', 'george', 'ringo'] >>> p = Paginator(objects, 2) # 对objects进行分页,虽然objects只是个字符串列表,但没关系,一样用。每页显示2条。 >>> p.count # 对象个数 4 >>> p.num_pages # 总共几页 2 >>> type(p.page_range) # `<type 'rangeiterator'>` in Python 2. <class 'range_iterator'> >>> p.page_range # 分页范围 range(1, 3) >>> page1 = p.page(1) # 获取第一页 >>> page1 <Page 1 of 2> >>> page1.object_list # 获取第一页的对象 ['john', 'paul'] >>> page2 = p.page(2) >>> page2.object_list ['george', 'ringo'] >>> page2.has_next() # 判断是否有下一页 False >>> page2.has_previous()# 判断是否有上一页 True >>> page2.has_other_pages() # 判断是否有其它页 True >>> page2.next_page_number() # 获取下一页的页码 Traceback (most recent call last): ... EmptyPage: That page contains no results >>> page2.previous_page_number() # 获取上一页的页码 1 >>> page2.start_index() # 从1开始计数的当前页的第一个对象 3 >>> page2.end_index() # 从1开始计数的当前页最后1个对象 4 >>> p.page(0) # 访问不存在的页面 Traceback (most recent call last): ... EmptyPage: That page number is less than 1 >>> p.page(3) # 访问不存在的页面 Traceback (most recent call last): ... EmptyPage: That page contains no results
简单地说,使用Paginator分四步走:
下面的例子假设你拥有一个Contacts模型。
在函数视图中使用Paginator,参考下面的代码:
from django.core.paginator import Paginator, EmptyPage, PageNotAnInteger from django.shortcuts import render from myapp.models import Contact def listing(request): contact_list = Contacts.objects.all() paginator = Paginator(contact_list, 25) # 每页显示25条 page = request.GET.get('page') contacts = paginator.get_page(page) return render(request, 'list.html', {'contacts': contacts})
在list.html
模板中,使用下面的范例来展示每个要显示的contact,以及最后的一个分页栏:
{% for contact in contacts %} {# 每个"contact"都是一个Contact模型对象. #} {{ contact.full_name|upper }}<br /> ... {% endfor %} {# 分页标签的HTML代码 #} <div class="pagination"> <span class="step-links"> {% if contacts.has_previous %} <a href="?page={{ contacts.previous_page_number }}">previous</a> {% endif %} <span class="current"> Page {{ contacts.number }} of {{ contacts.paginator.num_pages }}. </span> {% if contacts.has_next %} <a href="?page={{ contacts.next_page_number }}">next</a> {% endif %} </span> </div>
对于Django内置的通用列表视图类django.views.generic.list.ListView
,它和paginator结合得比较好,只需要简单的提供一个属性即可,如下所示:
from django.views.generic import ListView from myapp.models import Contact class ContactList(ListView): paginate_by = 2 model = Contact
paginate_by指示每页显示的联系人数量,并将page_obj和paginator对象添加到context上下文中,供模板渲染使用。下面是一个典型的模板页面:
{% for contact in page_obj %} {# Each "contact" is a Contact model object. #} {{ contact.full_name|upper }}<br> ... {% endfor %} <div class="pagination"> <span class="step-links"> {% if page_obj.has_previous %} <a href="?page=1">« first</a> <a href="?page={{ page_obj.previous_page_number }}">previous</a> {% endif %} <span class="current"> Page {{ page_obj.number }} of {{ page_obj.paginator.num_pages }}. </span> {% if page_obj.has_next %} <a href="?page={{ page_obj.next_page_number }}">next</a> <a href="?page={{ page_obj.paginator.num_pages }}">last »</a> {% endif %} </span> </div>
Paginator类拥有以下主要方法和属性:
方法:
Paginator.page(number)
返回指定页面的对象列表,比如第7页的所有内容,下标以1开始。如果提供的页码不存在,抛出InvalidPage异常。
Paginator.get_page(number)
上面方法的安全版本,不会弹出异常。如果输入的参数不是数字,返回第一页。如果输入的数字大于最大页码,返回最后一页。
属性:
Paginator.page(num)将返回一个Page对象,我们主要的操作都是基于Page对象的,它具有下面的方法和属性:
方法:
Page.start_index()
:返回当前页上的第一个对象,相对于分页列表的所有对象的序号,从1开始计数。 比如,将五个对象的列表分为每页两个对象,第二页的start_index()
会返回3。Page.end_index()
:返回当前页上的最后一个对象,相对于分页列表的所有对象的序号,从1开始。 比如,将五个对象的列表分为每页两个对象,第二页的end_index()
会返回4。属性:
在实际使用中,可能恶意也可能不小心,用户请求的页面,可能千奇百怪。正常我们希望是个合法的1,2,3之类,但请求的可能是‘apple’,‘1000000’,‘#’,这就有可能导致异常,需要特别处理。Django为我们内置了下面几个,Paginator相关异常。
后面两个异常都是InvalidPage的子类,所以你可以通过简单的except InvalidPage来处理它们。
如果用类视图的话会非常简单,只要在视图那里设置好,然后 template直接引用就行。