Django 分页2 (Pagination)

Posted 2020-08-19 朝阳的向日葵

分页是Web应用常用的手法，Django提供了一个分页器类Paginator（django.core.paginator.Paginator)，可以很容易的实现分页的功能。该类有两个构造参数，一个是数据的集合，另一个是每页放多少条数据。Paginator的基本使用如下：

$python manage.py shell

>>> from django.core.paginator import Paginator

>>> objects = [‘john‘, ‘paul‘, ‘george‘, ‘ringo‘]

>>> p = Paginator(objects, 2)      #每页两条数据的一个分页器

>>> p.count        #数据总数

4

>>> p.num_pages      #总页数

2

>>>p.page_range       #页码的列表

[1, 2]

>>> page1 = p.page(1)     #第1页

>>> page1

<Page 1 of 2>

>>> page1.object_list     #第1页的数据

[‘john‘, ‘paul‘]

>>> page2 = p.page(2)

>>> page2.object_list      #第2页的数据

[‘george‘, ‘ringo‘]

>>> page2.has_next()     #是否有后一页

False

>>> page2.has_previous()   #是否有前一页

True

>>> page2.has_other_pages()   #是否有其他页

True

>>> page2.next_page_number()  #后一页的页码

3

>>> page2.previous_page_number()  #前一页的页码

1

>>> page2.start_index()   # 本页第一条记录的序数（从1开始）

3

>>> page2.end_index()    # 本页最后录一条记录的序数（从1开始）

4

>>> p.page(0)               #错误的页，抛出异常

...EmptyPage: That page number is less than 1

>>> p.page(3)              #错误的页，抛出异常

...EmptyPage: That page contains no results

案例教程：

Django中已经实现了很多功能，基本上只要我们需要的功能，都能够找到相应的包。要在Django中实现分页显示，只需要简单地使用Paginator就可以实现了。

首先，需要在应用的views.py中添加如下引用：

from django.core.paginator import Paginator
 from django.core.paginator import PageNotAnInteger
 from django.core.paginator import EmptyPage

然后，在需要使用分页的view函数中，添加如下代码：

blogs = Blog.objects.all() # Get released blogs
 paginator = Paginator(blogs, 8)
 try:
     blogs = paginator.page(page_num)
 except PageNotAnInteger:
     blogs = paginator.page(1)
 except EmptyPage:
     blogs = paginator.page(paginator.num_pages)

以上代码中，page_num是指的当前需要显示的页，要将当前页的内容显示出来，就跟使用原对象一样，基本没有什么区别，我们还是只需要像如下在模板中使用：

{% for blog in blogs %}
     {{ blog.name }}
     {{ blog.content }}
      ......
 {% endfor %}

最后，为了显示分页导航信息，我们需要在模板中添加如下代码：

{% if blogs.has_previous %}
        <a class=‘paginator‘ title=‘上一页‘ href=‘?page={{ blogs.previous_page_number }}‘><span>&lt;&lt;</span></a>
 {% endif %}
 {% for page in blogs.paginator.page_range %}
     {% if page = blogs.number %}
         <a class=‘paginator_current‘ title=‘当前页:{{ page }}‘><span>{{ page }}</span></a>
     {% else %}
         <a class=‘paginator‘ href=‘?page={{ page }}‘ title=‘{{ page }}‘><span>{{ page }}</span></a>
     {% endif %}
 {% endfor %}
 {% if blogs.has_next %}
     <a class=‘paginator‘ title=‘下一页‘ href=‘?page={{ blogs.next_page_number }}‘><span>&gt;&gt;</span></a>
 {% endif %}

OK，一切就这么简单，对数据进行分页显示就完成了。

但是，等等，这里好像还有问题，如果我的数据很多，分出来的页面数也很多，那岂不是分页导航将显示很长的一串数字？

的确是这样，page_range根据总页数，返回从1到总页数之间在数字序列，例如总页数是5， 则page_range返回的值将是[1,2,3,4,5]，以此类推，对我们来说的确是个问题。

正是因为有问题，因此也才有了我的博客，下面才是我真正的目的所在，扩展框架自带的Paginator，废话少说，直接上代码：

from django.core.paginator import Paginator
  
  class JuncheePaginator(Paginator):
      def __init__(self, object_list, per_page, range_num=5, orphans=0, allow_empty_first_page=True):
          Paginator.__init__(self, object_list, per_page, orphans, allow_empty_first_page)
          self.range_num = range_num
  
      def page(self, number):
          self.page_num = number
          return super(JuncheePaginator, self).page(number)
 
      def _page_range_ext(self):
          num_count = 2 * self.range_num + 1
          if self.num_pages <= num_count:
              return range(1, self.num_pages + 1)
          num_list = []
          num_list.append(self.page_num)
          for i in range(1, self.range_num + 1):
              if self.page_num - i <= 0:
                  num_list.append(num_count + self.page_num - i)
              else:
                  num_list.append(self.page_num - i)
 
              if self.page_num + i <= self.num_pages:
                  num_list.append(self.page_num + i)
              else:
                  num_list.append(self.page_num + i - num_count)
          num_list.sort()
          return num_list
      page_range_ext = property(_page_range_ext)

为了减少文章篇幅，我特意将一些注释去掉了。现在简单地解释一 下。

__init__()函数不用说了吧，就是重载了一下，添加了一个range_num参数，代表在可能的情况下，当前页左右各显示多少个页标签，默认值为5。

page()函数是对父类Paginator的page()函数的重写，主要是为了记录当前页。

核心是_page_range_ext()函数，它实现了我们根据page_num的情况来返回恰当的页面列表，page_num取默认值的情况下，如果当前页是8，则我们返回的页数列表就应该是[3,4,5,6,7,8,9,10,11,12,13]，但如果说是当前页是2，则会返回[1,2,3,4,5,6,7,8,9,10,11]，其余的以此类推。具体算法我就不仔细分析了，大家可以参看源代码，个人感觉还可以优化，但我现在也就能用就行。

接下来还需要在views.py中将以下语句：

paginator = Paginator(blogs, 8)

改为：

paginator = JuncheePaginator(blogs, 8)

在模板中，将以下语句：

{% for page in blogs.paginator.page_range %}

改为：

{% for page in blogs.paginator.page_range_ext %}

其它的事情，呵呵，那就是快去美化你的页面吧！