快捷導(dǎo)航

Django drf分頁(yè)器的使用詳解

更新時(shí)間：2021年06月22日 14:09:19 作者：Silent丿丶黑羽

本篇文章給大家介紹Django drf分頁(yè)器的使用，通過(guò)多種分頁(yè)器實(shí)例代碼相結(jié)合給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友參考下吧

前言

當(dāng)后臺(tái)返回的數(shù)據(jù)過(guò)多時(shí)，我們就要配置分頁(yè)器，比如一頁(yè)最多只能展示10條等等，drf中默認(rèn)配置了3個(gè)分頁(yè)面

PageNumberPagination：基礎(chǔ)分頁(yè)器，性能略差
LimitOffsetPagination：偏移分頁(yè)器
CursorPagination：游標(biāo)分頁(yè)器，性能強(qiáng)大

PageNumberPagination

基礎(chǔ)分頁(yè)器PageNumberPagination，數(shù)據(jù)量越大性能越差。

首先我們?cè)?code>app中創(chuàng)建一個(gè)pagination.py文件，然后自定義一個(gè)分頁(yè)器類，繼承自PageNumberPagination：

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

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

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

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

LimitOffsetPagination

首先我們自定義一個(gè)分頁(yè)器類，繼承自LimitOffsetPagination：

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

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

CursorPagination

游標(biāo)分頁(yè)器跟基礎(chǔ)分頁(yè)器用法差不多，只是游標(biāo)分頁(yè)的針對(duì)下一頁(yè)數(shù)據(jù)的url進(jìn)行了加密
首先我們自定義一個(gè)分頁(yè)器類，繼承自CursorPagination：

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

如果我們視圖中使用了排序過(guò)濾filter_backends = [OrderingFilter]，那么我們?cè)谠L問(wèn)url的時(shí)候必須攜帶參數(shù)?ordering=需要排序的字段。

以上就是Django drf分頁(yè)器的使用的詳細(xì)內(nèi)容，更多關(guān)于Django drf分頁(yè)器的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: