Django分頁器的用法詳解

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

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

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

1、準備基礎數(shù)據(jù)

設計表模型

為了體現(xiàn)分頁的效果，需要先創(chuàng)建一個表并準備較多數(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ù)庫遷移后，設計一個視圖函數(shù)，通過觸發(fā)視圖函數(shù)往此表中批量插入數(shù)據(jù)

Django中利用orm實現(xiàn)批量插入一般有兩種方式：單條插入或者利用bulk_create批量插入

最終翻譯轉(zhuǎn)換成sql語句也就類似于多條insert語句和一條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ù)

接下來通過模板語法一次性將數(shù)據(jù)展示到前端頁面

視圖函數(shù)如下

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

模板頁面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>

這時一次性訪問即展示了所有的book

3、引入分頁器

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

# 引入分頁器
from django.core.paginator import Paginator

		...
    # 全局分頁器對象
    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  總頁數(shù)
    print(paginator.page_range) # range(1, 5)  頁碼的列表

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

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

from django.core.paginator import Paginator
   # 取出當前用戶頁碼
   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組件在頁面模板中添加翻頁的按鈕，在當前頁時按鈕加深，沒有上一頁時禁止點擊

...
<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">上一頁</span>
      </a>
    </li>
    {% else %}
    <li class="disabled">
      <a href="#" rel="external nofollow"  rel="external nofollow"  aria-label="Previous">
        <span aria-hidden="true">上一頁</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">下一頁</span>
      </a>
    </li>
  </ul>
</nav>
</body>
...

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

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

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

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

附:drf分頁器的使用

Django REST framework提供了分頁的支持。

可以在配置文件中設置全局的分頁方式，如：

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

也可通過自定義Pagination類，來為視圖添加不同分頁行為。在視圖中通過pagination_clas屬性來指明。例如：

from rest_framework.pagination import PageNumberPagination

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

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

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

1.1 PageNumberPagination

url形式：

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

可以在自定義類中定義的屬性有：

page_query_param ：設置url中頁數(shù)的關(guān)鍵字，默認的是page。
page_size_query_param ：設置url中每頁數(shù)據(jù)條數(shù)的關(guān)鍵字，默認的是None。
page_size ：設置每一頁的數(shù)據(jù)條數(shù)。（必設）
max_page_size ：設置每一頁最多可取的數(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 中使用自定義分頁類進行分頁操作
class  Pager(APIView):
    def get(self,request,*args,**kwargs):
        # 獲取所有數(shù)據(jù)
        ret=models.Book.objects.all()
        # 創(chuàng)建分頁對象
        page=MyPageNumberPagination()
        # 在數(shù)據(jù)庫中獲取分頁的數(shù)據(jù)
        page_list=page.paginate_queryset(ret,request,view=self)
        # 對分頁進行序列化
        ser=BookSerializer1(instance=page_list,many=True)
        # return Response(ser.data)
        # 這個也是返回Response對象，但是比基本的多了上一頁，下一頁，和總數(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

可以在自定義類中定義的屬性有：

default_limit ：默認限制，默認值與PAGE_SIZE設置一致。
limit_query_param ： limit參數(shù)名，默認為limit。
offset_query_param ： offset參數(shù)名，默認offset。
max_limit ：最大limit限制，默認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 中使用自定義分頁類進行分頁操作
class  Pager(APIView):
    def get(self,request,*args,**kwargs):
        # 獲取所有數(shù)據(jù)
        ret=models.Book.objects.all()
        # 創(chuàng)建分頁對象
        page=LimitOffsetPagination()
        # 在數(shù)據(jù)庫中獲取分頁的數(shù)據(jù)
        page_list=page.paginate_queryset(ret,request,view=self)
        # 對分頁進行序列化
        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

可以在自定義類中定義的屬性有：

cursor_query_param:默認查詢字段，不需要修改。
page_size：每頁數(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 中使用自定義分頁類進行分頁操作
class  Pager(APIView):
    def get(self,request,*args,**kwargs):
        # 獲取所有數(shù)據(jù)
        ret=models.Book.objects.all()
        # 創(chuàng)建分頁對象
        page=CursorPagination()
        page.ordering='nid'
        # 在數(shù)據(jù)庫中獲取分頁的數(shù)據(jù)
        page_list=page.paginate_queryset(ret,request,view=self)
        # 對分頁進行序列化
        ser=BookSerializer1(instance=page_list,many=True)
        # 可以避免頁碼被猜到
        return page.get_paginated_response(ser.data)

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

您可能感興趣的文章: