“轻松实现数据查询，使用 Django ListView 和 DetailView，
最大化开发生产力！”

在前面的文章中我们了解了 Django 的基本视图类和 FormView，现在是时候深入通用视图(Generic Views)了。
ListView 和 DetailView 是特别针对‘数据输出’而设计的类，通过简单的设置可以快速实现列表页面和详细页面。

1. 什么是 ListView 和 DetailView？

  1. ListView

    • 提供以列表形式显示模型(Model)中的多个对象的功能。

    • 可轻松应用分页(Pagination)、排序、搜索等功能，适用于大多数“列表页面”。

  2. DetailView

    • 显示特定对象（例如：帖子、商品、用户等）的详细信息。

    • 通过 URL 参数或pk（主键）值找到该对象，并在模板中简单渲染。

这两个类是 Django 提供的通用视图的一部分，是迅速实现CRUD中“读取”功能的强大工具。

2. ListView 的基本结构和用法

ListView 处理流程图

2.1 基本示例

# views.py
from django.views.generic import ListView
from .models import Post

class PostListView(ListView):
    model = Post
    template_name = 'post_list.html'
    context_object_name = 'posts'  # 模板中使用的上下文变量名（默认值：object_list）
    # paginate_by = 10  # 每页显示的条目数（可选）

    # （可选）需要额外调整查询集时使用 get_queryset
    def get_queryset(self):
        # 例如：只显示最新的文章？
        return Post.objects.order_by('-created_at')

  • model: 指定要显示哪个模型的数据。

  • template_name: 模板文件路径（默认值：<app_name>/<model_name>_list.html）。

  • context_object_name: 模板中使用的上下文对象名（默认值：object_list）。

  • paginate_by: 可以指定每页显示的对象数量（进行分页处理）。

2.2 在 urls.py 中连接 ListView

# urls.py
from django.urls import path
from .views import PostListView

urlpatterns = [
    path('posts/', PostListView.as_view(), name='post_list'),
]

2.3 基本模板示例

<!-- post_list.html -->
<!DOCTYPE html>
<html>
<head>
    <title>文章列表</title>
</head>
<body>
    <h1>文章列表</h1>
    <ul>
        {% for post in posts %}
            <li>
                <a href="{% url 'post_detail' post.pk %}">{{ post.title }}</a>
            </li>
        {% endfor %}
    </ul>

    <!-- 实现分页时 -->
    {% if is_paginated %}
      <div>
        {% if page_obj.has_previous %}
          <a href="?page={{ page_obj.previous_page_number }}">上一页</a>
        {% endif %}
        <span>页面 {{ page_obj.number }} / {{ page_obj.paginator.num_pages }}</span>
        {% if page_obj.has_next %}
          <a href="?page={{ page_obj.next_page_number }}">下一页</a>
        {% endif %}
      </div>
    {% endif %}
</body>
</html>

关键字: “列表页面自动化”, “分页(Pagination)”, “高效数据排列”

3. DetailView 的基本结构和用法

3.1 基本示例

# views.py
from django.views.generic import DetailView
from .models import Post

class PostDetailView(DetailView):
    model = Post
    template_name = 'post_detail.html'
    context_object_name = 'post'  # 模板中使用的上下文变量名（默认值：object）

    # （可选）如果希望使用不同的标识符而不是 URL 中的 pk，可以重写 get_slug_field 等方法

  • model: 查询特定模型的单个对象。

  • template_name: 模板文件路径（默认值：<app_name>/<model_name>_detail.html）。

  • context_object_name: 模板中使用的上下文对象名称（默认值：object）。

  • URL 模式中包含 <int:pk>/ 或 <slug:slug>/ 等模式时，Django 将通过该值自动找到对应对象。

3.2 在 urls.py 中连接 DetailView

# urls.py
from django.urls import path
from .views import PostDetailView

urlpatterns = [
    path('posts/<int:pk>/', PostDetailView.as_view(), name='post_detail'),
]

3.3 基本模板示例

<!-- post_detail.html -->
<!DOCTYPE html>
<html>
<head>
    <title>{{ post.title }}</title>
</head>
<body>
    <h1>{{ post.title }}</h1>
    <p>创建日期: {{ post.created_at }}</p>
    <div>
        {{ post.content }}
    </div>
    <a href="{% url 'post_list' %}">返回列表</a>
</body>
</html>

4. 扩展 ListView & DetailView

4.1 get_queryset, get_context_data

get_queryset(): 可以按需自定义查询集。
例如：仅显示特定用户能够查看的帖子列表、根据搜索词进行过滤、根据特定字段排序等。

def get_queryset(self):
    queryset = super().get_queryset()
    return queryset.filter(is_active=True)

get_context_data(): 可以将额外的数据传递给模板。

def get_context_data(self, **kwargs):
    context = super().get_context_data(**kwargs)
    context['extra_info'] = '额外信息'
    return context

4.2 slug 和自定义查找

DetailView 可以使用 slug（短文本标识符）替代 pk，并且可以指定 slug_field 和 slug_url_kwarg 等进行自定义配置。

class PostDetailView(DetailView):
    model = Post
    slug_field = 'slug'           # 模型中的 slug 字段名
    slug_url_kwarg = 'slug'       # URL 模式中接收的参数名

4.3 与 Mixin 的组合

  • LoginRequiredMixin 或 PermissionRequiredMixin 可以配合使用，轻松控制列表和详细页面的访问权限。

  • 可以创建类似SearchMixin的自定义 Mixin，以处理搜索词（query）参数的逻辑，在多个 ListView 中重复使用此逻辑。

5. 简单的实际示例：实现论坛功能

基于之前讨论的示例模型 Post，我们将构建列表 + 详细的功能。

# models.py
class Post(models.Model):
    title = models.CharField(max_length=200)
    content = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)
    slug = models.SlugField(unique=True)  # slug 使用示例

    def __str__(self):
        return self.title

# views.py
from django.views.generic import ListView, DetailView
from .models import Post

class PostListView(ListView):
    model = Post
    template_name = 'post_list.html'
    context_object_name = 'posts'
    paginate_by = 5  # 每页 5 条

    def get_queryset(self):
        # 假设只显示状态为 active 的帖子
        return Post.objects.filter(is_active=True).order_by('-created_at')

class PostDetailView(DetailView):
    model = Post
    template_name = 'post_detail.html'
    context_object_name = 'post'
    slug_field = 'slug'
    slug_url_kwarg = 'slug'

# urls.py
urlpatterns = [
    path('posts/', PostListView.as_view(), name='post_list'),
    path('posts/<slug:slug>/', PostDetailView.as_view(), name='post_detail'),
]

  • 列表页面: 通过 /posts/?page=2 等方式更改页面号查看列表。

  • 详细页面: 使用 posts/<slug>/ 路径查找特定帖子并显示在模板中。

6. 与 FBV 比较：如何轻松实现列表/详细功能？

分类 FBV（函数基于视图） ListView/DetailView（CBV）
代码结构 分别编写列表/详细函数，分页、排序等需手动实现 仅通过属性设置，轻松自定义列表、分页、排序、搜索等功能
可读性/维护性 条件语句和循环多处混杂，项目变大时愈发复杂 列表/详细逻辑分离，扩展（方法重写）明确，容易维护
开发生产力（核心关键词） “代码重复增加，时间消耗” “节省开发时间，提高生产力”
模板数据传输 手动构建上下文字典并传递给 render 默认自动传递上下文（object_list、object），可在 get_context_data 中处理额外数据
分页、搜索等高级功能 需要编写额外的逻辑 可以使用内置的功能和属性轻松启用

FBV vs DetailView – 简化的对象查询

7. 结论与下篇文章预告

Django ListView 和 DetailView 显著简化了“数据列表”和“详细页面”的实现。
它们自动化了诸如分页、上下文数据添加、根据 URL 参数查询对象等反复使用的功能，从而在代码重用性和开发生产力上带来了巨大优势。

CBV（类基于视图）系列将继续！
在下一篇文章中，我们将研究如何轻松使用 CreateView、UpdateView 和 DeleteView 构建CRUD逻辑。

查看之前的文章

  1. 类基于视图(CBV)探究系列 #1 - FBV 从 CBV 的原因与开发者的心态

  2. 类基于视图(CBV)探究系列 #2 - 了解 Django 的基本 View 类

  3. 类基于视图(CBV)探究系列 #3 - 使用 FormView 简化表单处理

“利用 Django 的 ListView、DetailView，
实现快速数据查询、便捷开发和高生产力！”