表單處理通常有3種情況:
- 初始 GET(空白或預填充式)
- 使用無效數據進行POST(通常在錯誤之後重新顯示錶單)
- 使用有效數據POST(處理數據並通常重定向)
自己實現這個通常會導致很多重複的樣板代碼(請參閱在視圖中使用表單)。爲了避免這種情況,Django爲表單處理提供了一組基於類的通用視圖。
1. 基本的表單
給出一個簡單的表單:
#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)
注意:
1 . FormView繼承自 TemplateResponseMixin,所以可以在這裏使用 template_name 。
2.form_valid()的默認實現就是簡單重定向到success_url。
譯者注
html中這麼使用:
<form action="{% url 'polls:cbv_form_view' %}" method="POST" enctype="multipart/form-data">
{% csrf_token %}
{{ form.name.label }}{{ form.name }}<br>
{{ form.message.label }}{{ form.message }}<br>
<input type="submit" value="提交">
</form>
2. ModelForm
通用視圖和model一起工作很屌。這些通用視圖將自動創建一個ModelForm,只要它們可以確定要使用的模型類:
- 如果給出model屬性,則將使用該模型類。
- 如果get_object() 返回一個對象,則將使用該對象的類。
- 如果給出了一個queryset,則將使用該查詢集的模型。
ModelForm視圖中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 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:
# urls.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。
3. 模型和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)
# ...
在視圖中,確保您沒有在要fields列表中包含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)
請注意,您需要使用裝飾器 login_required() 來 裝飾此視圖,或者在form_valid()中處理未經授權的用戶 。
4. 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']