DjangoおよびDRFで結果をページネーション(ページ分割)するにはどうしますか?

Question

Accepted Answer

**ページネーション**は大量の結果セットを個別のページに分割し、一度に何千ものレコードを読み込まないようにします。パフォーマンスと使いやすさに不可欠です。Djangoはテンプレート/ビュー用の`Paginator`クラスを提供し、DRFはAPI用の組み込みページネーションを提供しています。 ## ページネーションが解決する問題 ```python # ❌ loading everything — slow, memory-heavy, bad UX with thousands of rows articles = Article.objects.all() # could be 100,000 records ``` ## Djangoの Paginator（従来のビュー/テンプレート用） ```python from django.core.paginator import Paginator def article_list(request): articles = Article.objects.all().order_by("-created_at") # ORDER matters for consistent pages paginator = Paginator(articles, 20) # 20 items per page page_number = request.GET.get("page") # ?page=2 page_obj = paginator.get_page(page_number) # the requested page return render(request, "list.html", {"page_obj": page_obj}) ``` ```html {% for article in page_obj %}

{% endfor %} {% if page_obj.has_previous %}Prev{% endif %} Page {{ page_obj.number }} of {{ page_obj.paginator.num_pages }} {% if page_obj.has_next %}Next{% endif %} ``` `Paginator`はクエリセットをページにスライスし、`get_page()`はナビゲーションヘルパー（`has_next`、`next_page_number`など）を備えたページオブジェクトを返します。`LIMIT`/`OFFSET`をクエリに追加するため、データベースから1ページだけが取得されます。 ## DRFのページネーション（API用） ```python # global default in settings.py REST_FRAMEWORK = { "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination", "PAGE_SIZE": 20, } # now list endpoints are automatically paginated, returning: # { "count": 1000, "next": "...?page=3", "previous": "...?page=1", "results": [...] } ``` DRFは一度設定されるとリストエンドポイントを自動的にページネーションし、結果と共にページメタデータ（count、next/previousリンク）を返します。クライアントは提供されたURLを使ってナビゲートします。 ## DRFのページネーションスタイル ```text PageNumberPagination → ?page=2 (simple page numbers) LimitOffsetPagination → ?limit=20&offset=40 (flexible offsets) CursorPagination → opaque cursor; consistent & performant for large/changing data (avoids OFFSET performance issues on huge datasets) ``` ## パフォーマンスのニュアンス ```text ⚠️ OFFSET-based pagination (page/offset) gets SLOWER on deep pages of huge tables (the DB must skip OFFSET rows). For very large datasets, CURSOR pagination (keyset, using a WHERE on an indexed column) is far more efficient. ⚠️ Always ORDER BY a stable field, or pages can be inconsistent/repeat items. ``` ## なぜ重要なのかページネーションは、実際のデータ量を扱う高性能で使いやすいアプリケーションを構築するために不可欠です。ページネーションがなければ、リストエンドポイントとテーブル全体（おそらく数千あるいは数百万行）を読み込むページは遅く、メモリを消費し、使用不可能になり、データベースに負荷をかけ、ユーザーとクライアントを圧倒します。ページネーションを理解することは、日常的な実践知識です。Djangoの**Paginator**は従来のビュー/テンプレートを処理します（クエリセットをナビゲーションヘルパー付きのページにスライスし、LIMIT/OFFSETを使って効率的に1ページだけを取得します）。DRFの**組み込みページネーション**はAPIを処理します（一度設定されるとリストエンドポイントを自動的にページネーションし、メタデータとナビゲーションリンクを返します）。どちらが必要かは、サーバーレンダリングページを構築しているか、APIを構築しているかによって異なります。両方のコンテキストでページネーションを実装する方法を知ることは、ほぼすべてのデータリスト機能に必要です。 **パフォーマンスのニュアンス**は特に貴重なシニアレベルの知識です。標準的なOFFSETベースのページネーションは非常に大きなテーブルの深いページでパフォーマンスが低下します（データベースは先行するすべての行をスキップする必要があります）。そのため、**カーソル（キーセット）ページネーション**は巨大または急速に変化するデータセットに対して効率的な選択肢であり、常に**安定したフィールドで並べ替え**することが、ページ間で矛盾した結果や重複した結果を避けるために必要です。基本的なメカニクス（Paginator、DRFページネーションクラス）とこれらのパフォーマンス上の考慮事項（OFFSETとカーソルページネーション、一貫した並べ替え）の両方を理解することは、データが増えても高速で正確なアプリケーションを構築するために重要です。ページネーションはユビキタスな要件であり、特にスケール時に適切に実装することは、アプリケーションのパフォーマンスとユーザー体験に直接影響する実践的なスキルです。