通過 Django Pagination 實現(xiàn)簡單分頁
掃描二維碼
隨時隨地手機(jī)看文章
當(dāng)博客上發(fā)布的文章越來越多時，通常需要進(jìn)行分頁顯示，以免所有的文章都堆積在一個頁面，影響用戶體驗。
Django 內(nèi)置的 Pagination 能夠幫助我們實現(xiàn)簡單的分頁功能，在上一篇教程[3]中我們使用腳本批量生成了幾百篇博客文章，正好用于測試分頁效果。
Paginator 類的常用方法
分頁功能由 Django 內(nèi)置的 Paginator類提供，這個類位于 django.core.paginator模塊，需要使用它時，只需在適當(dāng)?shù)牡胤綄?dǎo)入這個類即可：
from django.core.paginator import Paginator
下面的代碼摘自 Django 的官方文檔中 Pagination[4] 的示例，只需實例化一個 Paginator對象，并在實例化時傳入一個需要分頁的列表對象，就可以得到分頁后的對象。
# 對 item_list 進(jìn)行分頁，每頁包含 2 個數(shù)據(jù)。 >>> item_list = ['john', 'paul', 'george', 'ringo'] >>> p = Paginator(item_list, 2)
取特定頁的數(shù)據(jù)：
# 取第 2 頁的數(shù)據(jù) >>> page2 = p.page(2) >>> page2.object_list
['george', 'ringo']
查詢特定頁的當(dāng)前頁碼數(shù)：
>>> page2.number 2
查看分頁后的總頁數(shù)：
>>> p.num_pages 2
查看某一頁是否還有上一頁，以及查詢該頁上一頁的頁碼：
# 查詢第二頁是否還有上一頁 >>> page2.has_previous() True # 查詢第二頁上一頁的頁碼 >>> page2.previous_page_number() 1
查看某一頁是否還有下一頁，以及查詢該頁下一頁的頁碼：
# 查詢第二頁是否還有下一頁 >>> page2.has_next() False # 查詢第二頁下一頁的頁碼 >>> page2.next_page_number() Traceback (most recent call last): ... EmptyPage: That page contains no results
更多方法和屬性請參閱 Django Pagination 的官方文檔[5]。
用 Paginator 給文章列表分頁
使用上面的一些方法，我們可以實現(xiàn)一個類似于 Django 官方博客一樣的簡單分頁效果，效果如下。
這里 Django 的官方文檔中給出了一個在視圖函數(shù)中對列表進(jìn)行分頁的示例，這個視圖函數(shù)獲取一個聯(lián)系人列表并對其分頁：
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 個聯(lián)系人 page = request.GET.get('page') try: contacts = paginator.page(page) except PageNotAnInteger: # 如果用戶請求的頁碼號不是整數(shù)，顯示第一頁 contacts = paginator.page(1) except EmptyPage: # 如果用戶請求的頁碼號超過了最大頁碼號，顯示最后一頁 contacts = paginator.page(paginator.num_pages) return render(request, 'list.html', {'contacts': contacts})
這就是在視圖函數(shù)中使用分頁的代碼邏輯，你可以把它當(dāng)做一個模板應(yīng)用于自己的任何需要分頁的視圖函數(shù)。不過在我們的博客項目中，我們不必寫這些代碼了?；仡櫾?Django 官方推薦的姿勢：類視圖[6] 中的內(nèi)容，我們已將視圖函數(shù)轉(zhuǎn)換成了類視圖。而類視圖 ListView已經(jīng)幫我們寫好了上述的分頁邏輯，我們只需通過指定 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
這里我們設(shè)置了每 10 篇文章一頁。
在模板中設(shè)置分頁導(dǎo)航
接下來便是在模板中設(shè)置分頁導(dǎo)航，比如上一頁、下一頁的按鈕，以及顯示一些頁面信息。我們這里設(shè)置和 Django 官方博客那樣的分頁導(dǎo)航樣式（具體的樣式見上圖）。ListView傳遞了以下和分頁有關(guān)的模板變量供我們在模板中使用：
-
paginator，即 Paginator的實例。
-
page_obj，當(dāng)前請求頁面分頁對象。
-
is_paginated，是否已分頁。只有當(dāng)分頁后頁面超過兩頁時才算已分頁。
-
object_list，請求頁面的對象列表，和 post_list等價。所以在模板中循環(huán)文章列表時可以選 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 %}
其中 {{ }}模板變量中的內(nèi)容，其含義已在文章開頭部分的 Paginator 類的常用方法中已有介紹。另外還要注意一點，請求哪一個頁面通過 page查詢參數(shù)傳遞給 django 視圖，django 會根據(jù) page的值返回對應(yīng)頁面的文章列表，所以上一頁和下一頁超鏈接的 href 屬性指向的 url 帶上了 page 查詢參數(shù)。
最終我們得到如下的分頁效果：
當(dāng)然這只是一個簡單示例，分頁導(dǎo)航處的視覺效果并不是很好看，你可以自行為其添加 CSS 樣式使其看上去更加美觀。
進(jìn)一步拓展
使用 Django 內(nèi)置的 Pagination 只能實現(xiàn)上面的簡單分頁效果，但通常更加高級的分頁效果應(yīng)該像下圖這樣：
當(dāng)前頁面高亮顯示，且顯示當(dāng)前頁面前后幾頁的頁碼，始終顯示第一頁和最后一頁的頁碼，中間可能還有省略號的效果，表示還有未顯示的頁碼。
僅僅使用 Django Pagination 內(nèi)置的方法無法實現(xiàn)這樣的效果，需要自己寫分頁邏輯或者借助第三方庫。接下來我們將詳細(xì)說明如何借助第三方庫拓展 Pagination 以實現(xiàn)一個完善的分頁效果。
下載文檔
