Django rest framework Pagination（分頁）

一、 Pagination

1. 簡介

REST框架支持自定義分頁風格，你可以修改每頁顯示數據集合的最大長度。 
分頁鏈接支持以下兩種方式提供給用戶： 
- 分頁鏈接是作為響應內容提供給用戶 
- 分頁鏈接被包含在響應頭中（Content-Range或者Link） 
內建風格使用作為響應內容提供給用戶。這種風格更容易被使用可瀏覽API的用戶所接受 
如果使用通用視圖或者視圖集合。系統會自動幫你進行分頁。如果使用的是APIView,你就需要自己調用分頁API，確保返回一個分頁后的響應。可以將pagination_class設置為None關閉分頁功能。

2. 設置分頁風格

可以通過設置DEFAULT_PAGINATION_CLASS和PAGE_SIZE，設置全局變量。

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

需要同時設置pagination class和page size。 
也可以在單個視圖中設置pagination_class屬性，一般你需要使用統一的分頁風格。

3. 修改分頁風格

如果你需要修改分頁風格 ，系需要重寫分頁類，然后設置你需要修改的屬性。

class LargeResultsSetPagination(PageNumberPagination):
    page_size = 1000
    page_size_query_param = 'page_size'
    max_page_size = 10000

class StandardResultsSetPagination(PageNumberPagination):
    page_size = 100
    page_size_query_param = 'page_size'
    max_page_size = 1000

# 然后在視圖中使用.pagination_class屬性調用該自定義類
class BillingRecordsView(generics.ListAPIView):
    queryset = Billing.objects.all()
    serializer_class = BillingRecordsSerializer
    pagination_class = LargeResultsSetPagination

# 或者是在設置中修改DEFAULT_PAGINATION_CLASS
REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'apps.core.pagination.StandardResultsSetPagination'
}

二、 API指南

1. PageNumberPagination

這個分頁樣式接受請求查詢參數中的一個數字頁面號。

GET https://api.example.org/accounts/?page=4

響應對象

HTTP 200 OK
{
    "count": 1023
    "next": "https://api.example.org/accounts/?page=5",
    "previous": "https://api.example.org/accounts/?page=3",
    "results": [
       …
    ]
}

繼承了GenericAPIView的視圖中，也可以設置pagination_class屬性選擇PageNumberPagination 
配置屬性： 
- django_paginator_class 
使用Django分頁類。默認為django.core.paginator.Paginator，適用於大多數情況 
- page_size 
用來顯示每頁顯示對象的數量，如果設置了就重寫PAGE_SIZE設置。 
- page_query_param 
頁面查詢參數，一個字符串值，指示用於分頁控件的查詢參數的名稱。 
- page_size_query_param 
該參數允許客戶端根據每個請求設置頁面大小。一般默認設置為None. 
- max_page_size 
只有設置了page_size_query_param參數，該參數才有意義，為客戶端請求頁面中能夠顯示的最大數量 
- last_page_strings 
用於存儲使用page_query_param參數請求過的值列表或元組，默認為(‘last’,) 
- template 
用來在可瀏覽API中，渲染分頁的模板（html）名字，可以重寫分頁樣式，或者設置為None,禁用分頁。默認為”rest_framework/pagination/numbers.html”。

2. LimitOffsetPagination

這種分頁樣式與查找多個數據庫記錄時使用的語法類似。客戶端包括一個”limit”和一個 “offset”查詢參數。該限制表示返回的條目的最大數量，並且與page_size大小相同。偏移量表示查詢的起始位置，與完整的未分頁項的集合有關。

GET https://api.example.org/accounts/?limit=100&offset=400

HTTP 200 OK
{
    "count": 1023
    "next": "https://api.example.org/accounts/?limit=100&offset=500",
    "previous": "https://api.example.org/accounts/?limit=100&offset=300",
    "results": [
       …
    ]
}
使用這種風格需要設置

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination'
}

顯然，你也可以設置PAGE_SIZE，然后客戶端就可以設置limit參數了。 
繼承了GenericAPIView的子類，可以通過設置pagination_class屬性為LimitOffsetPagination使用 
（重寫LimitOffsetPagination類）配置： 
- default_limit： 如果客戶端沒有提供，則默認使用與PAGE_SIZE值一樣。 
- limit_query_param：表示限制查詢參數的名字，默認為’limit’ 
- offset_query_param：表示偏移參數的名字， 默認為’offset’ 
- max_limit：允許頁面中顯示的最大數量，默認為None 
- template: 渲染分頁結果的模板名，默認為”rest_framework/pagination/numbers.html”.

3. CursorPagination

基於游標的分頁顯示了一個不透明的“cursor”指示器，客戶端可以使用它來瀏覽結果集。這種分頁方式只允許用戶向前或向后進行查詢。並且不允許客戶端導航到任意位置。 
基於游標的分頁要求在結果集中有一個惟一的、不變的條目順序。這個排序通常是記錄上的一個創建時間戳，用來表示分頁的順序。 
基於游標的分頁比其他方案更復雜。它還要求結果集給出一個固定的順序，並且不允許客戶端任意地對結果集進行索引，但是它確實提供了以下好處: 
- 提供一致的分頁視圖。當使用正確的指針分頁時，即使在分頁過程中其他客戶端插入新項時，客戶端也不會在分頁時看到同一個項兩次。 
- 支持使用非常大的數據集。大量數據集使用基於off-set的分頁方式可能會變得低效或不可用。基於指針的分頁模式有固定的時間屬性，並且隨着數據集的大小的增加而不會減慢。

細節和局限性 
正確地使用基於游標的分頁方式需要對細節有一點注意。你需要考慮你想要什么樣的命令翻轉這個排序方式。默認是通過“-created”來排序的。這假設在模型實例上必須有一個“created”的時間戳字段，並將顯示一個“timeline”樣式的分頁視圖，其中最近添加的項是第一個。 
你也可以通過’ordering’屬性重寫這個分頁類，或者使用OrderingFilter過濾器這兩種方式與CursorPagination一起使用。當使用OrderingFilter時，必須仔細考慮用來排序的字段 
使用游標分頁的字段要求： 
應該是一個不變的值，例如時間戳，標簽，或者其他只在創建時設置的字段
應該是唯一的或者近乎唯一的，使用毫秒精度的時間戳是一個很好的例子
應該是一個強制表示為字符串的值
該字段應該有一個數據庫索引（重點） 
不滿足這些要求，也可以使用游標分頁，但會失去一些游標的優點
設置全局變量
REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.CursorPagination',
    'PAGE_SIZE': 100
}

也可以在GenericAPIView子類中設置pagination_class屬性 
3. 配置 
- page_size：顯示的最大條數 
- cursor_query_param： 游標查詢參數名，默認為’cursor’ 
- ordering： 排序字段名的列表或者元組，例如ordering = ‘slug’，默認為-created 
- template： 渲染模板名，默認為”rest_framework/pagination/previous_and_next.html”

三、 自定義分頁

繼承pagination.BasePagination
重寫paginate_queryset(self, queryset, request, view=None)方法 
初始化queryset對象，設置pagination實例，返回一個只包含用戶請求內容的可迭代的對象，形成分頁對象
重寫get_paginated_response(self, data)方法 
序列化請求頁中說包含的對象，返回一個Response對象

 

class CustomPagination(pagination.PageNumberPagination):
    def get_paginated_response(self, data):
        return Response({
            'links': {
               'next': self.get_next_link(),
               'previous': self.get_previous_link()
            },
            'count': self.page.paginator.count,
            'results': data
        })

# 設置自定義分頁、
REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'my_project.apps.core.pagination.CustomPagination',
    'PAGE_SIZE': 100
}

請注意，如果在意在可瀏覽的API中如何顯示鍵的順序，那么您可能會選擇在構建分頁響應的主體時使用OrderedDict，但這是可選的。

分頁模式 
如果需要對REST框架提供的分頁進行控制，可以使用get_schema_fields(self, view)方法，該方法返回一個coreapi.Field實例的列表
四、 HTML分頁控制

PageNumberPagination和LimitOffsetPagination使用page和previous，next進行控制 
CursorPagination僅使用 previous和next進行控制 
1. 自定義控制 
通過重寫 templates。 
- rest_framework/pagination/numbers.html 
- rest_framework/pagination/previous_and_next.html 
2. 低級API 
在pagination中，display_page_controls屬性將用於決定分頁類是否具有控制顯示的功能 
自定義pagination類在paginate_queryset()方法中應該設置為True

五、第三方包

DRF-extensions
drf-proxy-pagination 
提供ProxyPagination，用於允許在查詢參數中設置分頁類。
link-header-pagination

轉載: www.careeru.cn/blog/article/?id=102