扩展Django中的分页

Django中封装了分页模块，定义了两个类分别是Paginator和Page。虽然可以满足一般的需求，但是稍想添加点新的功能就显得鸡肋，而且创建paginator类对象时需要传人所有的数据对象（由于django的惰性查询所以适用django），没有可移植性。

下面先在原分类模块基础上另外封装两个功能，分别实现设置页面最多显示页码数 和切换页码时保留原搜索条件。

一、设置页面最多显示页码数

设置最多页码数后，页面显示的页码和总页码数还有当前页码有关，封装一个类继承自Paginator，定义pager_num_range方法如下：

from django.core.paginator import Paginator

class CustomPaginator(Paginator):

    def __init__(self,current_page,per_pager_number,*args, **kwargs):
        # 当前页
        self.current_page = int(current_page)
        # 页面最多显示的页码数
        self.per_pager_number = int(per_pager_number)
        self.per_pager_number = int(per_pager_number)
        super(CustomPaginator,self).__init__(*args, **kwargs)

    def pager_num_range(self):
        # 页码最多显示的页码数的一半
        part = self.per_pager_number // 2
        # 总页数小于最多显示的页码数
        if self.num_pages < self.per_pager_number:
            return range(1, self.num_pages+1)
        # 当前页小于最多显示页码数的一半
        elif self.current_page <= part:
            return range(1, self.per_pager_number+1)
        # 当前页在最后的几页（从最多显示页码的一半往后几页）
        elif self.num_pages - self.current_page <= part:
            return range(self.num_pages-self.per_pager_number+1,self.num_pages+1)
        # 其余情况
        else:
            if self.per_pager_number % 2 == 0:
                return range(self.current_page-part+1, self.current_page+part+1)
            else:
                return range(self.current_page-part, self.current_page+part+1)

然后创建paginator类对象是通过CustomPaginator类创建即可，传入必要的参数

paginator = CustomPaginator(current_page,11,USER_LIST,10)

最后创建page类对象，渲染模板即可，模板中page类对象调用paginator.pager_numrange方法即可获取设置最多显示页码数后的页码列表，简单配置一下

{% for i in posts.paginator.pager_num_range %}
    {% if i == posts.number %}
        <a style="font-size: 30px">{{ i }}</a>
    {% else %}
        <a href="/index1.html?p={{ i }}">{{ i }}</a>
    {% endif %}
{% endfor %}

二、切换页码时保留搜索条件

切换页码保留搜索条件，需要先获取请求url中的所有参数，然后在操作上一页、下一页、点击页码时只需修改url参数中对应的页码，将修改后的url参数设置给page类对象的属性 传给前端即可。

from django.core.paginator import Paginator

def index3(request):
    paginator = Paginator(USER_LIST, 10)
    data = request.GET
    current_page = data.get('p')
    posts = paginator.page(current_page)

    """修改页码支持保留搜索条件"""
    import copy
    data = copy.deepcopy(data)

    # 总页数
    all_num, b = divmod(len(USER_LIST), 10)
    if b != 0:
        all_num += 1

    # 传入的页码值有误
    try:
        current_page = int(current_page)
    except Exception as e:
        current_page = 1

    # 传入的页码值大于总页数
    if current_page >= all_num:
        current_page = all_num

    # 上一页
    data['p'] = current_page - 1
    posts.previous_page = "%s" % data.urlencode()

    # 下一页
    data['p'] = current_page + 1
    posts.next_page = "%s" % data.urlencode()

    # 页面显示的页码
    # 每一页需要分别保存url参数和页码值
    posts.num_li = []
    for i in range(1,all_num+1):
        data['p'] = i
        #                      url参数                页码值
        posts.num_li.append({"data":data.urlencode(),"p":i})

    return render(request, 'index3.html',{"posts":posts})

然后在模板中分别通过page对象的对应属性 获取对应的url参数拼接到url中即可

    {% if posts.has_previous %}
    <a href="/index3.html?{{ posts.previous_page }}">上一页</a>
    {% else %}
    <a>上一页</a>
    {% endif %}

    {% for i in posts.num_li %}
        {% if i.p == posts.number %}
            <a style="font-size: 30px" href="/index3.html?{{ i.data }}">{{ i.p }}</a>
        {% else %}
            <a href="/index3.html?{{ i.data }}">{{ i.p }}</a>
        {% endif %}
    {% endfor %}

    {% if posts.has_next %}
        <a href="/index3.html?{{ posts.next_page }}">下一页</a>
    {% else %}
    <a>下一页</a>
    {% endif %}

效果：

三、自定义分页组件

最开始说过了，django的分页模块由于django对数据库的惰性查询才可以适用，在别的框架或用途中是不能够使用的，因为它需要先将需要的所有数据从数据库中查询出来，这样肯定是不对的。

自己封装一个Paginator类，传入四个参数：所有数据的个数、当前页码值、每页显示多少条 和 页面显示的最多页码数。

封装方法有：

　　start()、end()：第几页的数据 起始切片和结束切片

　　num_pages()：总页数，用property属性将其设置属性

　　pager_num_range()：获取页面显示的页码

　　pager_str()：页面所有与页码相关的按钮html代码

思路：起始切片和结束切片没什么好说的了，总页数通过python的内置函数divmod()可以得到，页面显示的页码上面写过了，和页码相关的按钮html代码这个的用意是 模板中只需要写上创建的paginator对象.pager_str，那么和页码相关的就都完事了。

　　   做法就是 和 切换页面保留搜索条件一样 拼接url参数。我这里直接写死了url前面部分，可以通过给方法添加一个参数来改变url前面部分，这样更通用点。

下面上代码：

class Paginator(object):

    def __init__(self, totalCount,currentPage,request,perPageItemNum=10,maxPageNum=7):
        """
        初始化
        :param totalCount: 所有数据的个数
        :param currentPage: 当前页
        :param perPageItemNum:每页显示多少条
        :param maxPageNum:页面显示的最多页码数
        """
        self.total_count = totalCount
        try:
            v = int(currentPage)
            if v <= 0:
                v = 1
            self.current_page = v
        except Exception as e:
            self.current_page = 1
        self.per_page_item_num = perPageItemNum
        self.max_page_num = maxPageNum

        # 获取url中的筛选条件:<QueryDict:{key: value}>
        params = request.GET
        import copy
        self.new_params = copy.deepcopy(params)

    def start(self):
        # 起始切片
        return (self.current_page-1)*self.per_page_item_num

    def end(self):
        # 结束切片
        return self.current_page*self.per_page_item_num

    @property
    def num_pages(self):
        """总页数"""
        a, b = divmod(self.total_count, self.per_page_item_num)
        if b != 0:
            a += 1
        return a

    def pager_num_range(self):
        # 页码最多显示的页码数的一半
        part = self.max_page_num // 2
        # 总页数小于最多显示的页码数
        if self.num_pages < self.max_page_num:
            return range(1, self.num_pages+1)
        # 当前页小于最多显示页码数的一半
        elif self.current_page <= part:
            return range(1, self.max_page_num+1)
        # 当前页在最后的几页（从最多显示页码的一半往后几页）
        elif self.num_pages - self.current_page <= part:
            return range(self.num_pages-self.max_page_num+1,self.num_pages+1)
        # 其余情况
        else:
            if self.max_page_num % 2 == 0:
                return range(self.current_page-part+1, self.current_page+part+1)
            else:
                return range(self.current_page-part, self.current_page+part+1)

    def page_str(self):
        page_list = []

        # 首页
        self.new_params['p'] = 1
        first = '<li><a href="/index2.html?%s">首页</a></li>' % self.new_params.urlencode()
        page_list.append(first)

        # 上一页
        if self.current_page == 1:
            prev = '<li><a>上一页</a><>/li'
        else:
            self.new_params['p'] = self.current_page-1
            prev = '<li><a href="/index2.html?%s">上一页</a></li>' % (self.new_params.urlencode())
        page_list.append(prev)

        # 页面页码
        for i in self.pager_num_range():
            self.new_params['p'] = i
            if self.current_page == i:
                temp = '<li class="active"><a href="/index2.html?%s">%s</a>' % (self.new_params.urlencode(),i)
            else:
                temp = '<li><a href="/index2.html?%s">%s</a></li>' % (self.new_params.urlencode(), i)
            page_list.append(temp)

        # 下一页
        if self.current_page >= self.num_pages:
            next = '<li><a>下一页</a></li>'
        else:
            self.new_params['p'] = self.current_page+1
            next = '<li><a href="/index2.html?%s">下一页</a></li>' % (self.new_params.urlencode())
        page_list.append(next)

        # 尾页
        self.new_params['p'] = self.num_pages
        last = '<li><a href="/index2.html?%s">尾页</a></li>' % self.new_params.urlencode()
        page_list.append(last)

        return ' '.join(page_list)

然后视图中创建paginator类对象，渲染模板即可。模板中 禁止转义

def index2(request):
    from app01.pager import Paginator
    current_page = request.GET.get('p')

    obj = Paginator(666,current_page,request)

    data_list = USER_LIST[obj.start():obj.end()]

    return render(request, 'index2.html',{"data_list":data_list,"page_obj":obj})

{{ page_obj.page_str | safe }}

最后用bootstarp美观了一下，效果：