基于类的视图的表单处理¶
表单处理一般有3个路径:
初始GET(空白或预填充表单)
POST带有无效数据(通常是重新显示形式,但有错误)
POST与有效数据(处理数据,通常重定向)
实现这个自己常常导致很多重复的样板代码(见 Using a form in a view)。为了帮助避免这种情况,Django提供了一个基于类的视图的集合,用于表单处理。
基本形式¶
给出一个简单的联系形式:
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
构建:
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(ContactView, self).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
。
首先,我们需要向我们的 Author
类添加 get_absolute_url()
:
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})
然后我们可以使用 CreateView
和朋友做实际工作。注意我们只是在这里配置通用的基于类的视图;我们不必自己写任何逻辑:
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()
,因为导入文件时未加载网址。
fields
属性以与 ModelForm
上的内部 Meta
类上的 fields
属性相同的方式工作。除非以另一种方式定义表单类,否则该属性是必需的,如果不是,视图将引发 ImproperlyConfigured
异常。
如果指定 fields
和 form_class
属性,则会引发 ImproperlyConfigured
异常。
最后,我们将这些新视图加入到URLconf中:
from django.conf.urls import url
from myapp.views import AuthorCreate, AuthorUpdate, AuthorDelete
urlpatterns = [
# ...
url(r'author/add/$', AuthorCreate.as_view(), name='author-add'),
url(r'author/(?P<pk>[0-9]+)/$', AuthorUpdate.as_view(), name='author-update'),
url(r'author/(?P<pk>[0-9]+)/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
执行此操作。首先,将外键关系添加到模型:
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()
以添加用户:
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(AuthorCreate, self).form_valid(form)
请注意,您需要使用 login_required()
的 decorate this view,或者处理 form_valid()
中的未授权用户。
AJAX示例¶
下面是一个简单的例子,显示如何实现一个适用于AJAX请求以及“正常”表单POST的表单:
from django.http import JsonResponse
from django.views.generic.edit import CreateView
from myapp.models import Author
class AjaxableResponseMixin(object):
"""
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(AjaxableResponseMixin, self).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(AjaxableResponseMixin, self).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']