Django（68）drf分頁器的使用

前言

當后台返回的數據過多時，我們就要配置分頁器，比如一頁最多只能展示10條等等，drf中默認配置了3個分頁面

• PageNumberPagination：基礎分頁器，性能略差
• LimitOffsetPagination：偏移分頁器
• CursorPagination：游標分頁器，性能強大
   

PageNumberPagination

基礎分頁器PageNumberPagination，數據量越大性能越差。

首先我們在app中創建一個pagination.py文件，然后自定義一個分頁器類，繼承自PageNumberPagination：

from rest_framework.pagination import PageNumberPagination


class MyPageNumberPagination(PageNumberPagination):
    """
    普通分頁，數據量越大性能越差
    """
    # 默認頁面展示的條數
    page_size = 3
    # 前端訪問url需要添加 ?page=頁碼
    page_query_param = 'page'
    # 用戶自定義返回的條數，格式?page_size=頁數
    page_size_query_param = "page_size"
    # 用戶自定義返回的條數最大限制，數值超過5也只展示5條
    max_page_size = 5

如果我們需要局部配置則在類視圖中訪問使用pagination_class = MyPageNumberPagination即可
如果是全局配置，則在settings.py文件中配置如下:

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'api.pagination.MyPageNumberPagination',
}

之后我們訪問url只需在后面加入?page=頁碼數即可
比如http://127.0.0.1:8000/api/cars/?page=2，代表訪問第二頁的數據，數據的條數默認為page_size的值
比如http://127.0.0.1:8000/api/cars/?page=2&page_size=5，代表訪問第二頁的數據，用戶自定義返回的條數為5條
 

LimitOffsetPagination

首先我們自定義一個分頁器類，繼承自LimitOffsetPagination：

class MyLimitOffsetPagination(LimitOffsetPagination):
    # url后面跟limit請求參數，
    limit_query_param = 'limit'
    # url后面跟offset請求參數
    offset_query_param = 'offset'
    # 最大限制20條
    max_limit = 20
    # 默認限制3條
    default_limit = 3

之后我們訪問url只需要在后面加入?limit=10即可
比如http://127.0.0.1/api/cars/?limit=10代表訪問的數據最多展示10條，如果你limit的值＞max_limit，那么還是按照max_limit的值來展示數據的條數
比如http://127.0.0.1/api/cars/?offset=1，這里沒有limit參數，所以默認展示3條，offset=1代表從數據庫列表中提取數據的時候，是從下標1開始提取，比如提取的數據列表是['test1', 'test2', 'test3', 'test4']，本來我們默認提取前3條，但是你加上offset=1后，他是從列表下標為1開始提取，所以最后提取的數據是test2和test3和test4
 

CursorPagination

游標分頁器跟基礎分頁器用法差不多，只是游標分頁的針對下一頁數據的url進行了加密
首先我們自定義一個分頁器類，繼承自CursorPagination：

class MyCursorPagination(CursorPagination):
    """
    Cursor 光標分頁 性能高，安全
    """
    page_size = 10
    page_size_query_param = "page_size"
    max_page_size = 20
    ordering = '-price'

如果我們視圖中使用了排序過濾filter_backends = [OrderingFilter]，那么我們在訪問url的時候必須攜帶參數?ordering=需要排序的字段。