分頁器組件

1、Django分頁器簡介

　　分頁功能是幾乎所有的網站上都需要提供的功能，當你要展示的條目比較多時，必須進行分頁，不但能減小數據庫讀取數據壓力，也有利於用戶瀏覽。

Django又很貼心的為我們提供了一個Paginator分頁工具，但是不幸的是，這個工具功能差了點，不好添加CSS樣式，所以前端的展示效果比較丑。如果你能力夠，自己編寫一個分頁器，然后提交給Django官方吧，爭取替代掉這個當前的分頁器，我看好你哦！

但不管怎么樣，當前的Paginator分頁器，還是值得學一下用一下的。

一、實例展示

向Paginator提供包含一些對象的列表，以及你想每一頁顯示幾條，比如每頁5條、10條、20條、100條等等，它就會為你提供訪問的一系列API方法，示例如下：

>>> from django.core.paginator import Paginator
>>> objects = ['john', 'paul', 'george', 'ringo']
>>> p = Paginator(objects, 2)  # 對objects進行分頁，雖然objects只是個字符串列表，但沒關系，一樣用。每頁顯示2條。

>>> p.count   # 對象個數
4
>>> p.num_pages  # 總共幾頁
2
>>> type(p.page_range)  # `<type 'rangeiterator'>` in Python 2.
<class 'range_iterator'>
>>> p.page_range  # 分頁范圍
range(1, 3)

>>> page1 = p.page(1) # 獲取第一頁
>>> page1
<Page 1 of 2>
>>> page1.object_list # 獲取第一頁的對象
['john', 'paul']

>>> page2 = p.page(2)
>>> page2.object_list
['george', 'ringo']
>>> page2.has_next()  # 判斷是否有下一頁
False
>>> page2.has_previous()# 判斷是否有上一頁
True
>>> page2.has_other_pages() # 判斷是否有其它頁
True
>>> page2.next_page_number() # 獲取下一頁的頁碼
Traceback (most recent call last):
...
EmptyPage: That page contains no results
>>> page2.previous_page_number() # 獲取上一頁的頁碼
1
>>> page2.start_index() # 從1開始計數的當前頁的第一個對象
3
>>> page2.end_index() # 從1開始計數的當前頁最后1個對象
4

>>> p.page(0)  # 訪問不存在的頁面
Traceback (most recent call last):
...
EmptyPage: That page number is less than 1
>>> p.page(3) # 訪問不存在的頁面
Traceback (most recent call last):
...
EmptyPage: That page contains no results

 

簡單地說，使用Paginator分四步走：

• 使用任何方法，獲取要展示的對象列表QuerySet；
• 將列表和每頁個數傳遞給Paginator，返回一個分頁對象；
• 調用該對象的各種方法，獲取各種分頁信息；
• 在HTML模板中，使用上面的分頁信息構建分頁欄。

二、在視圖中使用Paginator

下面的例子假設你擁有一個已經導入的Contacts模型。

在視圖函數中使用Paginator，參考下面的代碼：

視圖函數views

from django.shortcuts import render, HttpResponse
# Create your views here.
from app01.models import *
from django.core.paginator import Paginator, EmptyPage
def page_test(request):
    # 在Book表中生成100表記錄
    # book_list=[]
    # for i in range(100):
    #     # Book.objects.create(name='book%s'%i,price=10+i)
    #     book=Book(name='book%s'%i,price=10+i)
    #     book_list.append(book)
    # Book.objects.bulk_create(book_list,10)
    # 獲取當前頁碼

    book_list = Book.objects.all()       #從數據庫表中獲取Book表中的所有記錄的queryset對象
    paginator = Paginator(book_list, 10)  #通過分頁器類實例化出一個分頁器對象，每頁顯示10條記錄
    # print(book_list)              #queryset對象,
    # print(paginator.count)        #對象個數  100
    # print(paginator.num_pages)    #總共分了多少頁（總頁碼數）  10
    # print(paginator.page_range)  #分頁范圍  range(1, 11)
    try:
        # http://127.0.0.1:8000/page_test/?page=1
        # 用戶輸入url中page值可能不為整數或者是超過我們分頁數的范圍，我們應該捕獲異常，然后讓其跳到第一頁
        current_page = int(request.GET.get('page', 1))    #獲取請求的page值，默認是page值是1，得到的是字符串類型
        # print(type(request.GET.get('page', 1)))   # <class 'str'>
        # print(current_page)    #默認是1，當我們請求不同的頁面，就會顯示當前是第一頁的值
        # 生成page對象，傳頁碼，會生成對應頁碼數據
        page = paginator.page(current_page)   #調用分頁器對象下的page方法，看源碼直到其返回的是一個Page類
        # print(page)     #<Page 1 of 10>    ,當點擊前端頁面的分頁數字也會跟着變化，點第五頁變為<Page 5 of 10>
    except Exception:           #捕獲萬能異常類型，當捕獲到異常就會走except下的內容
        current_page = 1        #如果用戶輸入的符合法，讓當前頁強制為第一頁
        page = paginator.page(1)#
    # for i in page.object_list:      #獲取當前頁的對象是一個列表，可以循環取出
    #     print(i)
    # for i in page:
    #     # 當前頁碼的每條數據
    #     print(i)
    # 是否有下一頁
    # print(page.has_next())
    # # 是否有上一頁
    # print(page.has_previous())
    # # 下一頁頁碼
    # print(page.next_page_number())
    # # 上一頁頁碼
    # print(page.previous_page_number())
    #######################################重點##############################################
    # 顯示前5 后5 總共11頁---------核心判斷分頁面的范圍，保持一個固定的長度
    if paginator.num_pages > 11:
        if current_page - 5 < 1:
            page_range = range(1, 12)
        elif current_page + 5 > paginator.num_pages:
            page_range = range(paginator.num_pages - 10, paginator.num_pages + 1)
        else:
            page_range = range(current_page - 5, current_page + 6)
    else:
        page_range = paginator.page_range
    # 通過locals()可以將后端的數據渲染到后端
    return render(request, 'page_test.html', locals())
    #######################################重點##############################################

template模板中page_test.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <link rel="stylesheet" href="/static/bootstrap-3.3.7-dist/css/bootstrap.min.css">
    <title>Title</title>
</head>
<body>
<ul>
<!--#################################顯示頁面內容####################################-->
    <!--視圖函數從數據庫中拿到數據，然后返回渲染到前端頁面，通過for循環就可以拿到不同也的所有記錄條數-->
    {% for book in page %}
        <li>{{ book.name }}</li>
    {% endfor %}
</ul>
<!--#################################顯示頁面內容####################################-->

 <!--引入bootstrap樣式-->
<nav aria-label="Page navigation">
    <ul class="pagination">
         <!--判斷拿到的頁面是否有上一頁，有上一頁則可點上一頁將上一頁的記錄顯示出來-->
        {% if page.has_previous %}
            <li>
                                 <!--拿到上一頁的頁碼，這樣點擊上一頁就可以到上一頁看到上一頁的記錄-->
                <a href="?page={{ page.previous_page_number }}" aria-label="Previous">
                    <span aria-hidden="true">上一頁</span>
                </a>
            </li>
        {% else %}
            <li class="disabled">
                <a href="" aria-label="Previous">
                    <span aria-hidden="true">上一頁</span>
                </a>
            </li>
        {% endif %}
        <!--循環出也難范圍的每一頁-->
        {% for foo in page_range %}
            {% if current_page == foo %}   <!--如果是當前頁，我們就就讓其跳到foo頁面，類active可以來標識當前頁-->
                <li class="active"><a href="?page={{ foo }}">{{ foo }}</a></li>
            {% else %}
                <li><a href="?page={{ foo }}">{{ foo }}</a></li>  <!--不是當前頁則不讓其顯示藍色標識-->
            {% endif %}

        {% endfor %}


        {% if page.has_next %}
            <li><a href="?page={{ page.next_page_number }}" aria-label="Next"><span aria-hidden="true">下一頁</span></a>
            </li>
        {% else %}
            <li class="disabled"><a href="" aria-label="Next"><span aria-hidden="true">下一頁</span></a></li>
        {% endif %}


    </ul>
</nav>
</body>
</html>

模型models生成Book表

from django.db import models

# Create your models here.


class Book(models.Model):
    nid=models.AutoField(primary_key=True)
    name=models.CharField(max_length=32)
    price=models.DecimalField(max_digits=5,decimal_places=2)

    def __str__(self):
        return self.name

分頁效果圖：

三、Paginator對象

Paginator類擁有以下方法和屬性：

方法：

Paginator.page(number)[source]

返回指定頁面的對象列表，比如第7頁的所有內容，下標以1開始。如果提供的頁碼不存在，拋出InvalidPage異常。

屬性：

• Paginator.count：所有頁面的對象總數。
• Paginator.num_pages：頁面總數。
• Paginator.page_range：基於1的頁數范圍迭代器。

四、處理異常

在實際使用中，可能惡意也可能不小心，用戶請求的頁面，可能千奇百怪。正常我們希望是個合法的1，2，3之類，但請求的可能是‘apple’，‘1000000’，‘#’，這就有可能導致異常，需要特別處理。Django為我們內置了下面幾個，Paginator相關異常。

• exception InvalidPage[source]：異常的基類，當paginator傳入一個無效的頁碼時拋出。
• exception PageNotAnInteger[source]：當向page()提供一個不是整數的值時拋出。
• exception EmptyPage[source]：當向page()提供一個有效值，但是那個頁面上沒有任何對象時拋出。

后面兩個異常都是InvalidPage的子類，所以你可以通過簡單的except InvalidPage來處理它們。

五、Page對象

Paginator.page()將返回一個Page對象，我們主要的操作都是基於Page對象的，它具有下面的方法和屬性：

方法：

• Page.has_next()[source]：如果有下一頁，則返回True。
• Page.has_previous()[source]：如果有上一頁，返回 True。
• Page.has_other_pages()[source]：如果有上一頁或下一頁，返回True。
• Page.next_page_number()[source]：返回下一頁的頁碼。如果下一頁不存在，拋出InvalidPage異常。
• Page.previous_page_number()[source]：返回上一頁的頁碼。如果上一頁不存在，拋出InvalidPage異常。
• Page.start_index()[source]：返回當前頁上的第一個對象，相對於分頁列表的所有對象的序號，從1開始計數。 比如，將五個對象的列表分為每頁兩個對象，第二頁的start_index()會返回3。
• Page.end_index()[source]:返回當前頁上的最后一個對象，相對於分頁列表的所有對象的序號，從1開始。 比如，將五個對象的列表分為每頁兩個對象，第二頁的end_index()會返回4。

屬性:

• Page.object_list:當前頁上所有對象的列表。
• Page.number:當前頁的序號，從1開始計數。
• Page.paginator：當前Page對象所屬的Paginator對象。