經過 Django Pagination 實現簡單分頁

做者：HelloGitHub- 追夢人物

文中涉及的示例代碼，已同步更新到 HelloGitHub-Team 倉庫

當博客上發佈的文章愈來愈多時，一般須要進行分頁顯示，以避免全部的文章都堆積在一個頁面，影響用戶體驗。

Django 內置的 Pagination 可以幫助咱們實現簡單的分頁功能，在上一篇教程中咱們使用腳本批量生成了幾百篇博客文章，正好用於測試分頁效果。

Paginator 類的經常使用方法

分頁功能由 Django 內置的 Paginator 類提供，這個類位於 django.core.paginator 模塊，須要使用它時，只需在適當的地方導入這個類便可：

from django.core.paginator import Paginator
複製代碼

下面的代碼摘自 Django 的官方文檔中 Pagination 的示例，只需實例化一個 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()
Traceback (most recent call last):
...
EmptyPage: That page contains no results
複製代碼

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

用 Paginator 給文章列表分頁

使用上面的一些方法，咱們能夠實現一個相似於 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})
複製代碼

這就是在視圖函數中使用分頁的代碼邏輯，你能夠把它當作一個模板應用於本身的任何須要分頁的視圖函數。不過在咱們的博客項目中，咱們沒必要寫這些代碼了。回顧在 Django 官方推薦的姿式：類視圖 中的內容，咱們已將視圖函數轉換成了類視圖。而類視圖 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 類的經常使用方法中已有介紹。另外還要注意一點，請求哪個頁面經過 page 查詢參數傳遞給 django 視圖，django 會根據 page 的值返回對應頁面的文章列表，因此上一頁和下一頁超連接的 href 屬性指向的 url 帶上了 page 查詢參數。

最終咱們獲得以下的分頁效果：

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

進一步拓展

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

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

僅僅使用 Django Pagination 內置的方法沒法實現這樣的效果，須要本身寫分頁邏輯或者藉助第三方庫。接下來咱們將詳細說明如何藉助第三方庫拓展 Pagination 以實現一個完善的分頁效果。

『講解開源項目系列』——讓對開源項目感興趣的人再也不畏懼、讓開源項目的發起者再也不孤單。跟着咱們的文章，你會發現編程的樂趣、使用和發現參與開源項目如此簡單。歡迎留言聯繫咱們、加入咱們，讓更多人愛上開源、貢獻開源～