网络编程
位置:首页>> 网络编程>> Python编程>> Django分页器的用法详解

Django分页器的用法详解

作者:山山仙人  发布时间:2021-04-20 21:54:14 

标签:Django,分页器
目录
  • 1、准备基础数据

  • 2、一次性展示数据

  • 3、引入分页器

  • 附:drf分页器的使用

    • 1.1 PageNumberPagination

    • 1.2 LimitOffsetPagination

    • 1.3 CursorPagination

Django是一个大而全的框架。需要明确的是,传参进行分页获取分页后的数据,一般都是通过向服务器发送get请求的方式实现的,在向后端服务发送查看数据的同时可以携带一个或多个参数并发送get请求来实现分页查看功能

1、准备基础数据

设计表模型

为了体现分页的效果,需要先创建一个表并准备较多数据,模型如下


from django.db import models

# Create your models here.

class Book(models.Model):
   title = models.CharField(max_length=32)
   price = models.DecimalField(max_digits=9, decimal_places=2)  # 9999999.99

执行数据库迁移后,设计一个视图函数,通过触发视图函数往此表中批量插入数据

Django中利用orm实现批量插入一般有两种方式:单条插入或者利用bulk_create批量插入

最终翻译转换成sql语句也就类似于多条insert语句和一条insert的区别


def create_book(request):

# 批量插入方式一
   for i in range(100):
       Book.objects.create(title="book"+str(i),price=i*i)
# 批量插入方式二
   book_list = []
   for i in range(100):
       book = Book(title="book"+str(i),price=i*i)
       book_list.append(book)
   Book.objects.bulk_create(book_list)

return HttpResponse("添加成功")

2、一次性展示数据

接下来通过模板语法一次性将数据展示到前端页面

视图函数如下


def get_books(request):
   book_list = Book.objects.all()
   return render(request, "index.html", {"book_list": book_list})

模板页面index.html如下


<!DOCTYPE html>
<html lang="en">
<head>
   <meta charset="UTF-8">
   <title>Title</title>
</head>
<body>
<ul>
   {% for book in book_list %}
   <li>{ book.title } : { book.price }</li>
   {% endfor %}
</ul>
</body>
</html>

这时一次性访问即展示了所有的book

3、引入分页器

引入分页器后,可以对全局分页对象和单页对象进行相关操作,相关语法


# 引入分页器
from django.core.paginator import Paginator

...
   # 全局分页器对象
   paginator = Paginator([1,2,3,4,5,6,7,8,9,10],3)
   print(paginator.count) # 10  数据总数
   print(paginator.num_pages)  # 4  总页数
   print(paginator.page_range) # range(1, 5)  页码的列表

# 单页对象
   page = paginator.page(2)
   print(page.has_next())  # 是否有下一页
   print(page.next_page_number())  # 写一页的页码
   print(page.has_previous())  # 是否有上一页
   print(page.previous_page_number())  # 上一页的页码
   # 取出单页对象的值
   print(page.object_list) # [4, 5, 6]
   for i in page:
      print(i)

在这里的例子中具体使用分页器及模板语法,例如每页取出8条,获取用户给出的页码条件数,返回相应页的数据,默认不给出任何条件时返回第一页的数据


from django.core.paginator import Paginator
  # 取出当前用户页码
  current_num = int(request.GET.get("page", 1))
  book_list = Book.objects.all()
  paginator = Paginator(book_list, 8)
  page = paginator.page(current_num)

return render(request,"index.html",{"page":page})

最后,可以利用bootstrap组件在页面模板中添加翻页的按钮,在当前页时按钮加深,没有上一页时禁止点击


...
<body>

<ul>
   {% for book in page %}
   <li>{ book.title } : { book.price }</li>
   {% endfor %}
</ul>
<nav aria-label="Page navigation">
 <ul class="pagination">
   {% if page.has_previous %}
   <li>
     <a href="/?page={ page.previous_page_number }" rel="external nofollow"  aria-label="Previous">
       <span aria-hidden="true">上一页</span>
     </a>
   </li>
   {% else %}
   <li class="disabled">
     <a href="#" rel="external nofollow"  rel="external nofollow"  aria-label="Previous">
       <span aria-hidden="true">上一页</span>
     </a>
   </li>
   {% endif %}
     {% for num in page_range %}
     {% if num == current_num %}
         <li class="active"><a href="/?page={ num }" rel="external nofollow"  rel="external nofollow" >{ num }</a></li>
     {% else %}
         <li><a href="/?page={ num }" rel="external nofollow"  rel="external nofollow" >{ num }</a></li>
     {% endif %}
     {% endfor %}
   <li>
     <a href="#" rel="external nofollow"  rel="external nofollow"  aria-label="Next">
       <span aria-hidden="true">下一页</span>
     </a>
   </li>
 </ul>
</nav>
</body>
...

在视图函数中:处理相关异常;传递相关参数;当页码较多时只显示部分页码,例如最多时总共10个页码,当前页码始终在中间显示;单独处理出现边界情况,负数页码的情况及最大页码用完的情况


from django.core.paginator import Paginator
...
   # 取出当前用户页码
   current_num = int(request.GET.get("page", 1))
   book_list = Book.objects.all()
   paginator = Paginator(book_list, 8)
   page = paginator.page(current_num)

# 大于11页时
   if paginator.num_pages > 11:
       # 当前页码的后5页数超过最大页码时,显示最后10项
       if current_num + 5 > paginator.num_pages:
           page_range = range(paginator.num_pages - 10, paginator.num_pages + 1)
       # 当前页码的前5页数为负数时,显示开始的10项
       elif current_num - 5 < 1:
           page_range = range(1, 12)
       else:
           # 显示左5页到右5页的页码
           page_range = range(current_num - 5, current_num + 5 + 1)
   # 小于11页时显示所有页码
   else:
       page_range = paginator.page_range

return render(request, "index.html", {"page": page, "paginator": paginator, "current_num": current_num, "page_range": page_range})

附:drf分页器的使用

Django REST framework提供了分页的支持。

可以在配置文件中设置全局的分页方式,如:


REST_FRAMEWORK = {
   'DEFAULT_PAGINATION_CLASS':  'rest_framework.pagination.PageNumberPagination', # 选用的分页器
   'PAGE_SIZE': 100  # 每页数目
}

也可通过自定义Pagination类,来为视图添加不同分页行为。在视图中通过pagination_clas属性来指明。例如:


from rest_framework.pagination import PageNumberPagination

class MyPageNumberPagination(PageNumberPagination):
   # 设置url中的取多少页的key
   page_query_param = 'page'
   # 设置url中设置取数据条数的key
   page_size_query_param = 'size'
   #设置每一页的数据条数
   page_size = 2
   # 设置每一页最多可取的数据数
   max_page_size = 5

class Book2View(ListAPIView):
   queryset = models.Book.objects.all()
   serializer_class = BookModelSerializer
   pagination_class = MyPageNumberPagination #指定该视图类的分页器

注意:如果在视图内关闭分页功能,只需在视图内设置pagination_class = None 即可,即在设置了全局分页之后我们可以在局部禁用该设置。

drf 提供给我们的分页器有PageNumberPagination、LimitOffsetPagination、CursorPagination。

1.1 PageNumberPagination

url形式:


http://127.0.0.1:8000/books/?page=1

可以在自定义类中定义的属性有:

  • page_query_param :设置url中页数的关键字,默认的是page。

  • page_size_query_param :设置url中每页数据条数的关键字,默认的是None。

  • page_size :设置每一页的数据条数。(必设)

  • max_page_size : 设置每一页最多可取的数据条数。(可选)


class MyPageNumberPagination(PageNumberPagination):
   page_size = 2
   page_query_param = 'page'
   page_size_query_param = 'size'
   max_page_size = 5

class Book2View(ListAPIView):
   queryset = models.Book.objects.all()
   serializer_class = BookModelSerializer
   pagination_class = MyPageNumberPagination

# APIView 中使用自定义分页类进行分页操作
class  Pager(APIView):
   def get(self,request,*args,**kwargs):
       # 获取所有数据
       ret=models.Book.objects.all()
       # 创建分页对象
       page=MyPageNumberPagination()
       # 在数据库中获取分页的数据
       page_list=page.paginate_queryset(ret,request,view=self)
       # 对分页进行序列化
       ser=BookSerializer1(instance=page_list,many=True)
       # return Response(ser.data)
       # 这个也是返回Response对象,但是比基本的多了上一页,下一页,和总数据条数(了解)
       return page.get_paginated_response(ser.data)

1.2 LimitOffsetPagination

url形式:


http://127.0.0.1/four/books/?limit=100&offset=400

可以在自定义类中定义的属性有:

  • default_limit :默认限制,默认值与PAGE_SIZE设置一致。

  • limit_query_param : limit参数名,默认为limit。

  • offset_query_param : offset参数名,默认offset。

  • max_limit : 最大limit限制,默认None。


class MyLimitOffsetPagination(LimitOffsetPagination):
   default_limit = 3
   limit_query_param = 'limit'
   max_limit = None
   offset_query_param = 'offset'

class Book2View(ListAPIView):
   queryset = models.Book.objects.all()
   serializer_class = BookModelSerializer
   pagination_class = MyLimitOffsetPagination

# APIView 中使用自定义分页类进行分页操作
class  Pager(APIView):
   def get(self,request,*args,**kwargs):
       # 获取所有数据
       ret=models.Book.objects.all()
       # 创建分页对象
       page=LimitOffsetPagination()
       # 在数据库中获取分页的数据
       page_list=page.paginate_queryset(ret,request,view=self)
       # 对分页进行序列化
       ser=BookSerializer1(instance=page_list,many=True)
       # return page.get_paginated_response(ser.data)
       return Response(ser.data)

1.3 CursorPagination

url形式:


http://127.0.0.1/four/books/?cursor=cD0xNQ%3D%3D

可以在自定义类中定义的属性有:

  • cursor_query_param:默认查询字段,不需要修改。

  • page_size:每页数目。

  • ordering:按什么排序,需要指定。


class MyCursorPagination(CursorPagination):
   cursor_query_param = 'cursor'
   page_size = 2
   ordering = '-id'

class Book2View(ListAPIView):
   queryset = models.Book.objects.all()
   serializer_class = BookModelSerializer
   pagination_class = MyCursorPagination

# APIView 中使用自定义分页类进行分页操作
class  Pager(APIView):
   def get(self,request,*args,**kwargs):
       # 获取所有数据
       ret=models.Book.objects.all()
       # 创建分页对象
       page=CursorPagination()
       page.ordering='nid'
       # 在数据库中获取分页的数据
       page_list=page.paginate_queryset(ret,request,view=self)
       # 对分页进行序列化
       ser=BookSerializer1(instance=page_list,many=True)
       # 可以避免页码被猜到
       return page.get_paginated_response(ser.data)

来源:https://www.ssgeek.com/post/django-fen-ye-qi-de-yong-fa/

0
投稿

猜你喜欢

手机版 网络编程 asp之家 www.aspxhome.com