Django REST framework 分頁

官方文檔[這裏]

用於分頁的模塊: 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.