当前位置: 首页 > news >正文

【Django】Django DRF 中如何手动调用分页器返回分页数据(APIView,action场景)

📦 Django DRF 中如何手动调用分页器返回分页数据(APIView,action场景)

在使用 Django REST Framework(DRF)时,很多人习惯了用 GenericAPIViewViewSet 自动帮我们处理分页。但在某些场景中,例如使用原始的 APIView,你就需要 手动调用分页器 来返回分页数据。

如果你也遇到以下问题:

  • ❓为什么我的 APIView 不分页?
  • ❓我能不能在普通的 APIView 里也使用 DRF 的分页?
  • ❓如何返回 countnextprevious 等结构?

本文将带你一步步搞定!


🎯 目标

我们将实现这样一个接口:

GET /api/books/?page=2&page_size=5

返回内容:

{"count": 42,"next": "http://api.example.com/api/books/?page=3&page_size=5","previous": "http://api.example.com/api/books/?page=1&page_size=5","results": [{ "id": 6, "title": "第6本书" },{ "id": 7, "title": "第7本书" }]
}

⚙️ 一、为什么 APIView 不会自动分页?

因为分页逻辑默认写在 GenericAPIView 里,而 APIView 是最基础的类,不会自动处理分页、过滤、排序等操作。

所以我们需要 手动创建分页器 + 手动调用两个方法

  • paginate_queryset(queryset, request):返回当前页数据
  • get_paginated_response(data):返回统一格式响应

🛠️ 二、完整示例代码

假设我们有一个 Book 模型和对应的序列化器:

# models.py
class Book(models.Model):title = models.CharField(max_length=100)
# serializers.py
class BookSerializer(serializers.ModelSerializer):class Meta:model = Bookfields = ['id', 'title']

接下来,在视图中手动分页:

# views.py
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.pagination import PageNumberPagination
from .models import Book
from .serializers import BookSerializerclass BookListView(APIView):def get(self, request):queryset = Book.objects.all().order_by('id')# 1. 创建分页器对象paginator = PageNumberPagination()paginator.page_size = 10  # 每页数量(可配置)# 2. 手动分页page = paginator.paginate_queryset(queryset, request)# 3. 序列化当前页数据serializer = BookSerializer(page, many=True)# 4. 返回分页响应return paginator.get_paginated_response(serializer.data)

🧰 三、支持 URL 参数控制分页

你可以通过以下方式控制分页:

GET /api/books/?page=2&page_size=5
  • page:页码
  • page_size:每页条数(需要设置 page_size_query_param

想支持自定义 page_size?给分页器加一行:

paginator.page_size_query_param = 'page_size'

✨ 四、进阶:自定义返回结构

默认返回结构长这样:

{"count": 42,"next": "...","previous": "...","results": [...]
}

如果你想自定义成更“业务风格”的结构,例如:

{"code": 0,"message": "ok","data": {"total": 42,"page": 2,"page_size": 10,"list": [...]}
}

可以自定义分页类:

from rest_framework.pagination import PageNumberPagination
from rest_framework.response import Responseclass CustomPagination(PageNumberPagination):page_size_query_param = 'page_size'def get_paginated_response(self, data):return Response({"code": 0,"message": "ok","data": {"total": self.page.paginator.count,"page": self.page.number,"page_size": self.page.paginator.per_page,"list": data}})

然后在视图中使用:

paginator = CustomPagination()

✅ 总结

步骤方法说明
创建分页器实例paginator = PageNumberPagination()
分页数据page = paginator.paginate_queryset(queryset, request)
序列化数据serializer = YourSerializer(page, many=True)
返回响应return paginator.get_paginated_response(serializer.data)

🧠 最后一句话:

即使你用的是最基础的 APIView,也可以优雅地分页 —— 手动调用分页器,就是打开分页大门的钥匙。


http://www.xdnf.cn/news/561295.html

相关文章:

  • eclipse 生成函数说明注释
  • 手术机器人行业新趋势:Kinova多机械臂协同系统如何突破复杂场景适应性瓶颈?
  • Idea 查找引用jar包依赖来源的Maven pom坐标
  • 实践大模型提示工程(Prompt Engineering)
  • 01. C#入门系列【你的第一个程序】从Hello World开始
  • 智能驾驶中的深度学习:基于卷积神经网络的车道线检测
  • Linux:进程信号---信号的保存与处理
  • docker使用
  • SRS流媒体服务器,配置国标协议对接和HTTPS视频流输出功能
  • 孤岛检测应用背景及实现原理
  • 解决Query Error: [S1000][15233] 无法添加属性。‘dbo.xxx.area_ids‘ 已存在属性‘MS_Description‘。
  • PaddleOCR的Pytorch推理模块
  • 每日算法-250521
  • RISC-V IDE MRS2 开发笔记一:volatile关键字的使用
  • ArcGIS Pro 3.4 二次开发 - Arcade
  • react中运行 npm run dev 报错,提示vite.config.js出现错误 @esbuild/win32-x64
  • vue项目启动报错(node版本与Webpack)
  • 创建Workforce
  • Apollo10.0学习——cyber常用指令
  • windows7安装node18
  • DeepSeek源码解构:从MoE架构到MLA的工程化实现
  • 基于 Node.js 的 HTML 转 PDF 服务
  • 在C#中对List<T>实现多属性排序
  • PostgreSQL日常维护
  • FastAPI 支持文件下载和上传
  • Axure项目实战:智慧运输平台后台管理端-订单管理1(多级交互)
  • PDF 文档结构化工具对比:Marker 与 MinerU
  • 整除的进一步性质与最小公倍数
  • 【深度剖析】三一重工的数字化转型(上1)
  • 11-码蹄集600题基础python篇