Django rest framework Pagination(分頁)

来源:https://www.cnblogs.com/catgatp/archive/2020/05/12/12879228.html
-Advertisement-
Play Games

一、 Pagination1. 簡介REST框架支持自定義分頁風格,你可以修改每頁顯示數據集合的最大長度。 分頁鏈接支持以下兩種方式提供給用戶: - 分頁鏈接是作為響應內容提供給用戶 - 分頁鏈接被包含在響應頭中(Content-Range或者Link) 內建風格使用作為響應內容提供給用戶。這種風格 ...


一、 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


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 【目錄】 標簽&標簽屬性 1、HTML 註釋 2、HTML 文檔基礎結構 3、head 內常用標簽 4、body 內常用標簽 常用文本標簽 特殊符號 div / span 分塊標簽 a 標簽 img 標簽 list 列表標簽 table 表格標簽 form 表單標簽 1、HTML 註釋 (選中內容或 ...
  • 1、Bootstrap 中文網 https://www.bootcss.com/?spm=a313x.7781069.1998910419.46 2、W3School https://www.quanzhanketang.com/ ...
  • 登高遠眺 天高地迥,覺宇宙之無窮 基礎技術 "Deno 1.0 即將發佈,你需要知道的都在這裡了" Deno——來自 Node 之父 Ryan Dahl 的最新力作,在開源 2 年之際,終於將迎來 1.0 的正式版本。Deno 並不是 Node 的替代品,根據 Deno GitHub 官網上的介紹, ...
  • 1.問題描述 成功安裝證書,但是顯示連接不安全 此頁面的部分內容(例如圖像)不安全 如下圖 2.問題原因 頁面引用(含有)http資源的文件、圖片、腳本 如:圖片引自其他http資源的網站 firefox詳細解釋:https://developer.mozilla.org/zh-CN/docs/Se ...
  • 本文主要討論spring boot如何獲取前端傳過來的參數,這些參數主要有兩大類,一類是URL里的參數,一個是請求body里的參數 url里的參數 通過url里傳過來的參數一般有三種方式,下麵我們來看一下 路徑參數 路徑參數就是說在請求路徑里攜帶了幾個參數,比如有一個查詢banner詳情的介面,/v ...
  • 前言 入職新公司到現在也有一個月了,完成了手頭的工作,前幾天終於有時間研究下公司舊項目的代碼。在研究代碼的過程中,發現項目里用到了Spring Aop來實現資料庫的讀寫分離,本著自己愛學習(我自己都不信…)的性格,決定寫個實例工程來實現spring aop讀寫分離的效果。 環境部署 資料庫:MySq ...
  • 1、右鍵點擊項目,選擇properties 2、點擊Project facets 3、在右側的Runtimes中選中apache tomcat 4、勾選Dynamic Web Module 最終改為下麵的樣式,其餘的不要: 即可通過add and remove操作該web項目。 原文地址:https ...
  • 數組實現迴圈隊列 創建3個文件:queueArray.h、queueArray.c、queueArrayTest.c queueArray.h c include include include include "queueArray.h" define ADT QueueArray // 功能: ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...