Django rest framework 之分页
Django rest_framework 中分页可分为三类:
- PageNumberPagination:看第 n 页,每页显示 n 条数据
- LimitOffsetPagination:在 n 个位置,向后查看 n 条数据
- CursorPagination:加密分页,只能看上一页和下一页
一、PageNumberPagination
在这里将采用 rest_framework
内置的页面渲染器 Response
。
1、api/serializers.py
class PagesSerializers(serializers.ModelSerializer):
"""分页"""
class Meta:
model = models.Role
fields = '__all__'
2、api/views.py
from rest_framework.response import Response # 渲染器
from .serializers import PagesSerializers
from app import models
from rest_framework.pagination import PageNumberPagination
class PageView(APIView):
"""分页"""
def get(self, request, *args, **kwargs):
"""示例:
http://api.example.org/accounts/?page=4
http://api.example.org/accounts/?page=4&page_size=100
"""
roles = models.Role.objects.all()
# 创建分页对象
pg = PageNumberPagination()
# 获取分页数据
page_roles = pg.paginate_queryset(queryset=roles, request=request, view=self)
# 将分页后的数据序列化
roles_ser = PagesSerializers(instance=page_roles, many=True)
# 将序列化后的数据渲染到前端显示,这里采用的是 rest_framework 的渲染器 Response
return Response(roles_ser.data)
3、api/urls.py
from django.urls import path, re_path
from api.views import UserView, ParserView, RolesView, UserInfoView, GroupView, UserGroupView, PageView
urlpatterns = [
re_path('(?P<version>[v1|v2]+)/pages/', PageView.as_view()), # 分页
]
4、另外需要配置每页显示的条数 settings.py
REST_FRAMEWORK = {
"DEFAULT_VERSION": 'v1', # 默认的版本
"ALLOWED_VERSIONS": ['v1', 'v2'], # 允许的版本
"VERSION_PARAM": 'version', # GET方式url中参数的名字 ?version=xxx
"PAGE_SIZE": 2, # 每页最多显示两条数据
}
5、访问(第二页数据):http://127.0.0.1:8000/api/v2/pages/?page=2
自定义分页
定义一个类,让它继承 PageNumberPagination
1、api/views.py
class MyPageNumberPagination(PageNumberPagination):
"""自定义分页类"""
page_size = 2 # 每页最多显示的条数
page_query_param = 'page' # 查询参数,URL 中的过滤参数
# 通过 page_size 每页只显示 2 条,使用下面这个参数可以改变默认显示条数
# 使用方法 http://127.0.0.1:8000/api/v2/pages/?page=2&size=3
page_size_query_param = 'size'
max_page_size = 10 # 最大页数
class PageView(APIView):
"""分页"""
def get(self, request, *args, **kwargs):
"""
http://api.example.org/accounts/?page=4
http://api.example.org/accounts/?page=4&page_size=100
"""
roles = models.Role.objects.all()
# 创建分页对象
# pg = PageNumberPagination()
pg = MyPageNumberPagination()
# 获取分页数据
page_roles = pg.paginate_queryset(queryset=roles, request=request, view=self)
# 将分页后的数据序列化
roles_ser = PagesSerializers(instance=page_roles, many=True)
# 将序列化后的数据渲染到前端显示,这里采用的是 rest_framework 的渲染器 Response
return Response(roles_ser.data)
2、访问:http://127.0.0.1:8000/api/v2/pages/?page=2&size=1
二、LimitOffsetPagination
LimitOffsetPagination
可以控制只查看多少条,以及偏移量 offset
后多少条数据,格式为:
http://api.example.org/accounts/?limit=100 # 控制查看 100 条数据
http://api.example.org/accounts/?offset=400&limit=100 # 偏移量 400,查看条数 100,即查看 400 后的 100 条数据
使用方法与 PageNumberPagination
一致:
from rest_framework.pagination import PageNumberPagination, LimitOffsetPagination
class PageView(APIView):
"""分页"""
def get(self, request, *args, **kwargs):
"""
http://api.example.org/accounts/?page=4
http://api.example.org/accounts/?page=4&page_size=100
"""
roles = models.Role.objects.all()
# 创建分页对象
# pg = PageNumberPagination()
# pg = MyPageNumberPagination()
pg = LimitOffsetPagination()
# 获取分页数据
page_roles = pg.paginate_queryset(queryset=roles, request=request, view=self)
# 将分页后的数据序列化
roles_ser = PagesSerializers(instance=page_roles, many=True)
# 将序列化后的数据渲染到前端显示,这里采用的是 rest_framework 的渲染器 Response
return Response(roles_ser.data)
查看第 2 条数据后的 3 条数据:
自定义
同样地 LimitOffsetPagination
也支持自定义:
#自定义分页类2
class MyLimitOffsetPagination(LimitOffsetPagination):
#默认显示的个数
default_limit = 2
#当前的位置
offset_query_param = "offset"
#通过limit改变默认显示的个数
limit_query_param = "limit"
#一页最多显示的个数
max_limit = 10
get_paginated_response() 方法控制前后页面
api/views.py
class PageView(APIView):
"""分页"""
def get(self, request, *args, **kwargs):
"""
http://api.example.org/accounts/?page=4
http://api.example.org/accounts/?page=4&page_size=100
"""
roles = models.Role.objects.all()
# 创建分页对象
# pg = PageNumberPagination()
# pg = MyPageNumberPagination()
pg = LimitOffsetPagination()
# 获取分页数据
page_roles = pg.paginate_queryset(queryset=roles, request=request, view=self)
# 将分页后的数据序列化
roles_ser = PagesSerializers(instance=page_roles, many=True)
# 将序列化后的数据渲染到前端显示,这里采用的是 rest_framework 的渲染器 Response
# return Response(roles_ser.data)
return pg.get_paginated_response(roles_ser.data) # 这一行
效果如下:
三、CursorPagination
CursorPagination
将页码进行加密,使得不能通过 URL 来控制显示的页面
1、这里使用自定义分页类 api/views.py
class MyCursorPagination(CursorPagination):
"""自定义分页类"""
page_size = 2 # 每页最多显示的条数
cursor_query_param = 'cursor' # 查询参数,URL 中的过滤参数
ordering = 'id' # 通过什么排序(正序)
page_size_query_param = None
max_page_size = None # 最大页数
class PageView(APIView):
"""分页"""
def get(self, request, *args, **kwargs):
"""
http://api.example.org/accounts/?page=4
http://api.example.org/accounts/?page=4&page_size=100
"""
roles = models.Role.objects.all()
# 创建分页对象
# pg = PageNumberPagination()
# pg = MyPageNumberPagination()
# pg = LimitOffsetPagination()
pg = MyCursorPagination()
# 获取分页数据
page_roles = pg.paginate_queryset(queryset=roles, request=request, view=self)
# 将分页后的数据序列化
roles_ser = PagesSerializers(instance=page_roles, many=True)
# 将序列化后的数据渲染到前端显示,这里采用的是 rest_framework 的渲染器 Response
# return Response(roles_ser.data)
return pg.get_paginated_response(roles_ser.data)
2、访问: http://127.0.0.1:8000/api/v2/pages/
Django rest framework 之分页的更多相关文章
- Django Rest framework 之 分页
RESTful 规范 django rest framework 之 认证(一) django rest framework 之 权限(二) django rest framework 之 节流(三) ...
- django rest framework实现分页功能
在web开发中很多需求都需要实现分页功能,然而 Django Rest Framework 自带的分页功能,只能在 mixins.ListModelMixin and generics.Generic ...
- Django REST framework的分页
DRF分页组件 为什么要使用分页 我们数据表中可能会有成千上万条数据,当我们访问某张表的所有数据时,我们不太可能需要一次把所有的数据都展示出来,因为数据量很大,对服务端的内存压力比较大还有就是网络传输 ...
- Django REST framework 之分页,视图,路由,渲染器
1.分页 2.视图 3.路由 4.渲染器 1.分页 方法一: from django.shortcuts import render from rest_framework.versioning im ...
- Django Rest framework 之 序列化
RESTful 规范 django rest framework 之 认证(一) django rest framework 之 权限(二) django rest framework 之 节流(三) ...
- Django Rest framework 之 解析器
RESTful 规范 django rest framework 之 认证(一) django rest framework 之 权限(二) django rest framework 之 节流(三) ...
- Django Rest framework 之 版本
RESTful 规范 django rest framework 之 认证(一) django rest framework 之 权限(二) django rest framework 之 节流(三) ...
- Django Rest framework 之 节流
RESTful 规范 django rest framework 之 认证(一) django rest framework 之 权限(二) django rest framework 之 节流(三) ...
- Django Rest framework 之 权限
django rest framework 之 认证(一) django rest framework 之 权限(二) django rest framework 之 节流(三) django res ...
随机推荐
- 转 史上最详细的Hadoop环境搭建
GitChat 作者:鸣宇淳 原文:史上最详细的Hadoop环境搭建 关注公众号:GitChat 技术杂谈,一本正经的讲技术 [不要错过文末活动哦] 前言 Hadoop在大数据技术体系中的地位至关重要 ...
- Asp.Net 服务器控件下使用Jquery.validate.js
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/ ...
- spring boot2X集成spring cloud config
Spring Cloud Config 分为 Config Server: 分布式配置中心,是一个独立的微服务应用,用来连接配置服务器并为客户端提供获取配置信息 Config Client: 通过指定 ...
- 设计高性能大并发WEB系统架构注意点
设计高性能大并发WEB系统架构注意点 第01:大型架构的演进之路第02(上):分布式缓存第02(下):分布式缓存第03:分布式消息队列第04:分布式数据存储第05:分布式服务框架第06:高性能系统架构 ...
- 数据库连接池, websocket
转自: https://www.cnblogs.com/xiao987334176/p/9605536.html 一.DButils 什么是数据库连接池 数据库连接池负责分配.管理和释放数据库连接,它 ...
- logstash设置开机自启动
本篇文件前提是在centos7.6上使用rpm包安装的logstash,添加systemd方式启动. #默认为rpm包安装,进行执行目录 cd /usr/share/logstash/bin/ #系统 ...
- webstorm创建js文件时自动生成js注释
设置webstorm创建js文件时自动生成js注释 settings--Editor--File and Code Temlates 黑色框框里的内容自己填写上去,以下是参考的代码块: /** * @ ...
- 图论 --- 骑士周游问题,DFS
A Knight's Journey Time Limit: 1000MS Memory Limit: 65536K Total Submissions: 28630 Accepted: ...
- R语言dataframe的常用操作总结
前言:近段时间学习R语言用到最多的数据格式就是data.frame,现对data.frame常用操作进行总结,其中函数大部分来自dplyr包,该包由Hadley Wickham所作,主要用于数据的清洗 ...
- Gitbook常用命令
npm install gitbook-cli -g gitbook ls :列出本地安装版本: gitbook current :列出当前使用版本: gitbook ls-remote :列出远程可 ...