Django REST framework 分頁

逆行發表於2019-06-19
DjangoRESTFramework

官方文件[這裡]

用於分頁的模組: Pagination

Django REST framework 有內建 Pagination 模組，無需額外安裝, 只需做簡單的配置.

配置什麼呢? 就是告訴Django要用到什麼樣的分頁樣式, 比如: 返回哪些欄位, 每頁的大小, 請求引數的名稱等等.

 

2種配置途徑:

  1. settings.py 檔案裡做全域性的配置
  2. 單獨為每個需要分頁的 view 分配自定義分頁器.

 

途徑1是為所有繼承ListViewAPI的介面做預設配置, 途徑2對單獨一個介面做個性化配置.

 

需要注意的是: 途徑1做了全域性的配置, 所有繼承 ListAPIView 的介面,預設都會有分頁. 這會影響到現有介面返回資料的結構. 除了這一點, 途徑1還是相當不錯的.

 

我比較喜歡僅使用途徑2, 我可以自定義了一個通用型的分頁器, 只為有需要分頁的view分配分頁器, 也是挺方便的.

 

途徑1: settings.py檔案裡做全域性配置

REST_FRAMEWORK = {
  # ...
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 100
}

DEFAULT_PAGINATION_CLASS: 預設分頁器(BasePagination的子類). Django提供了3個型別: PageNumberPagination、LimitOffsetPagination、CursorPagination. 不同型別返回的分頁資訊不同. 也可以是你自定義的分頁器.

PAGE_SIZE: 分頁大小.

 

途徑2: 自定義分頁器

這裡將示例使用自定義分頁器的流程.

新建一個 paginations.py 用於寫分頁器:

我們在 paginations.py 檔案裡寫一個通用的分頁器:

class StandarPagination(PageNumberPagination):
    page_size = 20  # 預設每頁顯示條數配置
    page_query_param = 'page'  # “頁數”的請求引數名稱, 預設是page
    page_size_query_param = 'page_size' # “分頁大小”的請求引數名稱
		
    # 進入父類 PageNumberPagination 可看響應體返回欄位.
    #    def get_paginated_response(self, data):
    #    return Response(OrderedDict([
    #        ('count', self.page.paginator.count),
    #        ('next', self.get_next_link()),
    #        ('previous', self.get_previous_link()),
    #        ('results', data)
    #    ]))

    
    # 覺得不適用, 那就拷貝出來,過載函式, 自己多加幾個欄位. 
    # (可通過官方文件或直接除錯得知從哪些屬性獲取正確的值.)
    def get_paginated_response(self, data):
        return Response(OrderedDict([
            ('count', self.page.paginator.count),
            ('next', self.get_next_link()),
            ('previous', self.get_previous_link()),
            ('page', self.page.number),
            ('total_page', self.page.paginator.num_pages),
            ('page_size', self.page.paginator.per_page),
            ('results', data)
        ]))

(更多的屬性介紹請檢視文件)

 

為介面分配分頁器, 為屬性 pagination_class 賦值即可.

from rest_framework.pagination import PageNumberPagination

class MyListAPI(ListAPIView):
    queryset = TestModel.objects.filter()
    serializer_class = TestModelSerializer
    pagination_class = StandarPagination  # 新增

完成!

假如該介面請求地址是 http://api/test/

看客戶端是如何請求介面的:

http://api/test/ : 返回第一頁, 分頁大小是20.

http://api/test/?page=2&page_size=10: 返回第二頁,分頁大小是10.

 

相關文章