ListView 中的分頁

Paginator 類的常用方法

分頁功能由 Django 內置的 Paginator 類提供。這個類位於 django/core/paginator.py，需要使用它時，只需在適當的地方導入這個類即可。下面的代碼摘自 Django 的官方文檔中 Pagination 的示例。

from django.core.paginator import Paginator

只需實例化一個 Paginator 對象，並在實例化時傳入一個需要分頁的列表對象，就可以得到分頁后的對象數據。

# 對 item_list 進行分頁，每頁包含 2 個數據。
>>> item_list = ['john', 'paul', 'george', 'ringo'] >>> p = Paginator(item_list, 2)

取特定頁的數據：

# 取第 2 頁的數據
>>> page2 = p.page(2) >>> page2.object_list ['george', 'ringo']

查詢特定頁的當前頁碼數：

>>> page2.number 2

查看分頁后的總頁數：

>>> p.num_pages 2

查看某一頁是否還有上一頁，以及查詢該頁上一頁的頁碼：

# 查詢第二頁是否還有上一頁
>>> page2.has_previous() True # 查詢第二頁上一頁的頁碼 >>> page2.previous_page_number() 1

查看某一頁是否還有下一頁，以及查詢該頁下一頁的頁碼：

# 查詢第二頁是否還有下一頁
>>> page2.has_next() False # 查詢第二頁下一頁的頁碼 >>> page2.next_page_number() django.core.paginator.EmptyPage: That page contains no results

更多方法和屬性請參閱 Django Pagination 的官方文檔。

用 Paginator 給文章列表分頁

使用上面的一些方法，我們可以實現一個類似於 Django 官方博客一樣的簡單分頁效果，效果如下。

Django官方博客簡單分頁效果

這里，Django 的官方文檔中給出了一個在視圖函數中對列表進行分頁的示例，這個視圖函數獲取一個聯系人列表並對其分頁：

from django.core.paginator import Paginator, EmptyPage, PageNotAnInteger from django.shortcuts import render def listing(request): contact_list = Contacts.objects.all() paginator = Paginator(contact_list, 25) # 每頁顯示 25 個聯系人 page = request.GET.get('page') try: contacts = paginator.page(page) except PageNotAnInteger: # 如果用戶請求的頁碼號不是整數，顯示第一頁 contacts = paginator.page(1) except EmptyPage: # 如果用戶請求的頁碼號超過了最大頁碼號，顯示最后一頁 contacts = paginator.page(paginator.num_pages) return render(request, 'list.html', {'contacts': contacts})

這就是在視圖函數中使用分頁的代碼邏輯，你可以把它當做一個模板應用於自己的任何需要分頁的視圖函數。不過在我們的博客項目中，我們不必寫這些代碼了。回顧在基於類的通用視圖：ListView 和 DetailView 中的內容，我們已將視圖函數轉換成了類視圖。而類視圖 ListView 已經幫我們寫好了上述的分頁邏輯，我們只需通過指定 paginate_by 屬性來開啟分頁功能即可，即在類視圖中指定 paginate_by 屬性的值：

blog/views.py class IndexView(ListView): model = Post template_name = 'blog/index.html' context_object_name = 'post_list' # 指定 paginate_by 屬性后開啟分頁功能，其值代表每一頁包含多少篇文章 paginate_by = 10

這里我們設置了每 10 篇文章一頁，當然你的測試數據可能不夠。為了看到分頁效果，你可以把這個數值減小。這樣首頁的文章列表就已經分好頁了。

在模板中設置分頁導航

接下來便是在模板中設置分頁導航，比如上一頁、下一頁的按鈕，以及顯示一些頁面信息。我們這里設置和 Django 官方博客那樣的分頁導航樣式（具體的樣式見上圖）。ListView 傳遞了以下和分頁有關的模板變量供我們在模板中使用：

paginator ，即 Paginator 的實例。
page_obj ，當前請求頁面分頁對象。
is_paginated，是否已分頁。只有當分頁后頁面超過兩頁時才算已分頁。
object_list，請求頁面的對象列表，和 post_list 等價。所以在模板中循環文章列表時可以選 post_list ，也可以選 object_list。

模板中使用示例：

templates/blog/index.html

{% if is_paginated %}
<div class="pagination-simple"> <!-- 如果當前頁還有上一頁，顯示一個上一頁的按鈕 --> {% if page_obj.has_previous %} <a href="?page={{ page_obj.previous_page_number }}">上一頁</a> {% endif %} <!-- 顯示當前頁面信息 --> <span class="current">第 {{ page_obj.number }} 頁 / 共 {{ paginator.num_pages }} 頁</span> <!-- 如果當前頁還有下一頁，顯示一個下一頁的按鈕 --> {% if page_obj.has_next %} <a href="?page={{ page_obj.next_page_number }}">下一頁</a> {% endif %} </div> {% endif %}

其中 {{ }} 模板變量中的內容，其含義已在文章開頭部分的Paginator 類的常用方法中已有介紹。最終我們得到如下的分頁效果：

Django 簡單分頁效果

當然這只是一個簡單示例，分頁導航處的視覺效果並不是很好看，你可以自行為其添加 CSS 樣式使其看上去更加美觀。

進一步拓展

使用 Django 內置的 Pagination 只能實現上面的簡單分頁效果，但通常更加高級的分頁效果應該像下圖這樣：

高級分頁效果圖

當前頁面高亮顯示，且顯示當前頁面前后幾頁的頁碼，始終顯示第一頁和最后一頁的頁碼，中間可能還有省略號的效果，表示還有未顯示的頁碼。

僅僅使用 Django Pagination 內置的方法無法實現這樣的效果，需要我們寫一些額外的代碼來拓展 Pagination 的功能。接下來我們將詳細說明該如何拓展 Pagination 以實現一個完善的分頁效果。

總結

本章節的代碼位於：Step19: simple pagination。