Django REST framwork-04-分页

Posted 2021-06-29 shark_西瓜甜

文章目录

• DRF 配置项的设置位置
• 如何设置分页
• • • • 注意： 只有在使用通用视图(generics.GenericAPIView)或视图集时(viewsets.GenericViewSet) ，才会自动执行分页。如果使用常规 `APIView`，则需要自己编写分页逻辑， 以确保返回含有分页的响应。
  • 设置默认分页类和页面大小
• 自定义分页样式
• • 1. 编写分页样式类
  • 2. 如何使用
  • • 2.1 全局使用
    • 2.2 给某个视图使用
    • 2.3 URL 配置
    • 2.4 效果图

Django提供了一些类来帮助您管理分页数据 - 即分布在多个页面上的数据，使用 “上一页/下一页” 进行跳转链接。

DRF 配置项的设置位置

所有关于 DRF 的设置，都必须在 settings.py 文件中的
REST_FRAMEWORK 设置, 如下：

# settings.py
REST_FRAMEWORK = {
    ...
}

如何设置分页

注意： 只有在使用通用视图(generics.GenericAPIView)或视图集时(viewsets.GenericViewSet) ，才会自动执行分页。如果使用常规 APIView，则需要自己编写分页逻辑， 以确保返回含有分页的响应。

可以使用 DEFAULT_PAGINATION_CLASS 键设置用于全局分页类

使用 PAGE_SIZE 键设置每页最多显示几条数据。

设置默认分页类和页面大小

默认这两者都是 None

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

自定义分页样式

1. 编写分页样式类

from rest_framework.pagination import PageNumberPagination
class StandardResultsSetPagination(PageNumberPagination):
    page_size = 2  # 每页 2 条数据
    page_size_query_param = 'page_size'
    page_query_param = 'p'  # 请求页码的参数名
    max_page_size = 2  

page_size_query_param= 'page_size'
客户端可以使用参数 page_size 自定义没有含有数据的条目数（默认使用 page_size 的值）。

max_page_size = 2
表示当客户端使用 page_size 参数自定义每页多少条数据时，最多可以设置多少条。
例如上例中设置的 max_page_size = 2, 那么客户端使用 page_size 定义自己的请求页面大小时，不能超过 2.

示例:

2. 如何使用

2.1 全局使用

在 setting.py 中设置即可

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'api.page.StandardResultsSetPagination',
}

2.2 给某个视图使用

可以给不同的视图编写不同的分页样式，之后在视图中指定即可

from api.page import StandardResultsSetPagination
class ServerViewSet(viewsets.ModelViewSet):
    """
    viewsets 实现服务器列表
    """
    queryset = Server.objects.all()
    serializer_class = ServerSerializer
    
    # 指定此视图要使用的分页类
    pagination_class = StandardResultsSetPagination

2.3 URL 配置

from rest_framework import routers
from . import views
router = routers.DefaultRouter()

router.register(r'serverset', views.ServerViewSet)

urlpatterns = [
    path('', include(router.urls)),
]

2.4 效果图