Django分頁(yè)器的用法詳解

更新時(shí)間：2021年05月28日 11:15:34 作者：山山仙人

本文主要介紹在利用Django開(kāi)發(fā)MVT模型項(xiàng)目時(shí)分頁(yè)器的使用，感興趣的朋友可以參考下

Django是一個(gè)大而全的框架。需要明確的是，傳參進(jìn)行分頁(yè)獲取分頁(yè)后的數(shù)據(jù)，一般都是通過(guò)向服務(wù)器發(fā)送get請(qǐng)求的方式實(shí)現(xiàn)的，在向后端服務(wù)發(fā)送查看數(shù)據(jù)的同時(shí)可以攜帶一個(gè)或多個(gè)參數(shù)并發(fā)送get請(qǐng)求來(lái)實(shí)現(xiàn)分頁(yè)查看功能

1、準(zhǔn)備基礎(chǔ)數(shù)據(jù)

設(shè)計(jì)表模型

為了體現(xiàn)分頁(yè)的效果，需要先創(chuàng)建一個(gè)表并準(zhǔn)備較多數(shù)據(jù)，模型如下

from django.db import models

# Create your models here.

class Book(models.Model):
    title = models.CharField(max_length=32)
    price = models.DecimalField(max_digits=9, decimal_places=2)  # 9999999.99

執(zhí)行數(shù)據(jù)庫(kù)遷移后，設(shè)計(jì)一個(gè)視圖函數(shù)，通過(guò)觸發(fā)視圖函數(shù)往此表中批量插入數(shù)據(jù)

Django中利用orm實(shí)現(xiàn)批量插入一般有兩種方式：?jiǎn)螚l插入或者利用bulk_create批量插入

最終翻譯轉(zhuǎn)換成sql語(yǔ)句也就類(lèi)似于多條insert語(yǔ)句和一條insert的區(qū)別

def create_book(request):

    # 批量插入方式一
    for i in range(100):
        Book.objects.create(title="book"+str(i),price=i*i)
		# 批量插入方式二
    book_list = []
    for i in range(100):
        book = Book(title="book"+str(i),price=i*i)
        book_list.append(book)
    Book.objects.bulk_create(book_list)
    
    return HttpResponse("添加成功")

2、一次性展示數(shù)據(jù)

接下來(lái)通過(guò)模板語(yǔ)法一次性將數(shù)據(jù)展示到前端頁(yè)面

視圖函數(shù)如下

def get_books(request):
    book_list = Book.objects.all()
    return render(request, "index.html", {"book_list": book_list})

模板頁(yè)面index.html如下

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<ul>
    {% for book in book_list %}
    <li>{ book.title } : { book.price }</li>
    {% endfor %}
</ul>
</body>
</html>

這時(shí)一次性訪問(wèn)即展示了所有的book

3、引入分頁(yè)器

引入分頁(yè)器后，可以對(duì)全局分頁(yè)對(duì)象和單頁(yè)對(duì)象進(jìn)行相關(guān)操作，相關(guān)語(yǔ)法

# 引入分頁(yè)器
from django.core.paginator import Paginator

		...
    # 全局分頁(yè)器對(duì)象
    paginator = Paginator([1,2,3,4,5,6,7,8,9,10],3)
    print(paginator.count) # 10  數(shù)據(jù)總數(shù)
    print(paginator.num_pages)  # 4  總頁(yè)數(shù)
    print(paginator.page_range) # range(1, 5)  頁(yè)碼的列表

    # 單頁(yè)對(duì)象
    page = paginator.page(2)
    print(page.has_next())  # 是否有下一頁(yè)
    print(page.next_page_number())  # 寫(xiě)一頁(yè)的頁(yè)碼
    print(page.has_previous())  # 是否有上一頁(yè)
    print(page.previous_page_number())  # 上一頁(yè)的頁(yè)碼
    # 取出單頁(yè)對(duì)象的值
    print(page.object_list) # [4, 5, 6]
    for i in page:
       print(i)

在這里的例子中具體使用分頁(yè)器及模板語(yǔ)法，例如每頁(yè)取出8條，獲取用戶給出的頁(yè)碼條件數(shù)，返回相應(yīng)頁(yè)的數(shù)據(jù)，默認(rèn)不給出任何條件時(shí)返回第一頁(yè)的數(shù)據(jù)

from django.core.paginator import Paginator
   # 取出當(dāng)前用戶頁(yè)碼
   current_num = int(request.GET.get("page", 1))
   book_list = Book.objects.all()
   paginator = Paginator(book_list, 8)
   page = paginator.page(current_num)
  
   return render(request,"index.html",{"page":page})

最后，可以利用bootstrap組件在頁(yè)面模板中添加翻頁(yè)的按鈕，在當(dāng)前頁(yè)時(shí)按鈕加深，沒(méi)有上一頁(yè)時(shí)禁止點(diǎn)擊

...
<body>

<ul>
    {% for book in page %}
    <li>{ book.title } : { book.price }</li>
    {% endfor %}
</ul>
<nav aria-label="Page navigation">
  <ul class="pagination">
    {% if page.has_previous %}
    <li>
      <a href="/?page={ page.previous_page_number }" rel="external nofollow"  aria-label="Previous">
        <span aria-hidden="true">上一頁(yè)</span>
      </a>
    </li>
    {% else %}
    <li class="disabled">
      <a href="#" rel="external nofollow"  rel="external nofollow"  aria-label="Previous">
        <span aria-hidden="true">上一頁(yè)</span>
      </a>
    </li>
    {% endif %}
      {% for num in page_range %}
      {% if num == current_num %}
          <li class="active"><a href="/?page={ num }" rel="external nofollow"  rel="external nofollow" >{ num }</a></li>
      {% else %}
          <li><a href="/?page={ num }" rel="external nofollow"  rel="external nofollow" >{ num }</a></li>
      {% endif %}
      {% endfor %}
    <li>
      <a href="#" rel="external nofollow"  rel="external nofollow"  aria-label="Next">
        <span aria-hidden="true">下一頁(yè)</span>
      </a>
    </li>
  </ul>
</nav>
</body>
...

在視圖函數(shù)中：處理相關(guān)異常；傳遞相關(guān)參數(shù)；當(dāng)頁(yè)碼較多時(shí)只顯示部分頁(yè)碼，例如最多時(shí)總共10個(gè)頁(yè)碼，當(dāng)前頁(yè)碼始終在中間顯示；單獨(dú)處理出現(xiàn)邊界情況，負(fù)數(shù)頁(yè)碼的情況及最大頁(yè)碼用完的情況

from django.core.paginator import Paginator
		...
    # 取出當(dāng)前用戶頁(yè)碼
    current_num = int(request.GET.get("page", 1))
    book_list = Book.objects.all()
    paginator = Paginator(book_list, 8)
    page = paginator.page(current_num)

    # 大于11頁(yè)時(shí)
    if paginator.num_pages > 11:
        # 當(dāng)前頁(yè)碼的后5頁(yè)數(shù)超過(guò)最大頁(yè)碼時(shí)，顯示最后10項(xiàng)
        if current_num + 5 > paginator.num_pages:
            page_range = range(paginator.num_pages - 10, paginator.num_pages + 1)
        # 當(dāng)前頁(yè)碼的前5頁(yè)數(shù)為負(fù)數(shù)時(shí)，顯示開(kāi)始的10項(xiàng)
        elif current_num - 5 < 1:
            page_range = range(1, 12)
        else:
            # 顯示左5頁(yè)到右5頁(yè)的頁(yè)碼
            page_range = range(current_num - 5, current_num + 5 + 1)
    # 小于11頁(yè)時(shí)顯示所有頁(yè)碼
    else:
        page_range = paginator.page_range

    return render(request, "index.html", {"page": page, "paginator": paginator, "current_num": current_num, "page_range": page_range})

附:drf分頁(yè)器的使用

Django REST framework提供了分頁(yè)的支持。

可以在配置文件中設(shè)置全局的分頁(yè)方式，如：

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS':  'rest_framework.pagination.PageNumberPagination', # 選用的分頁(yè)器
    'PAGE_SIZE': 100  # 每頁(yè)數(shù)目
}

也可通過(guò)自定義Pagination類(lèi)，來(lái)為視圖添加不同分頁(yè)行為。在視圖中通過(guò)pagination_clas屬性來(lái)指明。例如：

from rest_framework.pagination import PageNumberPagination

class MyPageNumberPagination(PageNumberPagination):
    # 設(shè)置url中的取多少頁(yè)的key
    page_query_param = 'page'
    # 設(shè)置url中設(shè)置取數(shù)據(jù)條數(shù)的key
    page_size_query_param = 'size'
    #設(shè)置每一頁(yè)的數(shù)據(jù)條數(shù)
    page_size = 2
    # 設(shè)置每一頁(yè)最多可取的數(shù)據(jù)數(shù)
    max_page_size = 5
   
class Book2View(ListAPIView):
    queryset = models.Book.objects.all()
    serializer_class = BookModelSerializer
    pagination_class = MyPageNumberPagination #指定該視圖類(lèi)的分頁(yè)器

注意：如果在視圖內(nèi)關(guān)閉分頁(yè)功能，只需在視圖內(nèi)設(shè)置pagination_class = None 即可，即在設(shè)置了全局分頁(yè)之后我們可以在局部禁用該設(shè)置。

drf 提供給我們的分頁(yè)器有PageNumberPagination、LimitOffsetPagination、CursorPagination。

1.1 PageNumberPagination

url形式：

http://127.0.0.1:8000/books/?page=1

可以在自定義類(lèi)中定義的屬性有：

page_query_param ：設(shè)置url中頁(yè)數(shù)的關(guān)鍵字，默認(rèn)的是page。
page_size_query_param ：設(shè)置url中每頁(yè)數(shù)據(jù)條數(shù)的關(guān)鍵字，默認(rèn)的是None。
page_size ：設(shè)置每一頁(yè)的數(shù)據(jù)條數(shù)。（必設(shè)）
max_page_size ：設(shè)置每一頁(yè)最多可取的數(shù)據(jù)條數(shù)。（可選）

class MyPageNumberPagination(PageNumberPagination):
    page_size = 2
    page_query_param = 'page'
    page_size_query_param = 'size'
    max_page_size = 5
    
class Book2View(ListAPIView):
    queryset = models.Book.objects.all()
    serializer_class = BookModelSerializer
    pagination_class = MyPageNumberPagination
   
# APIView 中使用自定義分頁(yè)類(lèi)進(jìn)行分頁(yè)操作
class  Pager(APIView):
    def get(self,request,*args,**kwargs):
        # 獲取所有數(shù)據(jù)
        ret=models.Book.objects.all()
        # 創(chuàng)建分頁(yè)對(duì)象
        page=MyPageNumberPagination()
        # 在數(shù)據(jù)庫(kù)中獲取分頁(yè)的數(shù)據(jù)
        page_list=page.paginate_queryset(ret,request,view=self)
        # 對(duì)分頁(yè)進(jìn)行序列化
        ser=BookSerializer1(instance=page_list,many=True)
        # return Response(ser.data)
        # 這個(gè)也是返回Response對(duì)象，但是比基本的多了上一頁(yè)，下一頁(yè)，和總數(shù)據(jù)條數(shù)（了解）
        return page.get_paginated_response(ser.data)

1.2 LimitOffsetPagination

url形式：

http://127.0.0.1/four/books/?limit=100&offset=400

可以在自定義類(lèi)中定義的屬性有：

default_limit ：默認(rèn)限制，默認(rèn)值與PAGE_SIZE設(shè)置一致。
limit_query_param ： limit參數(shù)名，默認(rèn)為limit。
offset_query_param ： offset參數(shù)名，默認(rèn)offset。
max_limit ：最大limit限制，默認(rèn)None。

class MyLimitOffsetPagination(LimitOffsetPagination):
    default_limit = 3
    limit_query_param = 'limit'
    max_limit = None
    offset_query_param = 'offset'
    
class Book2View(ListAPIView):
    queryset = models.Book.objects.all()
    serializer_class = BookModelSerializer
    pagination_class = MyLimitOffsetPagination
    
# APIView 中使用自定義分頁(yè)類(lèi)進(jìn)行分頁(yè)操作
class  Pager(APIView):
    def get(self,request,*args,**kwargs):
        # 獲取所有數(shù)據(jù)
        ret=models.Book.objects.all()
        # 創(chuàng)建分頁(yè)對(duì)象
        page=LimitOffsetPagination()
        # 在數(shù)據(jù)庫(kù)中獲取分頁(yè)的數(shù)據(jù)
        page_list=page.paginate_queryset(ret,request,view=self)
        # 對(duì)分頁(yè)進(jìn)行序列化
        ser=BookSerializer1(instance=page_list,many=True)
        # return page.get_paginated_response(ser.data)
        return Response(ser.data)

1.3 CursorPagination

url形式：

http://127.0.0.1/four/books/?cursor=cD0xNQ%3D%3D

可以在自定義類(lèi)中定義的屬性有：

cursor_query_param:默認(rèn)查詢字段，不需要修改。
page_size：每頁(yè)數(shù)目。
ordering：按什么排序，需要指定。

class MyCursorPagination(CursorPagination):
    cursor_query_param = 'cursor'
    page_size = 2
    ordering = '-id'

class Book2View(ListAPIView):
    queryset = models.Book.objects.all()
    serializer_class = BookModelSerializer
    pagination_class = MyCursorPagination
    
# APIView 中使用自定義分頁(yè)類(lèi)進(jìn)行分頁(yè)操作
class  Pager(APIView):
    def get(self,request,*args,**kwargs):
        # 獲取所有數(shù)據(jù)
        ret=models.Book.objects.all()
        # 創(chuàng)建分頁(yè)對(duì)象
        page=CursorPagination()
        page.ordering='nid'
        # 在數(shù)據(jù)庫(kù)中獲取分頁(yè)的數(shù)據(jù)
        page_list=page.paginate_queryset(ret,request,view=self)
        # 對(duì)分頁(yè)進(jìn)行序列化
        ser=BookSerializer1(instance=page_list,many=True)
        # 可以避免頁(yè)碼被猜到
        return page.get_paginated_response(ser.data)

以上就是Django分頁(yè)器的用法詳解的詳細(xì)內(nèi)容，更多關(guān)于Django分頁(yè)器的用法的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: