用基于类的视图处理表单

表单处理一般有3个路径:

  • 初始GET(空白或预填表单)
  • 无效的数据POST(通常重新显示错误的形式)
  • POST有效的数据(处理数据,通常重定向)

自己实现这一点通常会导致大量重复的样板代码(请参见Using a form in a view)。 为了避免这种情况,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 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)

笔记:

模型形式

通用视图真正发挥与模型的工作。 这些通用视图将自动创建一个ModelForm,只要他们能够计算出使用哪个模型类:

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

模型表单视图提供了一个自动保存模型的form_valid()实现。 如果您有任何特殊要求,您可以覆盖此项;看下面的例子。

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

如果您想使用自定义的ModelForm(例如添加额外的验证),只需在您的视图中设置form_class即可。

注意

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

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

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

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

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

Then we can use CreateView and friends to do the actual work. 请注意,我们只是在这里配置泛型的基于类的视图。我们不必自己写任何逻辑:

views.py
from django.views.generic.edit import CreateView, UpdateView, DeleteView
from django.urls import reverse_lazy
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异常。

如果您同时指定fieldsform_class属性,则会引发ImproperlyConfigured

最后,我们将这些新的视图挂接到URLconf中:

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

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

在这个例子中:

如果您希望为CreateViewUpdateView分别创建模板,则可以在视图上设置template_nametemplate_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.views.generic.edit import CreateView
from myapp.models import Author

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

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

Note that you’ll need to decorate this view using login_required(), or alternatively handle unauthorized users in the form_valid().

AJAX示例

下面是一个简单的例子,展示了如何实现一个适用于AJAX请求的表单以及“普通”表单POST:

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

class AjaxableResponseMixin:
    """
    Mixin to add AJAX 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.is_ajax():
            return JsonResponse(form.errors, status=400)
        else:
            return response

    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.is_ajax():
            data = {
                'pk': self.object.pk,
            }
            return JsonResponse(data)
        else:
            return response

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