分页

Django 提供了高级和低级的方法来帮助你管理分页数据——也就是说,数据被分割在几个页面上,并带有“上一页/下一页”链接。

Paginator

在幕后,所有分页方法都使用:Paginator 类。它完成了将 QuerySet 拆分为 Page 对象的所有繁重工作。

例如

将一个对象列表和每页要显示的项目数量传递给 Paginator,它会提供用于访问每个页面上的项目的方法:

  1. >>> from django.core.paginator import Paginator
  2. >>> objects = ["john", "paul", "george", "ringo"]
  3. >>> p = Paginator(objects, 2)
  4. >>> p.count
  5. 4
  6. >>> p.num_pages
  7. 2
  8. >>> type(p.page_range)
  9. <class 'range_iterator'>
  10. >>> p.page_range
  11. range(1, 3)
  12. >>> page1 = p.page(1)
  13. >>> page1
  14. <Page 1 of 2>
  15. >>> page1.object_list
  16. ['john', 'paul']
  17. >>> page2 = p.page(2)
  18. >>> page2.object_list
  19. ['george', 'ringo']
  20. >>> page2.has_next()
  21. False
  22. >>> page2.has_previous()
  23. True
  24. >>> page2.has_other_pages()
  25. True
  26. >>> page2.next_page_number()
  27. Traceback (most recent call last):
  28. ...
  29. EmptyPage: That page contains no results
  30. >>> page2.previous_page_number()
  31. 1
  32. >>> page2.start_index() # The 1-based index of the first item on this page
  33. 3
  34. >>> page2.end_index() # The 1-based index of the last item on this page
  35. 4
  36. >>> p.page(0)
  37. Traceback (most recent call last):
  38. ...
  39. EmptyPage: That page number is less than 1
  40. >>> p.page(3)
  41. Traceback (most recent call last):
  42. ...
  43. EmptyPage: That page contains no results

备注

请注意,你可以给 Paginator 一个列表/元组,一个 Django 的 QuerySet,或者任何其它具有 count()__len__() 方法的对象。在确定传递的对象中包含的对象数时,Paginator 将首先尝试调用 count(),如果传入的对象没有 count() 方法则回退到使用 len()。这允许像 Django 的 QuerySet 之类的对象在可用的情况下使用更高效的 count() 方法。

ListView 分页

django.views.generic.list.ListView 提供了一种内置的方式来对显示的列表进行分页。你可以通过在你的视图类中添加:paginate_by 属性来实现此目的,例如:

  1. from django.views.generic import ListView
  2. from myapp.models import Contact
  3. class ContactListView(ListView):
  4. paginate_by = 2
  5. model = Contact

这限制了每页的对象数量,并在 context 中添加了 paginatorpage_obj。要允许用户在页面之间导航,请在模板中添加指向下一页和上一页的链接,如下所示:

  1. {% for contact in page_obj %}
  2. {# Each "contact" is a Contact model object. #}
  3. {{ contact.full_name|upper }}<br>
  4. ...
  5. {% endfor %}
  6. <div class="pagination">
  7. <span class="step-links">
  8. {% if page_obj.has_previous %}
  9. <a href="?page=1">&laquo; first</a>
  10. <a href="?page={{ page_obj.previous_page_number }}">previous</a>
  11. {% endif %}
  12. <span class="current">
  13. Page {{ page_obj.number }} of {{ page_obj.paginator.num_pages }}.
  14. </span>
  15. {% if page_obj.has_next %}
  16. <a href="?page={{ page_obj.next_page_number }}">next</a>
  17. <a href="?page={{ page_obj.paginator.num_pages }}">last &raquo;</a>
  18. {% endif %}
  19. </span>
  20. </div>

在视图函数中使用 Paginator

下面是在视图函数中使用 Paginator 对查询结果集分页的例子:

  1. from django.core.paginator import Paginator
  2. from django.shortcuts import render
  3. from myapp.models import Contact
  4. def listing(request):
  5. contact_list = Contact.objects.all()
  6. paginator = Paginator(contact_list, 25) # Show 25 contacts per page.
  7. page_number = request.GET.get("page")
  8. page_obj = paginator.get_page(page_number)
  9. return render(request, "list.html", {"page_obj": page_obj})

在模板 list.html 中,你可以像上面 ListView 的模板一样,在页面之间加入导航。