閱讀(7.3k) 書簽贊(0) 我要糾錯(cuò)

使用基于類的視圖進(jìn)行表單處理

2022-07-20 17:52 更新

形成基于類的意見處理

表單處理通常具有3條路徑：

初始GET（空白或預(yù)填充形式）
POST包含無效數(shù)據(jù)（通常重新顯示帶有錯(cuò)誤的表單）
使用有效數(shù)據(jù)進(jìn)行POST（處理數(shù)據(jù)并通常重定向）

自己實(shí)現(xiàn)這一點(diǎn)通常會(huì)導(dǎo)致很多重復(fù)的樣板代碼（請(qǐng)參閱在視圖中使用表單）。為了避免這種情況，Django提供了一組通用的基于類的視圖以進(jìn)行表單處理。

基本形式

給出聯(lián)系表：

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

可以使用構(gòu)造視圖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)

筆記：

FormView是繼承的， TemplateResponseMixin因此 template_name 可以在這里使用。
的默認(rèn)實(shí)現(xiàn) form_valid()只是將重定向到success_url。

模型的形式

使用模型時(shí)，通用視圖確實(shí)很出色。這些通用視圖將自動(dòng)創(chuàng)建一個(gè)ModelForm，只要它們能夠確定要使用的模型類：

如果model給定了屬性，則將使用該模型類。
如果get_object() 返回一個(gè)對(duì)象，則將使用該對(duì)象的類。
如果queryset給出a，將使用該查詢集的模型。

模型表單視圖提供了一種 form_valid()自動(dòng)保存模型的實(shí)現(xiàn)。如果有特殊要求，可以覆蓋此設(shè)置。請(qǐng)參閱下面的示例。

您甚至不需要提供success_urlfor CreateView或 UpdateView- get_absolute_url()如果可用，它們將在模型對(duì)象上使用。

如果要使用自定義ModelForm（例如添加額外的驗(yàn)證），請(qǐng)form_class在視圖上進(jìn)行設(shè)置。

注意：指定自定義表單類時(shí)，即使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和朋友一起做實(shí)際的工作。注意這里我們是如何配置通用的基于類的視圖的。我們不必自己編寫任何邏輯：

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()，因?yàn)閷?dǎo)入文件時(shí)不會(huì)加載url。

該fields屬性的工作方式與fields上內(nèi)部Meta類的屬性相同ModelForm。除非您以其他方式定義表單類，否則該屬性是必需的，否則視圖將引發(fā)ImproperlyConfigured異常。

如果同時(shí)指定fields 和form_class屬性， ImproperlyConfigured則會(huì)引發(fā)異常。

最后，我們將這些新視圖連接到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'),
]

注意：些觀點(diǎn)繼承 SingleObjectTemplateResponseMixin 它使用 template_name_suffix 了構(gòu)建 template_name 基于模型。

在此示例中：

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

如果希望為CreateView和提供單獨(dú)的模板UpdateView，則可以在視圖類上設(shè)置 template_name或 template_name_suffix。

模型和request.user

要跟蹤使用創(chuàng)建對(duì)象的用戶，CreateView可以使用自定義方法ModelForm來執(zhí)行此操作。首先，將外鍵關(guān)系添加到模型：

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.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防止未登錄的用戶訪問表單。如果您忽略了這一點(diǎn)，則需要處理中的未授權(quán)用戶form_valid()。

AJAX示例

這是一個(gè)示例，顯示了如何實(shí)現(xiàn)適用于AJAX請(qǐng)求以及“普通”表單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']