Django restframework分頁器組件增加的基本使用

為了更好的顯示響應的書數據，先基本介紹渲染器的使用：現在settings.py的文件種變數INSTALL_APPS中添加一個app——“rest_framework”，在請求視圖類中返回數據響應的方式使用from rest_framework.response import Response的類，請求視圖類中可不再使用json.dumps()數據，直接返迴響應Response(ser.data)，在講解分頁器的知識會運用到視圖類中。

在Django restframework中，框架提供了三種分頁的方式，以下分點介紹三種分頁方式。

1、看第n頁，每頁顯示m條數據：一般頁碼的請求地址類似於http://localhost:8000/roles/?page=2&size=8

①一般我們可以自定義一個專門為響應的數據提供的分頁序列化器，這裡以響應角色數據為例

from rest_framework import serializer
class PagerSerializer(serializer.ModelSerializer):
    class Meta:
        model = Role
        fields = "__all__"

②如果不使用分頁器，響應數據的方式就會將所有的數據顯示在前端中

from rest_framework.response import Response

class RoleView(APIView):
    def get(self, *args, **kwargs):
        roles = Role.object.all()
        ser = PagerSerializer(instance=roles, many=True)
        return Response(ser.data)

③使用分頁器需要先導入相關的分頁器類：from rest_framework.pagination import PageNumberPagination，在查看其中源碼時，有一些有關於分頁的配置可以在settings.py文件中配置，如果沒有配置，就會使用這個類相關的預設值。當然我們可以繼承這個類來自定義分頁器類，自定義的類只需要修改分頁相關的屬性值就可以。分頁器類的功能是將得到的所有數據先分號頁，然後再將分好頁的數據放置在序列化中

from rest_framework.pagination import PageNumberPagination

class MyPagination(PageNumberPagination):
    # 頁面顯示的數據條數
    page_size = 2
    # 頁碼請求地址上的url的get參數名稱
    page_query_param = "size"
    # 頁面允許顯示的最多數據條數
    max_page_size = 8

④請求的視圖類中，返迴響應數據的方式發生變化，分頁器對象還提供一些方法，讓響應的數據更豐富一點：增加上、下頁的url地址和查詢的總記錄數。

from rest_framework.response import Response

class RoleView(APIView):
    def get(self, request, *args, **kwargs):
        roles = Role.object.all()
        # 將得到的所有數據分好頁
        pg = MyPagination()
        role_pages = pg.paginate_queryset(queryset=roles, request=request, view=self)
        # 將分好頁的數據放置分頁序列化器中即可
        ser = PagerSerializer(instance=role_oages, many=True)
        # 這種只會返回數據
        # return Response(ser.data)
        # 這種就會額外顯示上下頁url地址和總記錄數
        return pg.get_paginated_response(ser.data)

 2、在n個位置後，查看m條數據，一般頁碼的請求地址類似於http://localhost:8000/roles/?offset=2&limit=8。視圖和序列化類都可以不用變，自定義分頁類需要繼承另外一個類，from rest_framework.pagination import LimitOffsetPagination。當然我們可以繼承這個類來自定義分頁器類，自定義的類只需要修改分頁相關的屬性值就可以。分頁器類的功能是將得到的所有數據先分號頁，然後再將分好頁的數據放置在序列化中

from rest_framework.pagination import LimitOffsetPagination

class MyPagination(LimitOffsetPagination):
    # 頁面顯示的數據條數
    default_limit = 2
    # 頁碼請求地址上的url的get參數名稱
    limit_query_param = "limit"
    offset_query_param = "offset"
    # 頁面允許顯示的最多數據條數
    max_limit = 8

 3、加密分頁，只顯示上一頁和下一頁，一般頁碼的請求地址類似於http://localhost:8000/roles/?page=fnew39。序列化類都可以不用變，自定義分頁類需要繼承另外一個類，from rest_framework.pagination import CursorPagination。當然我們可以繼承這個類來自定義分頁器類，自定義的類只需要修改分頁相關的屬性值就可以。分頁器類的功能是將得到的所有數據先分號頁，然後再將分好頁的數據放置在序列化中。由於上一頁和下一頁地址已加密，所以在請求試圖類中就只能使用分頁對象返迴響應的數據：return pg.get_paginated_response()

from rest_framework.pagination import CursorPagination

class MyPagination(CursorPagination):
    # 頁面顯示的數據條數
    page_size = 2
    # 頁碼請求地址上/下一頁的url的get參數名稱
    cursor_query_param = "cursor"
    # 頁面展示數據數url的get參數名稱
    page_size_query_param = "size"
    # 查詢的數據的排序方式
    ordering = "-id"
    # 頁面允許顯示的最多數據條數
    max_page_size = 8