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