Django Rest framework三種分頁(yè)方式詳解

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

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

前言

我們數(shù)據(jù)庫(kù)有幾千萬(wàn)條數(shù)據(jù)，這些數(shù)據(jù)需要展示，我們不可能直接從數(shù)據(jù)庫(kù)把數(shù)據(jù)全部讀取出來(lái).
因?yàn)檫@樣會(huì)給內(nèi)存造成巨大的壓力，很容易就會(huì)內(nèi)存溢出，所以我們希望一點(diǎn)一點(diǎn)的取.

同樣，展示的時(shí)候也是一樣的，我們必定會(huì)對(duì)數(shù)據(jù)進(jìn)行分頁(yè)顯示.

本文將詳細(xì)講述DRF為我們提供的三種分頁(yè)方式.

全局配置

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

我們先準(zhǔn)備好用于測(cè)試分頁(yè)的數(shù)據(jù)以及序列化類
數(shù)據(jù)表

from django.db import models

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

生成表記錄：

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

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

序列化類

from rest_framework.serializers import ModelSerializer
from blog.models import Test # 導(dǎo)入數(shù)據(jù)表

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

第一種 PageNumberPagination 查第n頁(yè)，每頁(yè)顯示n條數(shù)據(jù)

第一步分頁(yè)器配置文件

from rest_framework import pagination

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

第二步視圖文件

from rest_framework.response import Response
from rest_framework.views import APIView
from rest_framework.serializers import ModelSerializer
from blog.models import Test # 導(dǎo)入數(shù)據(jù)表
from blog import pagination # 導(dǎo)入上面的分頁(yè)配置

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

    # 1. 實(shí)例化分頁(yè)器對(duì)象
    page_obj = pagination.PageNumberPagination()

    # 2. 使用自己配置的分頁(yè)器調(diào)用分頁(yè)方法進(jìn)行分頁(yè)
    page_data = page_obj.paginate_queryset(queryset, request)

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

    # # 4. 返回?cái)?shù)據(jù)
    # return Response(ser_obj.data)

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

第三步訪問(wèn)測(cè)試

如上圖，指定page=10&size=5后，返回了相應(yīng)的數(shù)據(jù).
***

第二種 LimitOffsetPagination 在第n個(gè)位置，向后查n條數(shù)據(jù)

第一步分頁(yè)器配置文件

from rest_framework import pagination

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

第二步視圖文件

from rest_framework.response import Response
from rest_framework.views import APIView
from rest_framework.serializers import ModelSerializer
from blog.models import Test # 導(dǎo)入數(shù)據(jù)表
from blog.pagination import LimitOffsetPagination # 導(dǎo)入上面的分頁(yè)配置


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

    # 1. 實(shí)例化分頁(yè)器對(duì)象
    page_obj = LimitOffsetPagination()

    # 2. 使用自己配置的分頁(yè)器調(diào)用分頁(yè)方法進(jìn)行分頁(yè)
    page_data = page_obj.paginate_queryset(queryset, request)

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

    # # 4. 返回?cái)?shù)據(jù)
    # return Response(ser_obj.data)

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

第三步訪問(wèn)測(cè)試

***

第三種 CursorPagination 加密游標(biāo)的分頁(yè)

第一步分頁(yè)器配置文件

from rest_framework import pagination

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

第二步視圖文件

from rest_framework.response import Response
from rest_framework.views import APIView
from rest_framework.serializers import ModelSerializer
from blog.models import Test # 導(dǎo)入數(shù)據(jù)表
from blog.pagination import CursorPagination # 導(dǎo)入上面的分頁(yè)配置

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

    # 1. 實(shí)例化分頁(yè)器對(duì)象
    page_obj = CursorPagination()

    # 2. 使用自己配置的分頁(yè)器調(diào)用分頁(yè)方法進(jìn)行分頁(yè)
    page_data = page_obj.paginate_queryset(queryset, request)

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

    # # 4. 返回?cái)?shù)據(jù)
    # return Response(ser_obj.data)

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

好了，打開(kāi)瀏覽器去測(cè)試吧.

還可以使用DRF視圖系統(tǒng)生成帶有上一頁(yè)/下一頁(yè)按鈕的頁(yè)面.

from rest_framework.viewsets import ModelViewSet

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

如下圖：