Django Rest framework 之分頁

時間 2019-11-11

標籤 django rest framework 分頁欄目 Python 简体版

原文原文鏈接

1、實例

分頁有三種方式html

普通分頁，看第n頁，每頁顯示m條數據；
切割分頁，在n個位置，向後查看m條數據；
加密分頁，這與普通分頁方式類似，不過對url中的請求頁碼進行加密。

一、路由

<1>、主路由

from django.urls import include
from django.conf.urls import url

urlpatterns = [
    url(r'^api/', include('api.urls', namespace='api') ),
]

<2>、app路由

from django.urls import include
from django.conf.urls import url

urlpatterns = [
    url(r'^page/$', PageView.as_view()),
]

二、視圖

在不使用django rest framework中的分頁組件仍可以達到目的前端

from rest_framework import serializers
from rest_framework.views import APIView
from rest_framework.response import Response

class PagerSerializer(serializers.ModelSerializer):
    class Meta:
        model = Role
        fields = "__all__"


class PageView(APIView):
    def get(self, request , *args, **kwargs):
        roles = Role.objects.get_queryset().order_by('id')
        roles_ser = PagerSerializer(instance=roles, many=True)

        return Response(roles_ser.data)  # 只返回數據

返回結果
數據庫

2、使用普通分頁

一、自定義分頁類

from rest_framework.pagination import PageNumberPagination

class MyPageNumberPagination(PageNumberPagination):
    page_size = 2
    max_page_size = 5
    page_size_query_param = 'size'
    page_query_param = 'page'

page_query_param：表示url中的頁碼參數
page_size_query_param：表示url中每頁數量參數
page_size：表示每頁的默認顯示數量
max_page_size：表示每頁最大顯示數量，作限制使用，避免忽然大量的查詢數據，數據庫崩潰

二、視圖

class PagerSerializer(serializers.ModelSerializer):
    class Meta:
        model = Role
        fields = "__all__"

class PageView(APIView):
    def get(self, request , *args, **kwargs):
        roles = Role.objects.get_queryset().order_by('id')
        page = MyPageNumberPagination()
        page_roles = page.paginate_queryset(queryset=roles, request=request, view=self)
        roles_ser = PagerSerializer(instance=page_roles, many=True)

        # return Response(roles_ser.data)  # 只返回數據
        return page.get_paginated_response(roles_ser.data)  # 返回先後夜url

首先須要實例化咱們定義的分頁類
而且對實例化類進行傳參控制
最後將分頁後的對象做序列化

三、測試結果

<1>、正常測試

http://127.0.0.1:8000/api/page/
django

<2>、page、size測試

http://127.0.0.1:8000/api/page/?page=2&size=3 表示第二頁，每頁顯示三條數據
api

3、使用普通分頁

一、自定義分頁類

from rest_framework.pagination import LimitOffsetPagination

class MyLimitOffsetPagination(LimitOffsetPagination):
    default_limit = 2
    limit_query_param = 'limit'
    offset_query_param = 'offset'
    max_limit = 5

default_limit：表示默認每頁顯示幾條數據
limit_query_param：表示url中本頁須要顯示數量參數
offset_query_param：表示從數據庫中的第幾條數據開始顯示參數
max_limit：表示每頁最大顯示數量，作限制使用，避免忽然大量的查詢數據，數據庫崩潰

二、視圖

class PagerSerializer(serializers.ModelSerializer):
    class Meta:
        model = Role
        fields = "__all__"

class PageView(APIView):
    def get(self, request , *args, **kwargs):
        roles = Role.objects.get_queryset().order_by('id')
        page = MyLimitOffsetPagination()
        page_roles = page.paginate_queryset(queryset=roles, request=request, view=self)
        roles_ser = PagerSerializer(instance=page_roles, many=True)

        # return Response(roles_ser.data)  # 只返回數據
        return page.get_paginated_response(roles_ser.data)  # 返回先後夜url

首先須要實例化咱們定義的分頁類
而且對實例化類進行傳參控制
最後將分頁後的對象做序列化

三、測試結果

<1>、測試結果一

http://127.0.0.1:8000/api/page/?app

<2>、測試結果二

http://127.0.0.1:8000/api/page/?offset=2&limit=3表示從數據庫中的第二條數據開始查詢三條數據測試

4、使用加密分頁

使用加密分頁的緣由：若是使用普通分頁時，因爲向用戶提供了可選參數page，用戶能夠直接跳到數據分頁以後的任意頁碼。可是這樣作的後果就是，數據庫的負載變大，返回結果的效率緩慢。可是一旦使用加密以後，雖然提供可選參數cursor，可是對頁碼進行加密，用戶沒法知道當前頁，而是以上一頁下一頁的方式翻閱數據。有效避免了數據庫的負荷。可是就須要向用戶提供上一頁下一頁的url。加密

一、自定義分頁類

from rest_framework.pagination import LimitOffsetPagination

class MyCursorPagination(CursorPagination):

    cursor_query_param = 'cursor'
    page_size = 2  
    ordering = 'id'
    page_size_query_param = 'size' 
    max_page_size = 5

default_limit：表示默認每頁顯示幾條數據
cursor_query_param：表示url中頁碼的參數
page_size_query_param：表示每頁顯示數據量的參數
max_page_size：表示每頁最大顯示數量，作限制使用，避免忽然大量的查詢數據，數據庫崩潰
ordering：表示返回數據的排序方式

二、視圖

class PagerSerializer(serializers.ModelSerializer):
    class Meta:
        model = Role
        fields = "__all__"

class PageView(APIView):
    def get(self, request , *args, **kwargs):
        roles = Role.objects.get_queryset().order_by('id')
        page = MyCursorPagination()
        page_roles = page.paginate_queryset(queryset=roles, request=request, view=self)
        roles_ser = PagerSerializer(instance=page_roles, many=True)

        return page.get_paginated_response(roles_ser.data)  # 返回先後夜url

首先須要實例化咱們定義的分頁類
而且對實例化類進行傳參控制
最後將分頁後的對象做序列化
因爲要想用戶提供可用的上下頁接口，因此只能用return page.get_paginated_response(roles_ser.data)作返回

三、測試結果

<1>、測試結果一

http://127.0.0.1:8000/api/page/?url

<2>、測試結果二

http://127.0.0.1:8000/api/page/?cursor=cD0z&size=3這裏直接點擊下一頁url並追加每頁顯示數據量參數sizespa

5、總結

三種分頁中，普通分頁與django中的分頁基本沒有區別。不過要作分頁返回給前端數據，就要從數據庫中取出數據，而後在作分頁序列化。若是用戶一下在前幾頁請求數據庫中的最後幾頁數據，對查詢數據庫的時延，對數據庫的負載較大，就會出現問題，這個時候就可使用加密分頁，限制用戶的訪問，只提供前一頁和後一頁的接口。