基于类视图的表单处理

表单处理通常有 3 个路径

  • 初始 GET 请求（空表单或预填充表单）

  • 包含无效数据的 POST 请求（通常重新显示表单并显示错误）

  • 包含有效数据的 POST 请求（处理数据并通常重定向）

自己实现这些通常会导致很多重复的样板代码（参见 在视图中使用表单）。为了避免这种情况，Django 提供了一组用于表单处理的通用基于类视图。

基本表单

给定一个联系表单

forms.py
from django import forms


class ContactForm(forms.Form):
    name = forms.CharField()
    message = forms.CharField(widget=forms.Textarea)

    def send_email(self):
        # send email using the self.cleaned_data dictionary
        pass

可以使用 FormView 构建视图

views.py
from myapp.forms import ContactForm
from django.views.generic.edit import FormView


class ContactFormView(FormView):
    template_name = "contact.html"
    form_class = ContactForm
    success_url = "/thanks/"

    def form_valid(self, form):
        # This method is called when valid form data has been POSTed.
        # It should return an HttpResponse.
        form.send_email()
        return super().form_valid(form)

注意

模型表单

在处理模型时，通用视图真正发挥了作用。这些通用视图将自动创建一个 ModelForm，只要它们能够确定要使用哪个模型类。

  • 如果给出了 model 属性，则将使用该模型类。

  • 如果 get_object() 返回一个对象，则将使用该对象的类。

  • 如果给出了 queryset，则将使用该查询集的模型。

模型表单视图提供了一个 form_valid() 实现，该实现自动保存模型。如果有一些特殊需求，可以覆盖它；请参见下面的示例。

您甚至不需要为 CreateView 或 UpdateView 提供 success_url - 如果可用，它们将对模型对象使用 get_absolute_url()。

如果要使用自定义的 ModelForm（例如添加额外的验证），请在视图上设置 form_class。

注意

在指定自定义表单类时，即使 form_class 可能是 ModelForm，也必须指定模型。

首先，我们需要将 get_absolute_url() 添加到我们的 Author 类中

models.py
from django.db import models
from django.urls import reverse


class Author(models.Model):
    name = models.CharField(max_length=200)

    def get_absolute_url(self):
        return reverse("author-detail", kwargs={"pk": self.pk})

然后，我们可以使用 CreateView 及其相关类来完成实际工作。请注意，我们在这里只是配置通用基于类视图；我们不必自己编写任何逻辑

views.py
from django.urls import reverse_lazy
from django.views.generic.edit import CreateView, DeleteView, UpdateView
from myapp.models import Author


class AuthorCreateView(CreateView):
    model = Author
    fields = ["name"]


class AuthorUpdateView(UpdateView):
    model = Author
    fields = ["name"]


class AuthorDeleteView(DeleteView):
    model = Author
    success_url = reverse_lazy("author-list")

注意

我们必须使用 reverse_lazy() 而不是 reverse()，因为在导入文件时不会加载 URL。

fields 属性的工作方式与 ModelForm 内部 Meta 类的 fields 属性相同。除非以其他方式定义表单类，否则该属性是必需的，如果未定义，则视图将引发 ImproperlyConfigured 异常。

如果同时指定了 fields 和 form_class 属性，则将引发 ImproperlyConfigured 异常。

最后，我们将这些新视图挂接到 URLconf 中

urls.py
from django.urls import path
from myapp.views import AuthorCreateView, AuthorDeleteView, AuthorUpdateView

urlpatterns = [
    # ...
    path("author/add/", AuthorCreateView.as_view(), name="author-add"),
    path("author/<int:pk>/", AuthorUpdateView.as_view(), name="author-update"),
    path("author/<int:pk>/delete/", AuthorDeleteView.as_view(), name="author-delete"),
]

注意

这些视图继承了 SingleObjectTemplateResponseMixin，它使用 template_name_suffix 基于模型构建 template_name。

在此示例中

如果希望为 CreateView 和 UpdateView 使用单独的模板，可以在视图类上设置 template_name 或 template_name_suffix。

模型和 request.user

要跟踪使用 CreateView 创建对象的用户信息，可以使用自定义的 ModelForm 来实现。首先，在模型中添加外键关系。

models.py
from django.contrib.auth.models import User
from django.db import models


class Author(models.Model):
    name = models.CharField(max_length=200)
    created_by = models.ForeignKey(User, on_delete=models.CASCADE)

    # ...

在视图中，确保不将 created_by 包含在要编辑的字段列表中，并重写 form_valid() 以添加用户信息。

views.py
from django.contrib.auth.mixins import LoginRequiredMixin
from django.views.generic.edit import CreateView
from myapp.models import Author


class AuthorCreateView(LoginRequiredMixin, CreateView):
    model = Author
    fields = ["name"]

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

LoginRequiredMixin 可以防止未登录的用户访问表单。如果省略它，则需要在 form_valid() 中处理未授权的用户。

内容协商示例

以下是一个示例，展示了如何实现一个既可以与基于 API 的工作流一起使用，又可以与“普通”表单 POST 一起使用的表单。

from django.http import JsonResponse
from django.views.generic.edit import CreateView
from myapp.models import Author


class JsonableResponseMixin:
    """
    Mixin to add JSON support to a form.
    Must be used with an object-based FormView (e.g. CreateView)
    """

    def form_invalid(self, form):
        response = super().form_invalid(form)
        if self.request.accepts("text/html"):
            return response
        else:
            return JsonResponse(form.errors, status=400)

    def form_valid(self, form):
        # We make sure to call the parent's form_valid() method because
        # it might do some processing (in the case of CreateView, it will
        # call form.save() for example).
        response = super().form_valid(form)
        if self.request.accepts("text/html"):
            return response
        else:
            data = {
                "pk": self.object.pk,
            }
            return JsonResponse(data)


class AuthorCreateView(JsonableResponseMixin, CreateView):
    model = Author
    fields = ["name"]
内置的基于类的通用视图
在基于类的视图中使用 mixin
返回顶部