Django的分页 Paginator

分页功能是几乎所有的网站上都需要提供的功能,当你要展示的条目比较多时,必须进行分页,不但能减小数据库读取数据压力,也有利于用户浏览。

下面我们来介绍一下Django的分页。

实例演示

向Paginator提供包含一些对象的列表,以及你想每一页显示几条,比如每页5条、10条、20条、100条等等,它就会为你提供访问的一系列API方法,示例如下:

简单地说,使用Paginator分四步走:

  • 使用任何方法,获取要展示的对象列表QuerySet;
  • 将列表和每页个数传递给Paginator,返回一个分页对象;
  • 调用该对象的各种方法,获取各种分页信息;
  • 在HTML模板中,使用上面的分页信息构建分页栏。

在视图中使用Paginator

下面的例子假设你拥有一个已经导入的Contacts模型。

在视图函数中使用Paginator,参考下面的代码:

Paginator对象

Paginator类拥有以下方法和属性:

方法:

Paginator.page(number)[source]

返回指定页面的对象列表,比如第7页的所有内容,下标以1开始。如果提供的页码不存在,抛出InvalidPage异常。

属性

  • Paginator.count:所有页面的对象总数。
  • Paginator.num_pages:页面总数。
  • Paginator.page_range:基于1的页数范围迭代器。

处理异常

在实际使用中,可能恶意也可能不小心,用户请求的页面,可能千奇百怪。正常我们希望是个合法的1,2,3之类,但请求的可能是‘apple’,‘1000000’,‘#’,这就有可能导致异常,需要特别处理。Django为我们内置了下面几个,Paginator相关异常。

  • exception InvalidPage[source]:异常的基类,当paginator传入一个无效的页码时抛出。
  • exception PageNotAnInteger[source]:当向page()提供一个不是整数的值时抛出。
  • exception EmptyPage[source]:当向page()提供一个有效值,但是那个页面上没有任何对象时抛出。

后面两个异常都是InvalidPage的子类,所以你可以通过简单的except InvalidPage来处理它们。

Page对象

Paginator.page()将返回一个Page对象,我们主要的操作都是基于Page对象的,它具有下面的方法和属性:

方法

  • Page.has_next()[source]:如果有下一页,则返回True。
  • Page.has_previous()[source]:如果有上一页,返回 True。
  • Page.has_other_pages()[source]:如果有上一页或下一页,返回True。
  • Page.next_page_number()[source]:返回下一页的页码。如果下一页不存在,抛出InvalidPage异常。
  • Page.previous_page_number()[source]:返回上一页的页码。如果上一页不存在,抛出InvalidPage异常。
  • Page.start_index()[source]:返回当前页上的第一个对象,相对于分页列表的所有对象的序号,从1开始计数。 比如,将五个对象的列表分为每页两个对象,第二页的start_index()会返回3。
  • Page.end_index()[source]:返回当前页上的最后一个对象,相对于分页列表的所有对象的序号,从1开始。 比如,将五个对象的列表分为每页两个对象,第二页的end_index()会返回4。

属性:

  • Page.object_list:当前页上所有对象的列表。
  • Page.number:当前页的序号,从1开始计数。
  • Page.paginator:当前Page对象所属的Paginator对象。

本文为转载文章,贵在分享,版权归原作者及原出处所有,如涉及版权等问题,请及时与我联系。
原文出处:刘江的博客教程
原文链接:https://www.liujiangblog.com/course/django/173

发表评论

邮箱地址不会被公开。 必填项已用*标注