Django REST framework学习笔记（六）——分页

妖狐艹你老母 2022-11-27 00:45 238阅读 0赞

如果没有设置分页，django-rest-framework 会将所有资源类表序列化后返回，如果资源很多，就会对网站性能造成影响。为此，我们来给博客文章列表 API 添加分页功能。

django-rest-framework 为分页功能提供了多个辅助类，常用的有：

PageNumberPagination

将资源分为第 1 页、第 2 页…第 n 页，使用页码号请求分页结果。

LimitOffsetPagination

通过 `limit` 和 `offset` 两个参数来控制请求的资源。例如通过发送 API 请求：/posts/?offset=20&limit=5，将获取文章资源列表第 20 篇后的 5 篇文章。如果 offset 以等差数列递增，limit 保持不变，则等价于按页码分页。但 offset 和 limit 可以为任意值，因此这种分页比 `PageNumberPagination` 更加灵活。

要使用分页功能非常简单，只需在项目的配置文件中配置好分页选项，即可全局启用分页功能。打开 settings.py配置文件，写入如下的分页配置：

REST_FRAMEWORK = { 
        # 设置DEFAULT_PAGINATION_CLASS 后将全局启动分页，所有List接口（继承了ListAPIView的类视图会）返回的结果都会分页
        # 如果想单独控制每个接口的分页情况，而是在类视图或者视图集中设置pagination_class指定要使用的分页辅助类
        "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
        # 这个选项控制分页后每页的资源个数
        "PAGE_SIZE": 10,
    }

配置完成之后，所有通用类视图（也可叫类视图函数）或者视图集生成的资源列表 API，返回的资源列表都会被分页。\[注意只有配置了全局分页配置，视图API分页才会生效，即在视图中配置单一分页器才有意义\]。配置文件中的分页设置将作用于全局，如果某个类视图或者视图集不想使用全局配置怎么办呢？可以在类视图或者视图集中设置 pagination\_class 属性，指定需要使用的分页辅助类即可。例如将博客文章列表分页替换为 limit offset 的分页方式，可以这样设置：

from rest_framewrok.pagination import PageNumberPagination
    
    class PostViewSet(viewsets.GenericViewSet):
        pagination_class = LimitOffsetPagination

这样，PostViewSet 视图集将返回 limit offset 分页形式的文章列表，而其他类视图或者视图集仍将使用全局的分页配置。

请求文章 api，返回结果如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTY2MDQxNA_size_16_color_FFFFFF_t_70_pic_center]

对返回结果的解释：

count：总资源数目

next：下一页资源的链接

previous：上一页资源的链接

results：当前页的资源列表

更多参考Django REST framework官网[Pagination部分][Pagination]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTY2MDQxNA_size_16_color_FFFFFF_t_70_pic_center]: /images/20221124/3e620206de494b9c9932b838516cfc21.png
[Pagination]: https://www.django-rest-framework.org/api-guide/pagination/