有的时候我们会在页面中展示大量数据,全部都放在一页可能会降低用户体验,Django提供了一个Paginator类来帮助我们管理分页数据。
起步
介绍分页器对象的一些属性和方法
1. 引入该类及相关异常模块:
from django.core.paginator import Paginator, PageNotAnInteger, EmptyPage
1
Paginator:分页器对象
PageNotAnInteger:页码不是一个整数时引发该异常
EmptyPage:页码不在有效范围时(即数据为空)引发该异常
2. 分页器对象
分页器对象的属性:
object_list, 对象列表即查询到的数据
per_page, 每一页展示的内容
orphans=0, 这是一个缺省参数,如果最后一页的数据小于这个值,会合并到上一页
allow_empty_first_page=True, 允许首页为空 ,默认为True
分页器对象的方法:
方法 描述
page 返回一个Page对象
count 返回对象列表(数据)的长度
num_pages 返回总页数
page_range 返回页码列表
3. Page对象
Page对象是一般用来指定当前页
Page对象的属性,
object_list:同样是指对象列表,不过只包含当前页的对象
number:当前页面的页码
paginator :指对应的分页器对象(Paginator )
注意,Paginator对象是由我们进行实例化的,而Page对象在Paginator对象使用page方法时实现
Page对象的方法:
方法 描述
has_next 是否有下一页
has_previous 是否有上一页
has_other_pages 是否有上一页或下一页
next_page_number 返回下一页的页码
previous_page_number 返回上一页的页码
start_index 返回当前页起始的对象序号
end_index 返回当前页结束的对象序号
应用
介绍完Paginator对象,已经基本可以亲自动手实现一个分页器对象了,但暂时我们不需要那样做。接下来,来应用该分页器对象,我已经封装好了一个函数来使用它。
1 def split_page(object_list, request, per_page=8): 2 paginator = Paginator(object_list, per_page) 3 # 取出当前需要展示的页码, 默认为1 4 page_num = request.GET.get('page', default='1') 5 # 根据页码从分页器中取出对应页的数据 6 try: 7 page = paginator.page(page_num) 8 except PageNotAnInteger as e: 9 # 不是整数返回第一页数据 10 page = paginator.page('1') 11 page_num = 1 12 except EmptyPage as e: 13 # 当参数页码大于或小于页码范围时,会触发该异常 14 print('EmptyPage:{}'.format(e)) 15 if int(page_num) > paginator.num_pages: 16 # 大于 获取最后一页数据返回 17 page = paginator.page(paginator.num_pages) 18 else: 19 # 小于 获取第一页 20 page = paginator.page(1) 21 22 # 这部分是为了再有大量数据时,仍然保证所显示的页码数量不超过10, 23 page_num = int(page_num) 24 if page_num < 6: 25 if paginator.num_pages <= 10: 26 dis_range = range(1, paginator.num_pages + 1) 27 else: 28 dis_range = range(1, 11) 29 elif (page_num >= 6) and (page_num <= paginator.num_pages - 5): 30 dis_range = range(page_num - 5, page_num + 5) 31 else: 32 dis_range = range(paginator.num_pages - 9, paginator.num_pages + 1) 33 34 data = {'page': page, 'paginator': paginator, 'dis_range ': dis_range } 35 return data
1 <div class="container"> 2 <nav aria-label="Page navigation"> 3 <ul class="pagination"> 4 5 <!--上一页--> 6 <li class="{% if not page.has_previous %}disabled{% endif %}"> 7 {% if page.has_previous %} 8 <a href="{% url 'index' %}?page={{ page.previous_page_number }}" aria-label="Previous"> 9 {% endif %} 10 <span aria-hidden="true">«</span> 11 </a> 12 </li> 13 14 <!--页码--> 15 <!--这里展示页码使用传递过来的dis_range --> 16 {% for num in dis_range %} 17 <li class="{% if num == page.number %}active{% else %}{% endif %}" > 18 <a href="{% url 'index' %}?page={{ num }}">{{ num }}</a> 19 </li> 20 {% endfor %} 21 22 <!--下一页--> 23 <li class="{% if not page.has_next %}disabled{% endif %}"> 24 {% if page.has_next %} 25 <a href="{% url 'index' %}?page={{ page.next_page_number }}" aria-label="Next"> 26 {% endif %} 27 <span aria-hidden="true">»</span> 28 </a> 29 </li> 30 31 </ul> 32 </nav> 33 </div>
使用了bootstrap中的基本分页,展示效果如下图所示:
对应模板代码: