Django分页器（Paginator）详解

1. 基本介绍

Django的Paginator是一个强大的分页工具，广泛应用于数据展示、列表分割等场景。通过Paginator，可以轻松实现分页功能，将数据源切割为多个页面，每页显示指定数量的数据。Paginator的核心功能由Paginator类和Page类组成，本文将详细讲解其使用方法和原理。

2. 核心类与参数

2.1 Paginator类

Paginator类是分页的核心，主要参数如下：

object_list (必选)：可以是列表、元组、QuerySet或其他支持count()或__len__()方法的可切片对象。

per_page (必选)：每页显示的最大条目数。

orphans (可选，默认为0)：最后一页可能包含少于per_page条目，不影响总页数。

allow_empty_first_page (可选，默认为True)：允许第一页为空。

2.2 Page类

Page类表示单个分页结果，通常由Paginator生成。其主要属性和方法如下：

object_list：当前页面的数据列表。

number：当前页码（从1开始）。

paginator：关联的Paginator对象。

Page类还提供了多种判断方法，例如has_next(), has_previous(), has_other_pages()等，用于判断页面导航。

3. 常用方法与异常

3.1 常用方法

get_page()：获取指定页码的页面对象，处理无效页码异常。

page()：生成指定页码的页面对象。

3.2 异常处理

Paginator在处理无效页码时会抛出以下异常：

InvalidPage：基类异常，表示无效页码。

PageNotAnInteger：页码不是整数。

EmptyPage：指定页码不存在数据。

4. 实战应用

4.1 代码示例

@require_GET
@login_required
def AudioProject(request):
    page_num = request.form.cleaned_data['page']
    search_projname = request.form.get('projname')
    start_time, end_time = None, None
    if date_range:
        start_time, end_time = request.form.get('range')
        start_time = datetime.strptime(start_time, "%Y-%m-%d %H:%M")
        end_time = datetime.strptime(end_time, "%Y-%m-%d %H:%M")
    page = models.get_projects_by_page(page=page_num, projname=search_projname, 
                                         start_time=start_time, end_time=end_time)
    return page

4.2 分页处理逻辑

def get_projects_by_page(page=1, size=settings.PAGE_SIZE, **kwargs):
    for k, v in kwargs.items():
        if v is None:
            kwargs.pop(k)
    project_paginator = Paginator(get_search_projects(**kwargs), size)
    project_page = get_page(project_paginator, page)
    return project_page

4.3 统一分页管理

def get_page(paginator, page):
    try:
        page_datas = paginator.page(page)
    except PageNotAnInteger:
        page_datas = paginator.page(1)
    except EmptyPage:
        page_datas = paginator.page(paginator.num_pages)
    return page_datas

5. 模板渲染

{% macro show_page(errors, page) %}
    {% if not errors %}
        
   
    
            {% if page.paginator.page_range|length > 10 %}
                {% if page.has_previous() %}
                    
    
                {% endif %}
                {% for page_idx in page.paginator.page_range[((0, page.number-5)|sort)[-1]:page.number+4] %}
                    
    
                {% endfor %}
                
    
                
    
                {% if page.has_next() %}
                    
    
                {% endif %}
            {% else %}
                {% if page.has_previous() %}
                    
    
                {% endif %}
                {% for page_idx in page.paginator.page_range %}
                    
    
                {% endfor %}
                {% if page.has_next() %}
                    
    
                {% endif %}
            {% endif %}
        
   
    {% endif %}
{% endmacro %}

6. JavaScript代码

7. 总结

Django的Paginator分页器通过Paginator和Page类实现高效的分页功能，支持多种参数配置和异常处理。结合模板渲染和JavaScript交互，能够实现灵活的分页应用。本文详细讲解了Paginator的使用方法和实战案例，供开发者参考和使用。

转载地址：http://gylfk.baihongyu.com/

你可能感兴趣的文章