Django 分页

等到的等待
320 阅读6分钟

这是我参与11月更文挑战的第14天，活动详情查看：2021最后一次更文挑战

一、简介

分页对于大多数网站来说是必不可少的，那你使用restful架构时候，你可以从后台获取数据，在前端利用利用框架或自定义分页，这是一种解决方案。当然django rest framework提供了分页组件，让我们可以更灵活的进行分页。

django rest framework提供了三种分页组件：

  • PageNumberPagination：普通分页，查看第n页，每个页面显示n条数据
  • LimitOffsetPagination： 基于位置的分页，在第n个位置，向后查看n条数据，和数据库的sql语句中的limit offset类似，参数offet代表位置，limit代表取多少条数据。
  • CursorPagination：游标分页，意思就是每次返回当前页、上一页、下一页，并且每次的上一页和下一页的url是不规则的

二、每个分页组件使用

这里我们使用之前的模型，如果没有在setting中注册django rest framework 请注册它，为了方便我们查看分页，配置项在INSTALLED_APPS：

1.PageNumberPagination类分页

settings.py

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'app01.apps.App01Config',
    'rest_framework',  #注册DRF
]

models.py

from django.db import models

class UserInfo(models.Model):
    user_type_choice = (
        (1,"普通用户"),
        (2,"会员"),
    )
    user_type = models.IntegerField(choices=user_type_choice)
    username = models.CharField(max_length=32,unique=True)
    password = models.CharField(max_length=64)
    group = models.ForeignKey(to='UserGroup',null=True,blank=True)
    roles = models.ManyToManyField(to='Role')


class UserToken(models.Model):
    user = models.OneToOneField(to=UserInfo)
    token = models.CharField(max_length=64)



class UserGroup(models.Model):
    """用户组"""
    name = models.CharField(max_length=32,unique=True)


class Role(models.Model):
    """角色"""
    name = models.CharField(max_length=32,unique=True)

urls.py

urlpatterns = [

    # url(r'^api/v1/auth', views.AuthView.as_view()),# url(r'^api/v1/order', views.OrderView.as_view()),
    url(r'^api/v1/roles', views.RoleView.as_view()),   #分页示例1
    url(r'^api/v1/userinfo', views.UserinfoView.as_view()),
    url(r'^api/v1/group/(?P<xxx>\d+)', views.GroupView.as_view(),name='gp'),
    # url(r'^api/(?P<version>[v1|v2]+)/user', views.UserView.as_view(),name="user_view"),
]

本次我们使用roles来作为示例，并且为了更好的显示，此次会用到django rest framework 的响应（Response），后续会介绍，下面是对角色视图的序列化，这个已经在前面的序列化篇章中说明如下：

from rest_framework import serializers
from rest_framework.response import Response   #使用DRF自带的响应页面更美观
class RolesSerializer(serializers.Serializer): #定义序列化类
    id=serializers.IntegerField()  #定义需要提取的序列化字段,名称和model中定义的字段相同
    name=serializers.CharField()
class RoleView(APIView):
    """角色"""
    def get(self,request,*args,**kwargs):
        roles=models.Role.objects.all()
        res=RolesSerializer(instance=roles,many=True) #instance接受queryset对象或者单个model对象，当有多条数据时候，使用many=True,单个对象many=Falsereturn Response(res.data)

访问：http://127.0.0.1:8000/api/v1/roles ，显示出所有的角色，如下：

加入分页后的角色视图：

from rest_framework import serializers
from rest_framework.response import Response   #使用DRF自带的响应页面更美观from rest_framework.pagination import PageNumberPagination
class RolesSerializer(serializers.Serializer): #定义序列化类
    id=serializers.IntegerField()  #定义需要提取的序列化字段,名称和model中定义的字段相同
    name=serializers.CharField()
class RoleView(APIView):
    """角色"""
    def get(self,request,*args,**kwargs):
        roles=models.Role.objects.all() # 获取所有数据
        pg_obj=PageNumberPagination()  # 实例化分页类                                         pg_res=pg_obj.paginate_queryset(queryset=roles,request=request,view=self)
        # 获取分页数据，参数一 分页的数据，QuerySet类型，请求request,分页的视图，self代表自己
        res=RolesSerializer(instance=pg_res,many=True)  # 对分完页码的数据进行序列化return Response(res.data)

同时，我们还需要配置每页显示的数据条数，在settings.py中：

REST_FRAMEWORK = {
    "DEFAULT_PARSER_CLASSES": ["rest_framework.parsers.JSONParser", "rest_framework.parsers.JSONParser"],# 全局解析器配置"PAGE_SIZE":2,#配置每页显示多少条数据
}

此时我们访问：http://127.0.0.1:8000/api/v1/roles?page=1 ，则显示第一页，访问http://127.0.0.1:8000/api/v1/roles?page=2 则显示第二页，如下图：

但是一般情况我们需要自己定义分页类，来定制更多的功能，示例：

自定义分页，更多的定制功能：

from rest_framework import serializers
from rest_framework.response import Response   #使用DRF自带的响应页面更美观from rest_framework.pagination import PageNumberPagination

class Mypagination(PageNumberPagination):
    """自定义分页"""
    page_size=2  #默认每页显示个数配置
    page_query_param = 'p' # 页面传参的key,默认是page
    page_size_query_param='size'  # 指定每页显示个数参数
    max_page_size=4 # 每页最多显示个数配置，使用以上配置，可以支持每页可显示2~4条数据class RolesSerializer(serializers.Serializer): #定义序列化类
    id=serializers.IntegerField()  #定义需要提取的序列化字段,名称和model中定义的字段相同
    name=serializers.CharField()
class RoleView(APIView):
    """角色"""def get(self,request,*args,**kwargs):
        roles=models.Role.objects.all() # 获取所有数据
        pg_obj=Mypagination()  # 实例化分页类
        pg_res=pg_obj.paginate_queryset(queryset=roles,request=request,view=self)
        # 获取分页数据，参数一 分页的数据，QuerySet类型，请求request,分页的视图，self代表自己
        res=RolesSerializer(instance=pg_res,many=True)  # 对分完页码的数据进行序列化return Response(res.data)

访问：http://127.0.0.1:8000/api/v1/roles?p=1&size=3 ，需要注意的是此时的分页参数已经重写，查看结果：

自带返回上一页下一页功能:

from rest_framework import serializers
from rest_framework.response import Response   #使用DRF自带的响应页面更美观from rest_framework.pagination import PageNumberPagination

class Mypagination(PageNumberPagination):
    """自定义分页"""
    page_size=2  #默认每页显示个数配置
    page_query_param = 'p' # 页面传参的key,默认是page
    page_size_query_param='size'  # 指定每页显示个数参数
    max_page_size=4 # 每页最多显示个数配置，使用以上配置，可以支持每页可显示2~4条数据class RolesSerializer(serializers.Serializer): #定义序列化类
    id=serializers.IntegerField()  #定义需要提取的序列化字段,名称和model中定义的字段相同
    name=serializers.CharField()
class RoleView(APIView):
    """角色"""def get(self,request,*args,**kwargs):
        roles=models.Role.objects.all() # 获取所有数据
        pg_obj=Mypagination()  # 实例化分页类
        pg_res=pg_obj.paginate_queryset(queryset=roles,request=request,view=self)
        # 获取分页数据，参数一 分页的数据，QuerySet类型，请求request,分页的视图，self代表自己
        res=RolesSerializer(instance=pg_res,many=True)  # 对分完页码的数据进行序列化return pg_obj.get_paginated_response(res.data)   # 使用分页自带的respose返回，具有上一页下一页功能

2.LimitOffsetPagination类分页

同样我们以角色视图做示例，通过自定义实现分页，示例：

from rest_framework import serializers
from rest_framework.response import Response   #使用DRF自带的响应页面更美观from rest_framework.pagination import PageNumberPagination,LimitOffsetPagination

class MyLimitOffsetPagination(LimitOffsetPagination):

    default_limit = 2 #默认显示的个数
    offset_query_param = "offset" #指定url中位置key值，其位置从0开始
    limit_query_param = "limit"  # 指定url中的偏移个数（显示个数）的key值
    max_limit = 10  #最多显示（偏移）的个数class RolesSerializer(serializers.Serializer): #定义序列化类
    id=serializers.IntegerField()  #定义需要提取的序列化字段,名称和model中定义的字段相同
    name=serializers.CharField()
class RoleView(APIView):
    """角色"""def get(self,request,*args,**kwargs):
        roles=models.Role.objects.all() # 获取所有数据
        pg_obj=MyLimitOffsetPagination() # 实例化分页类
        pg_res=pg_obj.paginate_queryset(queryset=roles,request=request,view=self)
        # 获取分页数据，参数一 分页的数据，QuerySet类型，请求request,分页的视图，self代表自己
        res=RolesSerializer(instance=pg_res,many=True)  # 对分完页码的数据进行序列化return Response(res.data)

访问：http://127.0.0.1:8000/api/v1/roles?offset=1&limit=4 （从第2个位置开始，查看4条数据），结果如下：

 

3.CursorPagination类实现分页（很少用）

示例：

from rest_framework import serializers
from rest_framework.response import Response   #使用DRF自带的响应页面更美观from rest_framework.pagination import PageNumberPagination,LimitOffsetPagination,CursorPagination

class MyCursorPagination(CursorPagination):
    cursor_query_param = "cursor"  #url获取分页的key
    page_size = 2     #每页显示2个数据
    ordering = 'id'   #排序规则
    page_size_query_param = 'size' #每页显示多少条参数配置
    max_page_size = 5    #每页最多显示多少条数据class RolesSerializer(serializers.Serializer): #定义序列化类
    id=serializers.IntegerField()  #定义需要提取的序列化字段,名称和model中定义的字段相同
    name=serializers.CharField()
class RoleView(APIView):
    """角色"""def get(self,request,*args,**kwargs):
        roles=models.Role.objects.all() # 获取所有数据
        pg_obj=MyCursorPagination() # 实例化分页类
        pg_res=pg_obj.paginate_queryset(queryset=roles,request=request,view=self)
        # 获取分页数据，参数一 分页的数据，QuerySet类型，请求request,分页的视图，self代表自己
        res=RolesSerializer(instance=pg_res,many=True)  # 对分完页码的数据进行序列化return pg_obj.get_paginated_response(res.data)

访问http://127.0.0.1:8000/api/v1/roles ，结果如下，从结果中可以看到下一页的url并不规则：

avatar
文章
阅读
粉丝