Django 类视图：精通通用视图定制

Django 的类视图 (CBVs) 提供了一种强大且可重用的方式来构建 Web 应用程序。通用视图是 CBVs 的一个子集，它们为显示列表、详情视图、创建、更新和删除对象等常见任务提供了预先构建的解决方案。尽管这些通用视图非常方便，但它们通常需要定制才能完美地适应您应用程序的特定需求。本综合指南探讨了定制 Django 通用视图的各种技术，让您能够构建高效且可维护的 Web 应用程序。

理解 Django 的类视图

在深入探讨定制之前，让我们回顾一下 CBVs 和通用视图的基础知识。传统的函数视图 (FBVs) 在单个函数中直接处理 HTTP 请求。而 CBVs 则将视图逻辑组织到类中，提供了一种更结构化和面向对象的方法。这带来了更好的代码组织、可重用性和可测试性。

通用视图是预先构建的 CBVs，旨在处理常见的 Web 开发任务。它们继承自 View 和 TemplateView 等基类，并提供专门的功能。常见的通用视图包括：

• ListView：显示对象列表。
• DetailView：显示单个对象的详细信息。
• CreateView：使用表单处理对象创建。
• UpdateView：使用表单处理对象更新。
• DeleteView：处理对象删除。

这些通用视图提供了一个坚实的基础，但实际应用程序通常需要定制它们的行为。让我们探讨各种定制技术。

定制技术

有几种方法可以定制 Django 的通用视图，从简单的属性覆盖到更复杂的重写方法。合适的技术取决于所需的定制级别。

1. 属性覆盖

最简单的定制形式是覆盖通用视图类的属性。这对于修改基本属性（如模型、模板名称或上下文对象名称）非常理想。

示例：定制 ListView

假设您想显示文章列表，但您想使用自定义模板和不同的上下文对象名称。

from django.views.generic import ListView
from .models import Article

class ArticleListView(ListView):
    model = Article
    template_name = 'articles/article_list.html'
    context_object_name = 'articles'

    def get_queryset(self):
        return Article.objects.filter(is_published=True).order_by('-publication_date')

在此示例中，我们覆盖了 model、template_name 和 context_object_name 属性。我们还覆盖了 get_queryset 方法来过滤文章并按发布日期排序。get_queryset 方法让您可以控制包含在列表视图中的对象。这对于实现过滤、排序和分页非常有用。

2. 方法重写

方法重写允许您修改通用视图类中现有方法的行为。这提供了对视图逻辑的更多控制。常见的方法重写包括：

• get_queryset()：控制视图使用的查询集。
• get_context_data()：将数据添加到模板上下文。
• form_valid()：处理成功的表单提交。
• form_invalid()：处理无效的表单提交。
• get_success_url()：确定成功提交表单后重定向到的 URL。
• get_object()：检索 DetailView、UpdateView 和 DeleteView 的对象

示例：定制 DetailView

假设您想显示文章的详细信息，但还想在模板上下文中包含相关评论。

from django.views.generic import DetailView
from .models import Article, Comment

class ArticleDetailView(DetailView):
    model = Article
    template_name = 'articles/article_detail.html'
    context_object_name = 'article'

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        context['comments'] = Comment.objects.filter(article=self.object, is_approved=True)
        return context

在这里，我们覆盖了 get_context_data() 方法，将 comments 变量添加到模板上下文中。这使您可以在 article_detail.html 模板中轻松访问和显示相关评论。

3. 使用 Mixins

Mixins 是提供特定功能的类。它们可以与通用视图结合使用，以添加功能而无需修改视图的核心逻辑。Django 提供了几个内置的 mixins，您也可以创建自己的。

示例：使用 LoginRequiredMixin

LoginRequiredMixin 确保只有登录用户才能访问特定视图。

from django.views.generic import CreateView
from django.contrib.auth.mixins import LoginRequiredMixin
from .models import Article
from .forms import ArticleForm

class ArticleCreateView(LoginRequiredMixin, CreateView):
    model = Article
    form_class = ArticleForm
    template_name = 'articles/article_form.html'
    success_url = '/articles/' # Replace with your desired success URL

    def form_valid(self, form):
        form.instance.author = self.request.user
        return super().form_valid(form)

在此示例中，我们使用 LoginRequiredMixin 限制了对 ArticleCreateView 的访问，仅允许登录用户访问。我们还覆盖了 form_valid 方法，以自动将文章的作者设置为当前用户。这演示了 mixins 如何与方法重写结合使用来实现复杂的定制。

创建自定义 Mixins

您还可以创建自己的 mixins 来封装可重用逻辑。例如，您可以创建一个 mixin，它自动将当前用户设置为模型实例的作者，或者一个处理权限检查的 mixin。

from django.contrib.auth.mixins import UserPassesTestMixin

class AuthorRequiredMixin(UserPassesTestMixin):
    def test_func(self):
        return self.request.user.is_staff or (self.request.user == self.get_object().author)

    def handle_no_permission(self):
        # Replace with your desired redirection or error handling
        return redirect('permission_denied') # Or raise an exception

这个 AuthorRequiredMixin 仅允许 staff 成员或对象的作者访问。您可以使用此 mixin 与 UpdateView 或 DeleteView 结合使用，以确保只有授权用户才能修改或删除对象。

4. 模板定制

虽然上述技术侧重于修改视图的逻辑，但模板定制对于控制数据的表示至关重要。通用视图使用模板来渲染 HTML 输出。您可以自定义这些模板以匹配您的应用程序的设计和品牌。

模板命名约定

通用视图遵循特定的模板命名约定。例如：

• ListView：<app_name>/<model_name>_list.html（例如，articles/article_list.html）
• DetailView：<app_name>/<model_name>_detail.html（例如，articles/article_detail.html）
• CreateView/UpdateView：<app_name>/<model_name>_form.html（例如，articles/article_form.html）
• DeleteView：<app_name>/<model_name>_confirm_delete.html（例如，articles/article_confirm_delete.html）

您可以在视图类中覆盖 template_name 属性以使用不同的模板。在模板中，您可以通过上下文对象访问视图提供的数据。默认的上下文对象名称通常是模型名称的小写版本（例如，对于 Article 是 article）。您可以使用 context_object_name 属性更改此设置。

示例：定制 ListView 模板

在 articles/article_list.html 模板中，您可以遍历 articles 上下文变量（如上面 ArticleListView 示例中所定义）来显示文章列表。

<h1>Articles</h1>

<ul>
  {% for article in articles %}
    <li><a href="{% url 'article_detail' article.pk %}">{{ article.title }}</a></li>
  {% endfor %}
</ul>

5. 表单定制 (CreateView & UpdateView)

CreateView 和 UpdateView 依赖于 Django 表单来处理用户输入。定制这些表单可让您控制显示的字段、它们的验证规则以及它们的样式。

使用 form_class

您可以使用视图类中的 form_class 属性指定要使用的表单类。如果您不指定表单类，Django 将根据与视图关联的模型自动生成一个 ModelForm。

重写表单方法

您可以在表单类中重写方法来定制其行为。常见的方法重写包括：

• __init__()：初始化表单并修改其字段。
• clean()：跨多个字段执行自定义验证。
• clean_<field_name>()：为特定字段执行自定义验证。

示例：定制文章表单

from django import forms
from .models import Article

class ArticleForm(forms.ModelForm):
    class Meta:
        model = Article
        fields = ['title', 'content', 'is_published']

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields['content'].widget = forms.Textarea(attrs={'rows': 5})

    def clean_title(self):
        title = self.cleaned_data['title']
        if len(title) < 5:
            raise forms.ValidationError("Title must be at least 5 characters long.")
        return title

在此示例中，我们通过在 Meta 类中设置 fields 属性来指定要包含在表单中的字段，从而定制了 ArticleForm。我们还重写了 __init__() 方法来定制 content 字段的 widget，并重写了 clean_title() 方法来为 title 字段添加自定义验证。

6. 动态表单处理

有时您需要根据用户或其他因素动态调整表单。您可以通过覆盖视图类中的 get_form_kwargs() 方法来实现这一点。此方法允许您将其他关键字参数传递给表单的构造函数。

示例：将用户传递给表单

from django.views.generic import CreateView
from .models import Article
from .forms import ArticleForm

class ArticleCreateView(CreateView):
    model = Article
    form_class = ArticleForm
    template_name = 'articles/article_form.html'
    success_url = '/articles/' # Replace with your desired success URL

    def get_form_kwargs(self):
        kwargs = super().get_form_kwargs()
        kwargs['user'] = self.request.user
        return kwargs

然后，在您的 ArticleForm 中，您可以在 __init__() 方法中通过 user 关键字参数访问用户。

from django import forms
from .models import Article

class ArticleForm(forms.ModelForm):
    class Meta:
        model = Article
        fields = ['title', 'content', 'is_published']

    def __init__(self, *args, **kwargs):
        self.user = kwargs.pop('user', None)
        super().__init__(*args, **kwargs)
        if self.user and not self.user.is_staff:
            del self.fields['is_published'] # Only staff can publish

在此示例中，我们将当前用户传递给表单，如果用户不是 staff 成员，则动态删除 is_published 字段。这演示了如何根据用户的权限动态调整表单。

高级定制：使用视图集

对于更复杂的应用程序，尤其是涉及 API 的应用程序，请考虑使用 Django REST Framework (DRF) 的视图集。视图集将相关的视图（例如，列表、创建、检索、更新、删除）合并到一个类中，提供一种更简洁、更有条理的方式来管理 API 端点。

示例：创建 ArticleViewSet

from rest_framework import viewsets
from .models import Article
from .serializers import ArticleSerializer

class ArticleViewSet(viewsets.ModelViewSet):
    queryset = Article.objects.all()
    serializer_class = ArticleSerializer

这个简单的 ArticleViewSet 为文章提供了所有标准的 CRUD（创建、读取、更新、删除）操作。您可以使用类似于通用视图的技巧来定制视图集，例如重写 get_queryset()、perform_create() 和 perform_update() 等方法。

通用视图定制的全局注意事项

当为全球受众定制通用视图时，请考虑以下因素：

• 本地化和国际化 (L10n/I18n)：确保您的模板和表单支持多种语言和区域格式。使用 Django 内置的 i18n/l10n 功能。
• 时区：正确处理时区转换，以用户本地时间显示日期和时间。使用 Django 的 timezone 模块。
• 货币格式：根据不同区域适当格式化货币值。考虑使用像 babel 这样的库进行货币格式化。
• 日期和数字格式：根据用户的语言环境使用适当的日期和数字格式。
• 可访问性：确保您的自定义视图和模板对残障用户是可访问的。遵循 WCAG 等可访问性指南。
• 响应式设计：确保您的模板是响应式的，并适应全球用户使用的不同屏幕尺寸和设备。
• 文化敏感性：在设计视图和模板时，要注意文化差异。避免使用可能冒犯某些文化的图像或语言。例如，颜色关联和符号在不同文化中可能具有非常不同的含义。

示例：处理时区

要在用户的本地时区显示发布日期，您可以在模板中使用 timezone 标签：

{% load tz %}

<p>Published on: {% timezone article.publication_date %}</p>

确保您的 Django 设置文件中 USE_TZ = True。

通用视图定制的最佳实践

遵循以下最佳实践，以确保您的定制是可维护且高效的：

• 保持简单：避免过度复杂化您的定制。使用能达到预期结果的最简单技术。
• 记录您的代码：添加注释来解释您的定制以及它们为何必要。
• 彻底测试：编写单元测试以确保您的定制正常工作。
• 明智地使用 Mixins：创建可重用的 mixins 来封装通用功能。
• 遵循 Django 的约定：遵守 Django 的编码风格和命名约定。
• 考虑安全：定制视图时，要注意潜在的安全漏洞。对用户输入进行清理，并防范跨站脚本 (XSS) 和 SQL 注入等常见攻击。

结论

Django 的基于类的通用视图提供了一种强大而灵活的方式来构建 Web 应用程序。通过掌握本指南中概述的定制技术，您可以根据您的特定需求定制通用视图，从而创建高效、可维护且全球可访问的 Web 应用程序。从简单的属性覆盖到复杂的重写方法和 mixin 使用，可能性是无限的。请记住考虑全球视角和最佳实践，以确保您的应用程序能够满足多样化的国际受众的需求。