在前面的DRF系列教程中，我們以博客為例介紹了序列化器, 使用基于類的視圖APIView和ModelViewSet開(kāi)發(fā)了針對(duì)文章資源進(jìn)行增刪查改的完整API端點(diǎn)，并詳細(xì)對(duì)權(quán)限和認(rèn)證(含jwt認(rèn)證)進(jìn)行了總結(jié)與演示。在本篇文章中我們將向你演示如何在Django REST Framework中使用分頁(yè)。

分頁(yè)

為什么要分頁(yè)? 當(dāng)你的數(shù)據(jù)庫(kù)數(shù)據(jù)量非常大時(shí)，如果一次將這些數(shù)據(jù)查詢出來(lái), 必然加大了服務(wù)器內(nèi)存的負(fù)載,降低了系統(tǒng)的運(yùn)行速度。一種更好的方式是將數(shù)據(jù)分段展示給用戶。如果用戶在展示的分段數(shù)據(jù)中沒(méi)有找到自己的內(nèi)容，可以通過(guò)指定頁(yè)碼或翻頁(yè)的方式查看更多數(shù)據(jù)，直到找到自己想要的內(nèi)容為止。

Django REST Framework提供3種分頁(yè)類，接下來(lái)我們會(huì)分別進(jìn)行演示。

1. PageNumberPagination類：簡(jiǎn)單分頁(yè)器。支持用戶按?page=3這種方式查詢，你可以通過(guò)page_size這個(gè)參數(shù)手動(dòng)指定每頁(yè)展示給用戶數(shù)據(jù)的數(shù)量。它還支持用戶按?page=3&size=10這種更靈活的方式進(jìn)行查詢，這樣用戶不僅可以選擇頁(yè)碼，還可以選擇每頁(yè)展示數(shù)據(jù)的數(shù)量。對(duì)于第二種情況，你通常還需要設(shè)置max_page_size這個(gè)參數(shù)限制每頁(yè)展示數(shù)據(jù)的最大數(shù)量，以防止用戶進(jìn)行惡意查詢(比如size=10000), 這樣一頁(yè)展示1萬(wàn)條數(shù)據(jù)將使分頁(yè)變得沒(méi)有意義。
2. LimitOffsetPagination類：偏移分頁(yè)器。支持用戶按?limit=20&offset=100這種方式進(jìn)行查詢。offset是查詢數(shù)據(jù)的起始點(diǎn)，limit是每頁(yè)展示數(shù)據(jù)的最大條數(shù)，類似于page_size。當(dāng)你使用這個(gè)類時(shí)，你通常還需要設(shè)置max_limit這個(gè)參數(shù)來(lái)限制展示給用戶數(shù)據(jù)的最大數(shù)量。
3. CursorPagination類：加密分頁(yè)器。這是DRF提供的加密分頁(yè)查詢，僅支持用戶按響應(yīng)提供的上一頁(yè)和下一頁(yè)鏈接進(jìn)行分頁(yè)查詢，每頁(yè)的頁(yè)碼都是加密的。使用這種方式進(jìn)行分頁(yè)需要你的模型有"created"這個(gè)字段，否則你要手動(dòng)指定ordering排序才能進(jìn)行使用。

使用PageNumberPagination類

DRF中使用默認(rèn)分頁(yè)類的最簡(jiǎn)單方式就是在settings.py中進(jìn)行全局配置，如下所示：

REST_FRAMEWORK ={
 'DEFAULT_PAGINATION_CLASS':'rest_framework.pagination.PageNumberPagination',
'PAGE_SIZE':2
}

展示效果如下，每頁(yè)展示兩條記錄, 不支持用戶指定每頁(yè)展示數(shù)據(jù)的數(shù)量。

但是如果你希望用戶按?page=3&size=10這種更靈活的方式進(jìn)行查詢，你就要進(jìn)行個(gè)性化定制。在實(shí)際開(kāi)發(fā)過(guò)程中，定制比使用默認(rèn)的分頁(yè)類更常見(jiàn)，具體做法如下。

第一步: 在app目錄下新建pagination.py, 添加如下代碼：

#blog/pagination.py

from rest_framework.pagination import PageNumberPagination
 
 
class MyPageNumberPagination(PageNumberPagination):
 page_size = 2 # default page size
 page_size_query_param = 'size' # ?page=xx&size=??
 max_page_size = 10 # max page size

我們自定義了一個(gè)MyPageNumberPagination類，該類繼承了PageNumberPagination類。我們通過(guò)page_size設(shè)置了每頁(yè)默認(rèn)展示數(shù)據(jù)的條數(shù)，通過(guò)page_size_query_param設(shè)置了每頁(yè)size的參數(shù)名以及通過(guò)max_page_size設(shè)置了每個(gè)可以展示的最大數(shù)據(jù)條數(shù)。

第二步：使用自定義的分頁(yè)類

在基于類的視圖中，你可以使用pagination_class這個(gè)屬性使用自定義的分頁(yè)類，如下所示：

from rest_framework import viewsets
from .pagination import MyPageNumberPagination
 
 
 
 
class ArticleViewSet(viewsets.ModelViewSet):
 # 用一個(gè)視圖集替代ArticleList和ArticleDetail兩個(gè)視圖
 queryset = Article.objects.all()
 serializer_class = ArticleSerializer
 pagination_class = MyPageNumberPagination
 
 
 
 
 # 自行添加，將request.user與author綁定
 def perform_create(self, serializer):
  serializer.save(author=self.request.user)
 
 
 # 自行添加，將request.user與author綁定
 def perform_update(self, serializer):
  serializer.save(author=self.request.user)

展示效果如下所示：

當(dāng)然定制分頁(yè)類不限于指定page_size和max_page_size這些屬性，你還可以改變響應(yīng)數(shù)據(jù)的輸出格式。比如我們這里希望把next和previous放在一個(gè)名為links的key里，我們可以修改MyPageNumberPagination類，重寫get_paginated_response方法：

from rest_framework.pagination import PageNumberPagination
from rest_framework.response import Response
 
 
 
 
class MyPageNumberPagination(PageNumberPagination):
 page_size = 2 # default page size
 page_size_query_param = 'size' # ?page=xx&size=??
 max_page_size = 10 # max page size
 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
  })

新的展示效果如下所示：

注意：重寫get_paginated_response方法非常有用，你還可以給分頁(yè)響應(yīng)數(shù)據(jù)傳遞額外的內(nèi)容，比如code狀態(tài)碼等等。

前面的例子中我們只在單個(gè)基于類的視圖或視圖集中使用到了分頁(yè)類，你還可以修改settings.py全局使用你自定義的分頁(yè)類，如下所示。展示效果是一樣的，我們就不詳細(xì)演示了。

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

使用LimitOffsetPagination類

使用這個(gè)分頁(yè)類最簡(jiǎn)單的方式就是在settings.py中進(jìn)行全局配置，如下所示：

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

展示效果如下所示，從第6條數(shù)據(jù)查起，每頁(yè)展示2條。

你也可以自定義MyLimitOffsetPagination類，在單個(gè)視圖或視圖集中使用，或者全局使用。

from rest_framework.pagination import LimitOffsetPagination
 
 
class MyLimitOffsetPagination(LimitOffsetPagination):
 default_limit = 5 # default limit per age
 limit_query_param = 'limit' # default is limit
 offset_query_param = 'offset' # default param is offset
 max_limit = 10 # max limit per age

使用CursorPagination類

全局使用

REST_FRAMEWORK = {
 'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.CursorPagination',
 'PAGE_SIZE': 2
}

展示效果如下所示：

什么? 為什么會(huì)出錯(cuò)誤? 使用CursorPagination類需要你的模型里有created這個(gè)字段，否則你需要手動(dòng)指定ordering字段。這是因?yàn)镃ursorPagination類只能對(duì)排過(guò)序的查詢集進(jìn)行分頁(yè)展示。我們的Article模型只有create_date字段，沒(méi)有created這個(gè)字段，所以會(huì)報(bào)錯(cuò)。

為了解決這個(gè)問(wèn)題，我們需要自定義一個(gè)MyCursorPagination類，手動(dòng)指定按create_date排序, 如下所示：

#blog/pagination.py

from rest_framework.pagination import CursorPagination
 
 
class MyArticleCursorPagination(CursorPagination):
 page_size = 3 # Default number of records per age
 page_size_query_param = 'page_size' 
 cursor_query_param = 'cursor' # Default is cursor
 ordering = '-create_date'

修改settings.py, 使用自己定義的分頁(yè)類。

REST_FRAMEWORK = {
 'DEFAULT_PAGINATION_CLASS': 'blog.pagination.MyArticleCursorPagination',
}

響應(yīng)效果如下所示，你將得到previous和next分頁(yè)鏈接。頁(yè)碼都加密了, 鏈接里不再顯示頁(yè)碼號(hào)碼。默認(rèn)每頁(yè)展示3條記錄, 如果使用?page_size=2進(jìn)行查詢，每頁(yè)你將得到兩條記錄。

當(dāng)然由于這個(gè)ordering字段與模型相關(guān)，我們并不推薦全局使用自定義的CursorPagination類，更好的方式是在GenericsAPIView或視圖集viewsets中通過(guò)pagination_class屬性指定，如下所示：

from rest_framework import viewsets
from .pagination import MyArticleCursorPagination
 
 
 
 
class ArticleViewSet(viewsets.ModelViewSet):
 # 用一個(gè)視圖集替代ArticleList和ArticleDetail兩個(gè)視圖
 queryset = Article.objects.all()
 serializer_class = ArticleSerializer
 pagination_class = MyArticleCursorPagination
 # 自行添加，將request.user與author綁定
 def perform_create(self, serializer):
  serializer.save(author=self.request.user)
 
 
 # 自行添加，將request.user與author綁定
 def perform_update(self, serializer):
  serializer.save(author=self.request.user)

函數(shù)類視圖中使用分頁(yè)類

注意pagination_class屬性僅支持在genericsAPIView和視圖集viewset中配置使用。如果你使用函數(shù)或簡(jiǎn)單的APIView開(kāi)發(fā)API視圖，那么你需要對(duì)你的數(shù)據(jù)進(jìn)行手動(dòng)分頁(yè)，一個(gè)具體使用例子如下所示：

from rest_framework.pagination import PageNumberPagination
class ArticleList0(APIView):
 """
 List all articles, or create a new article.
 """
 def get(self, request, format=None):
  articles = Article.objects.all()
 
 
  page = PageNumberPagination() # 產(chǎn)生一個(gè)分頁(yè)器對(duì)象
  page.page_size = 3 # 默認(rèn)每頁(yè)顯示的多少條記錄
  page.page_query_param = 'page' # 默認(rèn)查詢參數(shù)名為 page
  page.page_size_query_param = 'size' # 前臺(tái)控制每頁(yè)顯示的最大條數(shù)
  page.max_page_size = 10 # 后臺(tái)控制顯示的最大記錄條數(shù)，防止用戶輸入的查詢條數(shù)過(guò)大
  ret = page.paginate_queryset(articles, request)
  serializer = ArticleSerializer(ret, many=True)
 
 
  return Response(serializer.data)

小結(jié)

本文總結(jié)了DRF提供的3種分頁(yè)類并詳細(xì)演示了如何使用它們，你學(xué)會(huì)了嗎?

到此這篇關(guān)于Django REST Framework 分頁(yè)(Pagination)詳解的文章就介紹到這了,更多相關(guān)Django REST Framework 分頁(yè)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論