使用基于类的视图处理表单

表单处理一般有3条路径：

初始 GET（空白或预填充表格）
带有无效数据的 POST（通常会重新显示有错误的表单）
使用有效数据进行 POST（处理数据并通常重定向）

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

基本表格

给定一个联系表格：

表格.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 构建视图：

视图.py

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

class ContactView(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)

注意事项：

FormView 继承了 TemplateResponseMixin 所以这里可以使用 template_name。
form_valid() 的默认实现只是重定向到 success_url。

模型形式

使用模型时，通用视图真的很出色。这些通用视图将自动创建一个 ModelForm，只要它们能够计算出要使用的模型类：

如果给出 model 属性，则将使用该模型类。
如果 get_object() 返回一个对象，则将使用该对象的类。
如果给出了 queryset，则将使用该查询集的模型。

模型表单视图提供了一个 form_valid() 实现来自动保存模型。如果您有任何特殊要求，可以覆盖它；有关示例，请参见下文。

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

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

笔记

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

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

模型.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和朋友们来做实际的工作了。注意我们是如何在这里配置通用的基于类的视图的；我们不必自己编写任何逻辑：

视图.py

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

class AuthorCreate(CreateView):
    model = Author
    fields = ['name']

class AuthorUpdate(UpdateView):
    model = Author
    fields = ['name']

class AuthorDelete(DeleteView):
    model = Author
    success_url = reverse_lazy('author-list')

笔记

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

fields 属性与 ModelForm 上内部 Meta 类上的 fields 属性的工作方式相同。除非您以另一种方式定义表单类，否则该属性是必需的，否则视图将引发 ImproperlyConfigured 异常。

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

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

网址.py

from django.urls import path
from myapp.views import AuthorCreate, AuthorDelete, AuthorUpdate

urlpatterns = [
    # ...
    path('author/add/', AuthorCreate.as_view(), name='author-add'),
    path('author/<int:pk>/', AuthorUpdate.as_view(), name='author-update'),
    path('author/<int:pk>/delete/', AuthorDelete.as_view(), name='author-delete'),
]

笔记

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

在这个例子中：

CreateView 和 UpdateView 使用 myapp/author_form.html
DeleteView 使用 myapp/author_confirm_delete.html

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

型号和 request.user

要跟踪使用 CreateView 创建对象的用户，您可以使用自定义 ModelForm 来执行此操作。首先，将外键关系添加到模型中：

模型.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() 以添加用户：

视图.py

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

class AuthorCreate(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 AuthorCreate(JsonableResponseMixin, CreateView):
    model = Author
    fields = ['name']

使用基于类的视图处理表单 — Django 文档

目录

使用基于类的视图处理表单

基本表格

模型形式

型号和 request.user

内容协商示例