Django自定义实现分页器

目录

• 1、分析和推导
  • 1.1 当前页
  • 1.2 起始位置和终止位置
  • 1.3 添加按钮传递页码数
• 2、方法的封装
  • 2.1 分页器类
  • 2.2 视图函数
  • 2.3 模板页面

前面的文章中分别介绍了drf框架中分页器的使用及Django框架中分页器的用法，其重点在于视图函数和模板页面如何利用自带的分页器的相关参数进行数据传递和页面渲染

本文继续介绍分页器，即自定义分页器如何实现，其实也就是如何使用自定义的方式计算出和上面类似自带的分页器的相关参数值

1、分析和推导

分页中的关键信息：当前页、每页展示多少条、起始位置、终止位置

1.1 当前页

思路：浏览器携带页码发送get请求，获取当前页信息。后端从get请求中获取响应的页码数，查询对应数据并返回

# 想访问哪一页
current_page = request.GET.get('page', 1)  # 如果获取不到当前页码 就展示第一页
# 数据类型转换，将获取的字符串页码转换成int
try:
  current_page = int(current_page)
except Exception:
    current_page = 1

1.2 起始位置和终止位置

每页条数、起始位置、终止位置的推导

per_page_num = 10
current_page                start_page                  end_page
    1                           0                           10
    2                           10                          20
    3                           20                          30
    4                           30                          40


per_page_num = 5
current_page                start_page                  end_page
    1                           0                           5
    2                           5                           10
    3                           10                          15
    4                           15                          20

由此得出三者之间的关系

start_page = (current_page - 1) * per_page_num
end_page = current_page * per_page_num

最终基于页码查询出当前页的数据

# 每页展示多少条
per_page_num = 10
# 起始位置
start_page = (current_page - 1) * per_page_num
# 终止位置
end_page = current_page * per_page_num
book_queryset = book_list[start_page:end_page]

1.3 添加按钮传递页码数

总的页码数需要传递到页面，总页数与总数和每页数有关系，例如

总数据100 每页展示10 需要10页
总数据101 每页展示10 需要11页
总数据99  每页展示10 需要10页

如何动态计算到底需要多少页呢？这里可以利用divmod方法来计算总数与每页个数的商和余数，余数不为0时，把页数加1

# 分页
book_list = models.Book.objects.all()
# 计算出到底需要多少页
all_count = book_list.count()
page_count, more = divmod(all_count, per_page_num)  # 计算总数%每页个数的商和余数，余数不为0时，把页数+1
if more:  # 有余数则总页数加一
    page_count += 1

关于页码布局，在制作页码个数的时候一般情况下都是奇数个页码，这更符合对称美的标准

最后，在后端把页码计算逻辑写出来动态的传给前端

# 在后端把页码计算逻辑写出来传给前端
page_html = ''
x = current_page
if current_page < 6:  # 控制页码数量，当小于6时，不显示负数页码
    current_page = 6
for i in range(current_page - 5, current_page + 6):  # 显示11个页码，被选中的在最中间
    if x == i:  # 高亮显示被选中的那一个页码
        page_html += '<li class="active"><a href="?page=%s">%s</a></li>' % (i, i)
    else:
        page_html += '<li><a href="?page=%s">%s</a></li>' % (i, i)

book_queryset = book_list[start_page:end_page]
return render(request, 'ab_pl.html', locals())

前端模板页面接收

<ul class="pagination">
    <li>
      <a href="#" aria-label="Previous">
        <span aria-hidden="true">&laquo;</span>
      </a>
    </li>
    {{ page_html|safe }}
    <li>
      <a href="#" aria-label="Next">
        <span aria-hidden="true">&raquo;</span>
      </a>
    </li>
</ul>

到这里，就实现了后端动态的根据已有的数据并动态的将页码数传递到了前端页面渲染生成对应的页码按钮

2、方法的封装

上面是自定义分页器开发流程的基本推导思路，最后将自定义分页器进行封装

2.1 分页器类

mypage.py

class Pagination(object):
    def __init__(self, current_page, all_count, per_page_num=2, pager_count=11):
        """
        封装分页相关数据
        :param current_page: 当前页
        :param all_count:    数据库中的数据总条数
        :param per_page_num: 每页显示的数据条数
        :param pager_count:  最多显示的页码个数
        """
        try:
            current_page = int(current_page)
        except Exception as e:
            current_page = 1
        if current_page < 1:
            current_page = 1
        self.current_page = current_page
        self.all_count = all_count
        self.per_page_num = per_page_num

        # 总页码
        all_pager, tmp = divmod(all_count, per_page_num)
        if tmp:
            all_pager += 1
        self.all_pager = all_pager

        self.pager_count = pager_count
        self.pager_count_half = int((pager_count - 1) / 2)

    @property
    def start(self):
        return (self.current_page - 1) * self.per_page_num

    @property
    def end(self):
        return self.current_page * self.per_page_num

    def page_html(self):
        # 如果总页码 < 11个：
        if self.all_pager <= self.pager_count:
            pager_start = 1
            pager_end = self.all_pager + 1
        # 总页码  > 11
        else:
            # 当前页如果<=页面上最多显示11/2个页码
            if self.current_page <= self.pager_count_half:
                pager_start = 1
                pager_end = self.pager_count + 1
            # 当前页大于5
            else:
                # 页码翻到最后
                if (self.current_page + self.pager_count_half) > self.all_pager:
                    pager_end = self.all_pager + 1
                    pager_start = self.all_pager - self.pager_count + 1
                else:
                    pager_start = self.current_page - self.pager_count_half
                    pager_end = self.current_page + self.pager_count_half + 1
        page_html_list = []
        # 添加前面的nav和ul标签
        page_html_list.append('''
                    <nav aria-label='Page navigation>'
                    <ul class='pagination'>
                ''')
        first_page = '<li><a href="?page=%s">首页</a></li>' % (1)
        page_html_list.append(first_page)

        if self.current_page <= 1:
            prev_page = '<li class="disabled"><a href="#">上一页</a></li>'
        else:
            prev_page = '<li><a href="?page=%s">上一页</a></li>' % (self.current_page - 1,)

        page_html_list.append(prev_page)

        for i in range(pager_start, pager_end):
            if i == self.current_page:
                temp = '<li class="active"><a href="?page=%s">%s</a></li>' % (i, i,)
            else:
                temp = '<li><a href="?page=%s">%s</a></li>' % (i, i,)
            page_html_list.append(temp)

        if self.current_page >= self.all_pager:
            next_page = '<li class="disabled"><a href="#">下一页</a></li>'
        else:
            next_page = '<li><a href="?page=%s">下一页</a></li>' % (self.current_page + 1,)
        page_html_list.append(next_page)

        last_page = '<li><a href="?page=%s">尾页</a></li>' % (self.all_pager,)
        page_html_list.append(last_page)
        # 尾部添加标签
        page_html_list.append('''
                                           </nav>
                                           </ul>
                                       ''')
        return ''.join(page_html_list)

2.2 视图函数

视图函数中引用

from utils.mypage import Pagination

def get_books(request):
    book_queryset = models.Book.objects.all()
    current_page = request.GET.get("page", 1)
    all_count = book_queryset.count()
    # 1 传值生成对象
    page_obj = Pagination(current_page=current_page, all_count=all_count, per_page_num=10)
    # 2 直接对总数据进行切片操作
    page_queryset = book_list[page_obj.start:page_obj.end]
    # 3 将page_queryset传递到页面
    return render(request, 'booklist.html', locals())

2.3 模板页面

模板页面中渲染

<div class="container">
    <div class="row">
        <div class="col-md-8 col-md-offset-2">
            {% for book in page_queryset %}
            <p>{{ book.title }}</p>
            {% endfor %}
          	{#利用自定义分页器直接显示分页器样式#}
            {{ page_obj.page_html|safe }}
        </div>
    </div>
</div>