Django Rest framework三種分頁方式詳解

更新時間：2019年07月26日 09:25:30 作者：ZhuYongKang

這篇文章主要介紹了Django Rest framework三種分頁方式詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下

前言

我們數據庫有幾千萬條數據，這些數據需要展示，我們不可能直接從數據庫把數據全部讀取出來.
因為這樣會給內存造成巨大的壓力，很容易就會內存溢出，所以我們希望一點一點的取.

同樣，展示的時候也是一樣的，我們必定會對數據進行分頁顯示.

本文將詳細講述DRF為我們提供的三種分頁方式.

全局配置

REST_FRAMEWORK = {
  # 對所有分頁器生效，但優(yōu)先級低
  'PAGE_SIZE': 5, # 每頁顯示5條數據
}

我們先準備好用于測試分頁的數據以及序列化類
數據表

from django.db import models

class Test(models.Model):
  """用于測試分頁的數據表"""
  name = models.CharField(max_length=64)

生成表記錄：

# 在Python腳本中調用Django環(huán)境
import os

if __name__ == '__main__':
  # 將下面的'blog095.settings'改為項目對應的名稱后直接執(zhí)行即可生成記錄
  os.environ.setdefault('DJANGO_SETTINGS_MODULE', > 'blog095.settings')
  import django
  django.setup()
  from blog.models import Test # 導入數據表
  [Test.objects.create(name="花千骨%s" % str(i)) for i in range(100)]

序列化類

from rest_framework.serializers import ModelSerializer
from blog.models import Test # 導入數據表

class TestSerializer(ModelSerializer):
  """用于測試分頁的序列化類"""
  class Meta:
    model = Test
    fields = '__all__'

第一種 PageNumberPagination 查第n頁，每頁顯示n條數據

第一步分頁器配置文件

from rest_framework import pagination

class PageNumberPagination(pagination.PageNumberPagination):
  """查第n頁，每頁顯示n條數據"""
  page_size = 10 # 指定每頁顯示多少條數據
  page_size_query_param = 'size' # URL參數中每頁顯示條數的參數
  page_query_param = 'page' # URL中頁碼的參數
  max_page_size = None # 每頁最多顯示多少條數據

第二步視圖文件

from rest_framework.response import Response
from rest_framework.views import APIView
from rest_framework.serializers import ModelSerializer
from blog.models import Test # 導入數據表
from blog import pagination # 導入上面的分頁配置

class Test01View(APIView):
  def get(self, request):
    queryset = Test.objects.all()

    # 1. 實例化分頁器對象
    page_obj = pagination.PageNumberPagination()

    # 2. 使用自己配置的分頁器調用分頁方法進行分頁
    page_data = page_obj.paginate_queryset(queryset, request)

    # 3. 序列化我們分頁好的數據
    ser_obj = TestSerializer(page_data, many=True)

    # # 4. 返回數據
    # return Response(ser_obj.data)

    # 4. 返回帶上一頁/下一頁連接的頁面
    return page_obj.get_paginated_response(ser_obj.data)

第三步訪問測試

如上圖，指定page=10&size=5后，返回了相應的數據.
***

第二種 LimitOffsetPagination 在第n個位置，向后查n條數據

第一步分頁器配置文件

from rest_framework import pagination

class LimitOffsetPagination(pagination.LimitOffsetPagination):
  """在第n個位置，向后查n條數據"""
  default_limit = 1 # 指定默認查多少條數據
  limit_query_param = 'limit' # URL中指定查多少條數據的參數
  offset_query_param = 'offset' # URL中指定從第幾條數據開始查的參數
  max_limit = 999 # 最大顯示多少條數據

第二步視圖文件

from rest_framework.response import Response
from rest_framework.views import APIView
from rest_framework.serializers import ModelSerializer
from blog.models import Test # 導入數據表
from blog.pagination import LimitOffsetPagination # 導入上面的分頁配置


class Test02View(APIView):
  def get(self, request):
    queryset = Test.objects.all()

    # 1. 實例化分頁器對象
    page_obj = LimitOffsetPagination()

    # 2. 使用自己配置的分頁器調用分頁方法進行分頁
    page_data = page_obj.paginate_queryset(queryset, request)

    # 3. 序列化我們分頁好的數據
    ser_obj = TestSerializer(page_data, many=True)

    # # 4. 返回數據
    # return Response(ser_obj.data)

    # 4. 返回帶上一頁/下一頁連接的頁面
    return page_obj.get_paginated_response(ser_obj.data)

第三步訪問測試

***

第三種 CursorPagination 加密游標的分頁

第一步分頁器配置文件

from rest_framework import pagination

class CursorPagination(pagination.CursorPagination):
  """加密游標的分頁"""
  cursor_query_param = 'cursor' # 游標(這是加密的游標)
  # ordering = '-id' # 從后往前取數據
  ordering = 'id'
  page_size = 1 # 每頁顯示的條數

第二步視圖文件

from rest_framework.response import Response
from rest_framework.views import APIView
from rest_framework.serializers import ModelSerializer
from blog.models import Test # 導入數據表
from blog.pagination import CursorPagination # 導入上面的分頁配置

class Test03View(APIView):
  def get(self, request):
    queryset = Test.objects.all()

    # 1. 實例化分頁器對象
    page_obj = CursorPagination()

    # 2. 使用自己配置的分頁器調用分頁方法進行分頁
    page_data = page_obj.paginate_queryset(queryset, request)

    # 3. 序列化我們分頁好的數據
    ser_obj = TestSerializer(page_data, many=True)

    # # 4. 返回數據
    # return Response(ser_obj.data)

    # 4. 返回帶上一頁/下一頁連接的頁面
    return page_obj.get_paginated_response(ser_obj.data)

好了，打開瀏覽器去測試吧.

還可以使用DRF視圖系統生成帶有上一頁/下一頁按鈕的頁面.

from rest_framework.viewsets import ModelViewSet

class Test04View(ModelViewSet):
  queryset = Test.objects.all()
  serializer_class = TestSerializer
  pagination_class = CursorPagination # 指定分頁配置器

如下圖：

is ok.

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章:

詳解使用pymysql在python中對mysql的增刪改查操作(綜合)
本篇文章主要介紹了使用pymysql在python中對mysql的增刪改查操作，通過pymysql向數據庫進行查刪增改，具有一定的參考價值，有興趣的可以了解一下。
2017-01-01
python基于Selenium的web自動化框架
這篇文章主要介紹了python基于Selenium的web自動化框架，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
2019-07-07
python matplotlib實現雙Y軸的實例
今天小編就為大家分享一篇python matplotlib實現雙Y軸的實例，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
2019-02-02
Python 的 sum() Pythonic 的求和方法詳細
Python 的內置函數sum()是一種對數值列表求和的有效且Pythonic 的方法。將多個數字相加是許多計算中常見的中間步驟，因此sum()對于 Python 程序員來說是一個非常方便的工具。下面文章就讓我們一起來看具體內容吧
2021-10-10
python QT界面關閉線程池的線程跟隨退出完美解決方案
這篇文章主要介紹了python QT界面關閉，線程池的線程跟隨退出解決思路方法,本文給大家分享兩種方法結合實例代碼給大家介紹的非常詳細，需要的朋友可以參考下
2022-11-11
淺談django rest jwt vue 跨域問題
這篇文章主要介紹了django rest jwt vue 跨域問題，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2018-10-10
最基礎的Python的socket編程入門教程
這篇文章主要介紹了最基礎的Python的socket編程入門教程,包括最基本的發(fā)送和接受信息等內容,需要的朋友可以參考下
2015-04-04
關于Python中Inf與Nan的判斷問題詳解
這篇文章主要介紹了關于Python中Inf與Nan的判斷問題，文中介紹的很詳細，對大家具有一定的參考價值，有需要的朋友們下面來一起看看吧。
2017-02-02
Python實現GUI圖片瀏覽的小程序
這篇文章主要介紹了Python實現GUI圖片瀏覽程序,程序的實現需要pillow庫,pillow是 Python 的第三方圖像處理庫,需要安裝才能實用,文中通過代碼示例給大家介紹的非常詳細,需要的朋友可以參考下
2023-12-12
一文詳解Python垃圾回收
這篇文章主要介紹了一文詳解Python垃圾回收的相關資料,需要的朋友可以參考下
2023-09-09