{"title":"分页","version":"4.0","locale":"zh-hans","docname":"topics/pagination","url":"/zh-hans/4.0/topics/pagination/","canonical":"https://djangodocs.dev/zh-hans/4.0/topics/pagination/","summary":"Django 提供了高级和低级的方法来帮助你管理分页数据——也就是说，数据被分割在几个页面上，并带有“上一页／下一页”链接。 Paginator 类 Link to this heading # 在幕后，所有分页方法都使用： Paginator 类。它完成了将 QuerySet 拆分为 Page 对象的所有繁重工作。 例如…","html":"<h1>分页<a class=\"heading-anchor\" href=\"#pagination\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h1>\n<p>Django 提供了高级和低级的方法来帮助你管理分页数据——也就是说，数据被分割在几个页面上，并带有“上一页／下一页”链接。</p>\n<section id=\"the-paginator-class\">\n<h2><code class=\"docutils literal notranslate\">Paginator</code> 类<a class=\"heading-anchor\" href=\"#the-paginator-class\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>在幕后，所有分页方法都使用：<a class=\"reference internal\" href=\"/zh-hans/4.0/ref/paginator/#django.core.paginator.Paginator\" title=\"django.core.paginator.Paginator\"><code class=\"xref py py-class docutils literal notranslate\">Paginator</code></a> 类。它完成了将 <code class=\"docutils literal notranslate\">QuerySet</code> 拆分为 <a class=\"reference internal\" href=\"/zh-hans/4.0/ref/paginator/#django.core.paginator.Page\" title=\"django.core.paginator.Page\"><code class=\"xref py py-class docutils literal notranslate\">Page</code></a> 对象的所有繁重工作。</p>\n</section>\n<section id=\"example\">\n<h2>例如<a class=\"heading-anchor\" href=\"#example\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>给 <a class=\"reference internal\" href=\"/zh-hans/4.0/ref/paginator/#django.core.paginator.Paginator\" title=\"django.core.paginator.Paginator\"><code class=\"xref py py-class docutils literal notranslate\">Paginator</code></a> 一个对象列表，以及你希望在每个页面上拥有的项目数，它提供了访问每页项目的方法：</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"gp\">&gt;&gt;&gt; </span><span class=\"kn\">from</span> <span class=\"nn\">django.core.paginator</span> <span class=\"kn\">import</span> Paginator\n<span class=\"gp\">&gt;&gt;&gt; </span>objects <span class=\"o\">=</span> <span class=\"p\">[</span><span class=\"s1\">&#39;john&#39;</span><span class=\"p\">,</span> <span class=\"s1\">&#39;paul&#39;</span><span class=\"p\">,</span> <span class=\"s1\">&#39;george&#39;</span><span class=\"p\">,</span> <span class=\"s1\">&#39;ringo&#39;</span><span class=\"p\">]</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>p <span class=\"o\">=</span> Paginator<span class=\"p\">(</span>objects<span class=\"p\">,</span> <span class=\"mi\">2</span><span class=\"p\">)</span>\n\n<span class=\"gp\">&gt;&gt;&gt; </span>p<span class=\"o\">.</span>count\n<span class=\"go\">4</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>p<span class=\"o\">.</span>num_pages\n<span class=\"go\">2</span>\n<span class=\"gp\">&gt;&gt;&gt; </span><span class=\"nb\">type</span><span class=\"p\">(</span>p<span class=\"o\">.</span>page_range<span class=\"p\">)</span>\n<span class=\"go\">&lt;class &#39;range_iterator&#39;&gt;</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>p<span class=\"o\">.</span>page_range\n<span class=\"go\">range(1, 3)</span>\n\n<span class=\"gp\">&gt;&gt;&gt; </span>page1 <span class=\"o\">=</span> p<span class=\"o\">.</span>page<span class=\"p\">(</span><span class=\"mi\">1</span><span class=\"p\">)</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>page1\n<span class=\"go\">&lt;Page 1 of 2&gt;</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>page1<span class=\"o\">.</span>object_list\n<span class=\"go\">[&#39;john&#39;, &#39;paul&#39;]</span>\n\n<span class=\"gp\">&gt;&gt;&gt; </span>page2 <span class=\"o\">=</span> p<span class=\"o\">.</span>page<span class=\"p\">(</span><span class=\"mi\">2</span><span class=\"p\">)</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>page2<span class=\"o\">.</span>object_list\n<span class=\"go\">[&#39;george&#39;, &#39;ringo&#39;]</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>page2<span class=\"o\">.</span>has_next<span class=\"p\">()</span>\n<span class=\"go\">False</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>page2<span class=\"o\">.</span>has_previous<span class=\"p\">()</span>\n<span class=\"go\">True</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>page2<span class=\"o\">.</span>has_other_pages<span class=\"p\">()</span>\n<span class=\"go\">True</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>page2<span class=\"o\">.</span>next_page_number<span class=\"p\">()</span>\n<span class=\"gt\">Traceback (most recent call last):</span>\n<span class=\"c\">...</span>\n<span class=\"gr\">EmptyPage</span>: That page contains no results\n<span class=\"gp\">&gt;&gt;&gt; </span>page2<span class=\"o\">.</span>previous_page_number<span class=\"p\">()</span>\n<span class=\"go\">1</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>page2<span class=\"o\">.</span>start_index<span class=\"p\">()</span> <span class=\"c1\"># The 1-based index of the first item on this page</span>\n<span class=\"go\">3</span>\n<span class=\"gp\">&gt;&gt;&gt; </span>page2<span class=\"o\">.</span>end_index<span class=\"p\">()</span> <span class=\"c1\"># The 1-based index of the last item on this page</span>\n<span class=\"go\">4</span>\n\n<span class=\"gp\">&gt;&gt;&gt; </span>p<span class=\"o\">.</span>page<span class=\"p\">(</span><span class=\"mi\">0</span><span class=\"p\">)</span>\n<span class=\"gt\">Traceback (most recent call last):</span>\n<span class=\"c\">...</span>\n<span class=\"gr\">EmptyPage</span>: That page number is less than 1\n<span class=\"gp\">&gt;&gt;&gt; </span>p<span class=\"o\">.</span>page<span class=\"p\">(</span><span class=\"mi\">3</span><span class=\"p\">)</span>\n<span class=\"gt\">Traceback (most recent call last):</span>\n<span class=\"c\">...</span>\n<span class=\"gr\">EmptyPage</span>: That page contains no results\n</code></pre></div>\n<aside class=\"admonition admonition-note\" role=\"note\">\n<p class=\"admonition-title\">Note</p>\n<p>请注意，你可以给 <code class=\"docutils literal notranslate\">Paginator</code> 一个列表／元组，一个 Django 的 <code class=\"docutils literal notranslate\">QuerySet</code>，或者任何其它具有 <code class=\"docutils literal notranslate\">count()</code> 或 <code class=\"docutils literal notranslate\">__len__()</code> 方法的对象。在确定传递的对象中包含的对象数时，<code class=\"docutils literal notranslate\">Paginator</code> 将首先尝试调用 <code class=\"docutils literal notranslate\">count()</code>，如果传入的对象没有 <code class=\"docutils literal notranslate\">count()</code> 方法则回退到使用 <code class=\"docutils literal notranslate\">len()</code>。这允许像 Django 的 <code class=\"docutils literal notranslate\">QuerySet</code> 之类的对象在可用的情况下使用更高效的 <code class=\"docutils literal notranslate\">count()</code> 方法。</p>\n</aside>\n</section>\n<section id=\"paginating-a-listview\">\n<span id=\"paginating-a-list-view\"></span><h2><code class=\"docutils literal notranslate\">ListView</code> 分页<a class=\"heading-anchor\" href=\"#paginating-a-listview\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p><a class=\"reference internal\" href=\"/zh-hans/4.0/ref/class-based-views/generic-display/#django.views.generic.list.ListView\" title=\"django.views.generic.list.ListView\"><code class=\"xref py py-class docutils literal notranslate\">django.views.generic.list.ListView</code></a> 提供了一种内置的方式来对显示的列表进行分页。你可以通过在你的视图类中添加：<a class=\"reference internal\" href=\"/zh-hans/4.0/ref/class-based-views/mixins-multiple-object/#django.views.generic.list.MultipleObjectMixin.paginate_by\" title=\"django.views.generic.list.MultipleObjectMixin.paginate_by\"><code class=\"xref py py-attr docutils literal notranslate\">paginate_by</code></a> 属性来实现此目的，例如：</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"kn\">from</span> <span class=\"nn\">django.views.generic</span> <span class=\"kn\">import</span> ListView\n\n<span class=\"kn\">from</span> <span class=\"nn\">myapp.models</span> <span class=\"kn\">import</span> Contact\n\n<span class=\"k\">class</span> <span class=\"nc\">ContactListView</span><span class=\"p\">(</span>ListView<span class=\"p\">):</span>\n    paginate_by <span class=\"o\">=</span> <span class=\"mi\">2</span>\n    model <span class=\"o\">=</span> Contact\n</code></pre></div>\n<p>这限制了每页的对象数量，并在 <code class=\"docutils literal notranslate\">context</code> 中添加了 <code class=\"docutils literal notranslate\">paginator</code> 和 <code class=\"docutils literal notranslate\">page_obj</code>。要允许用户在页面之间导航，请在模板中添加指向下一页和上一页的链接，如下所示：</p>\n<div class=\"code-block\" data-language=\"html+django\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Django template</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Django template code\"><code><span class=\"cp\">{%</span> <span class=\"k\">for</span> <span class=\"nv\">contact</span> <span class=\"k\">in</span> <span class=\"nv\">page_obj</span> <span class=\"cp\">%}</span>\n    <span class=\"c\">{# Each &quot;contact&quot; is a Contact model object. #}</span>\n    <span class=\"cp\">{{</span> <span class=\"nv\">contact.full_name</span><span class=\"o\">|</span><span class=\"nf\">upper</span> <span class=\"cp\">}}</span><span class=\"p\">&lt;</span><span class=\"nt\">br</span><span class=\"p\">&gt;</span>\n    ...\n<span class=\"cp\">{%</span> <span class=\"k\">endfor</span> <span class=\"cp\">%}</span>\n\n<span class=\"p\">&lt;</span><span class=\"nt\">div</span> <span class=\"na\">class</span><span class=\"o\">=</span><span class=\"s\">&quot;pagination&quot;</span><span class=\"p\">&gt;</span>\n    <span class=\"p\">&lt;</span><span class=\"nt\">span</span> <span class=\"na\">class</span><span class=\"o\">=</span><span class=\"s\">&quot;step-links&quot;</span><span class=\"p\">&gt;</span>\n        <span class=\"cp\">{%</span> <span class=\"k\">if</span> <span class=\"nv\">page_obj.has_previous</span> <span class=\"cp\">%}</span>\n            <span class=\"p\">&lt;</span><span class=\"nt\">a</span> <span class=\"na\">href</span><span class=\"o\">=</span><span class=\"s\">&quot;?page=1&quot;</span><span class=\"p\">&gt;</span><span class=\"ni\">&amp;laquo;</span> first<span class=\"p\">&lt;/</span><span class=\"nt\">a</span><span class=\"p\">&gt;</span>\n            <span class=\"p\">&lt;</span><span class=\"nt\">a</span> <span class=\"na\">href</span><span class=\"o\">=</span><span class=\"s\">&quot;?page=</span><span class=\"cp\">{{</span> <span class=\"nv\">page_obj.previous_page_number</span> <span class=\"cp\">}}</span><span class=\"s\">&quot;</span><span class=\"p\">&gt;</span>previous<span class=\"p\">&lt;/</span><span class=\"nt\">a</span><span class=\"p\">&gt;</span>\n        <span class=\"cp\">{%</span> <span class=\"k\">endif</span> <span class=\"cp\">%}</span>\n\n        <span class=\"p\">&lt;</span><span class=\"nt\">span</span> <span class=\"na\">class</span><span class=\"o\">=</span><span class=\"s\">&quot;current&quot;</span><span class=\"p\">&gt;</span>\n            Page <span class=\"cp\">{{</span> <span class=\"nv\">page_obj.number</span> <span class=\"cp\">}}</span> of <span class=\"cp\">{{</span> <span class=\"nv\">page_obj.paginator.num_pages</span> <span class=\"cp\">}}</span>.\n        <span class=\"p\">&lt;/</span><span class=\"nt\">span</span><span class=\"p\">&gt;</span>\n\n        <span class=\"cp\">{%</span> <span class=\"k\">if</span> <span class=\"nv\">page_obj.has_next</span> <span class=\"cp\">%}</span>\n            <span class=\"p\">&lt;</span><span class=\"nt\">a</span> <span class=\"na\">href</span><span class=\"o\">=</span><span class=\"s\">&quot;?page=</span><span class=\"cp\">{{</span> <span class=\"nv\">page_obj.next_page_number</span> <span class=\"cp\">}}</span><span class=\"s\">&quot;</span><span class=\"p\">&gt;</span>next<span class=\"p\">&lt;/</span><span class=\"nt\">a</span><span class=\"p\">&gt;</span>\n            <span class=\"p\">&lt;</span><span class=\"nt\">a</span> <span class=\"na\">href</span><span class=\"o\">=</span><span class=\"s\">&quot;?page=</span><span class=\"cp\">{{</span> <span class=\"nv\">page_obj.paginator.num_pages</span> <span class=\"cp\">}}</span><span class=\"s\">&quot;</span><span class=\"p\">&gt;</span>last <span class=\"ni\">&amp;raquo;</span><span class=\"p\">&lt;/</span><span class=\"nt\">a</span><span class=\"p\">&gt;</span>\n        <span class=\"cp\">{%</span> <span class=\"k\">endif</span> <span class=\"cp\">%}</span>\n    <span class=\"p\">&lt;/</span><span class=\"nt\">span</span><span class=\"p\">&gt;</span>\n<span class=\"p\">&lt;/</span><span class=\"nt\">div</span><span class=\"p\">&gt;</span>\n</code></pre></div>\n</section>\n<section id=\"using-paginator-in-a-view-function\">\n<span id=\"using-paginator-in-view\"></span><h2>在视图函数中使用 <code class=\"docutils literal notranslate\">Paginator</code><a class=\"heading-anchor\" href=\"#using-paginator-in-a-view-function\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>下面是在视图函数中使用 <a class=\"reference internal\" href=\"/zh-hans/4.0/ref/paginator/#django.core.paginator.Paginator\" title=\"django.core.paginator.Paginator\"><code class=\"xref py py-class docutils literal notranslate\">Paginator</code></a> 对查询结果集分页的例子：</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"kn\">from</span> <span class=\"nn\">django.core.paginator</span> <span class=\"kn\">import</span> Paginator\n<span class=\"kn\">from</span> <span class=\"nn\">django.shortcuts</span> <span class=\"kn\">import</span> render\n\n<span class=\"kn\">from</span> <span class=\"nn\">myapp.models</span> <span class=\"kn\">import</span> Contact\n\n<span class=\"k\">def</span> <span class=\"nf\">listing</span><span class=\"p\">(</span>request<span class=\"p\">):</span>\n    contact_list <span class=\"o\">=</span> Contact<span class=\"o\">.</span>objects<span class=\"o\">.</span>all<span class=\"p\">()</span>\n    paginator <span class=\"o\">=</span> Paginator<span class=\"p\">(</span>contact_list<span class=\"p\">,</span> <span class=\"mi\">25</span><span class=\"p\">)</span> <span class=\"c1\"># Show 25 contacts per page.</span>\n\n    page_number <span class=\"o\">=</span> request<span class=\"o\">.</span>GET<span class=\"o\">.</span>get<span class=\"p\">(</span><span class=\"s1\">&#39;page&#39;</span><span class=\"p\">)</span>\n    page_obj <span class=\"o\">=</span> paginator<span class=\"o\">.</span>get_page<span class=\"p\">(</span>page_number<span class=\"p\">)</span>\n    <span class=\"k\">return</span> render<span class=\"p\">(</span>request<span class=\"p\">,</span> <span class=\"s1\">&#39;list.html&#39;</span><span class=\"p\">,</span> <span class=\"p\">{</span><span class=\"s1\">&#39;page_obj&#39;</span><span class=\"p\">:</span> page_obj<span class=\"p\">})</span>\n</code></pre></div>\n<p>在模板 <code class=\"file docutils literal notranslate\">list.html</code> 中，你可以像上面 <code class=\"docutils literal notranslate\">ListView</code> 的模板一样，在页面之间加入导航。</p>\n</section>","rootId":"pagination","toc":[{"title":"Paginator 类","anchor":"the-paginator-class","children":[]},{"title":"例如","anchor":"example","children":[]},{"title":"ListView 分页","anchor":"paginating-a-listview","children":[]},{"title":"在视图函数中使用 Paginator","anchor":"using-paginator-in-a-view-function","children":[]}],"breadcrumbs":[{"docname":"topics/index","title":"使用 Django","url":"/zh-hans/4.0/topics/"}],"prev":{"docname":"topics/logging","title":"日志","url":"/zh-hans/4.0/topics/logging/"},"next":{"docname":"topics/security","title":"Django 的安全性","url":"/zh-hans/4.0/topics/security/"},"formats":{"html":"/zh-hans/4.0/topics/pagination/","markdown":"/zh-hans/4.0/topics/pagination.md","json":"/zh-hans/4.0/topics/pagination.json"},"source":"https://github.com/django/django/blob/stable/4.0.x/docs/topics/pagination.txt","official":"https://docs.djangoproject.com/zh-hans/4.0/topics/pagination/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0"],"inLocales":["en","zh-hans","fr","ja","id","it","pt-br","ko","es","el","pl"]}