表单处理通常有三条路径:
初始GET(空白或预填充形式)
使用无效数据发布(通常重新显示有错误的表单)
使用有效数据发布(处理数据,通常重定向)
自己实现这一点通常会导致大量重复的样板代码(请参见 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 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)
笔记:
FormView继承 TemplateResponseMixin
所以 template_name
可以在这里使用。
的默认实现 form_valid()
只需重定向到 success_url
.
当使用模型时,通用视图真的很亮。这些通用视图将自动创建 ModelForm
,只要他们能找出要使用的模型类:
如果 model
属性,将使用该模型类。
如果 get_object()
返回一个对象,将使用该对象的类。
如果A queryset
如果给定,则将使用该查询集的模型。
模型窗体视图提供 form_valid()
自动保存模型的实现。如果您有任何特殊要求,您可以覆盖此项;请参见下面的示例。
你甚至不需要提供 success_url
对于 CreateView
或 UpdateView
-他们将使用 get_absolute_url()
在模型对象上(如果可用)。
如果要使用自定义 ModelForm
(例如添加额外验证),设置 form_class
根据你的看法。
备注
在指定自定义窗体类时,即使 form_class
可能是 ModelForm
.
首先我们需要补充 get_absolute_url()
对我们 Author
类:
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
和朋友一起做实际的工作。注意我们是如何在这里配置基于类的通用视图的;我们不需要自己编写任何逻辑:
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
属性的工作方式与 fields
内在的属性 Meta
课上 ModelForm
. 除非您以另一种方式定义表单类,否则属性是必需的,并且视图将引发 ImproperlyConfigured
如果不是,就例外。
如果您同时指定 fields
和 form_class
属性 ImproperlyConfigured
将引发异常。
最后,我们将这些新视图连接到URLConf中:
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
and UpdateView
use myapp/author_form.html
DeleteView
uses 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.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的工作流以及“普通”表单帖子一起工作的表单:
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"]
12月 18, 2023