详解Django的 paginate_allow_empty_first_page() 函数：是否允许空的第一页

paginate_allow_empty_first_page()函数是Django自带的一个分页功能中的参数，用于解决分页时第一页无数据时页面报错的问题。下面详细讲解该函数的作用与使用方法。

函数作用

Django的分页功能对于大多数场景而言，处理分页数据非常优秀。但是，分页代码默认情况下存在一个问题，就是在第一页没有数据的时候，分页显示会报错。为了解决这个问题，Django提供了一个名为 paginate_allow_empty_first_page()的函数。

使用该函数，可以允许第一页为空并且不报错。它会在分页器对象的构造函数中传递一个参数，以确保分页显示不会因为第一页没有数据而中断。

使用方法

1.在分页器中使用该函数

from django.core.paginator import Paginator
from django.core.paginator import EmptyPage
from django.core.paginator import PageNotAnInteger

def listing(request):
    queryset_list = School.objects.all()
    paginator = Paginator(queryset_list, 10)  # 每页显示10条数据
    page = request.GET.get('page')  # 获取当前页码
    try:
        schools = paginator.page(page)  # 获取一页数据
    except PageNotAnInteger:
        schools = paginator.page(1)
    except EmptyPage:
        schools = paginator.page(paginator.num_pages)
    schools.paginator.paginate_allow_empty_first_page = True
    return render(request, 'schools.html', {'schools': schools})

在使用分页器创建分页对象后，要设置 paginate_allow_empty_first_page 参数为 True，表示允许第一页为空。如果不设置此值，那么在第一页没有数据的情况下会出现错误。

2.在模板中使用该函数

在模板中，我们也要进行相应的变化：

{% if schools.has_previous %}
    <li class="prev"><a href="?page={{ schools.previous_page_number }}">上一页</a></li>
{% else %}
    <li class="prev disabled"><a href="#">上一页</a></li>
{% endif %}
{% if schools.has_next %}
    <li class="next"><a href="?page={{ schools.next_page_number }}">下一页</a></li>
{% else %}
    <li class="next disabled"><a href="#">下一页</a></li>
{% endif %}

在 if 判断语句中，由于我们使用了 paginate_allow_empty_first_page 参数，所以在第一页没有数据的情况下，不会出现错误，而是默认显示为空。

案例应用

举个栗子，比如有一个博客网站，我们使用 paginate_allow_empty_first_page 函数展示博客列表。

def home(request):
    queryset_list = Blog.objects.all().order_by('-date')
    paginator = Paginator(queryset_list, 10)  # 每页显示10条数据
    page = request.GET.get('page')  # 获取当前页码
    try:
        blogs = paginator.page(page)  # 获取一页数据
    except PageNotAnInteger:
        blogs = paginator.page(1)
    except EmptyPage:
        blogs = paginator.page(paginator.num_pages)
    blogs.paginator.paginate_allow_empty_first_page = True
    return render(request, 'home.html', {'blogs': blogs})

在模板中，我们可以使用以下代码引用分页器：

<div class="pagination">
    <ul>
        {% if blogs.has_previous %}
            <li class="prev-page"><a href="?page={{blogs.previous_page_number}}">上一页</a></li>
        {% else %}
            <li class="prev-page disabled"><a href="#">上一页</a></li>
        {% endif %}

        {% for page in blogs.paginator.page_range %}
            {% if blogs.number == page %}
                <li class="active"><a href="#">{{page}}</a></li>
            {% elif page > blogs.number|add:'-3' and page < blogs.number|add:'3' %}
                <li><a href="?page={{page}}">{{page}}</a></li>
            {% endif %}
        {% endfor %}

        {% if blogs.has_next %}
            <li class="next-page"><a href="?page={{blogs.next_page_number}}">下一页</a></li>
        {% else %}
            <li class="next-page disabled"><a href="#">下一页</a></li>
        {% endif %}
    </ul>
</div>

通过以上操作，我们能够完美地解决 Django 分页器的第一页无数据报错的问题。