使用基于类的视图处理表单

    • 初始 GET (空白或预填充表单)
    • 带有合法数据的POST(通常是带有错误的重新显示的表单)
    • 带有合法数据的POST(处理数据和通常重定向)

    自己实现这个会导致很多重复的样板代码(查看 )。为了避免这个问题,Django 提供了一组通用基于类的视图来处理表单。

    提供联系表单:

    forms.py

    可以使用 FormView 构建视图:

    views.py

    1. from myapp.forms import ContactForm
    2. from django.views.generic.edit import FormView
    3. class ContactFormView(FormView):
    4. template_name = 'contact.html'
    5. form_class = ContactForm
    6. success_url = '/thanks/'
    7. def form_valid(self, form):
    8. # This method is called when valid form data has been POSTed.
    9. # It should return an HttpResponse.
    10. form.send_email()
    11. return super().form_valid(form)

    注意:

    通用视图在模型一起工作时真的很赞。这些通用视图将自动创建 ModelForm ,只要他们能找出要使用的模型类:

    • 如果已经给出了 属性,则使用这个模型类。
    • 如果 get_object() 返回一个对象,则使用这个对象的类。
    • 如果已经给出了 ,则使用这个查询集的模型。

    模型表单视图提供一个 form_valid() 实现,来自动保存模型。如果你有特别的需求,你可以覆盖它。下面是例子。

    你甚至不需要为 或 UpdateView 提供 success_url 。如果可用,它们将在模型对象上使用 。

    如果你想使用一个自定义的 ModelForm (比如添加额外的验证),用来在视图上设置 。

    当指定一个自定义表单类时,必须也要指定模型,即使 form_class 可能是一个 。

    首先我们需要添加 get_absolute_url()Author 类:

    models.py

    然后可以使用 并友好的执行实际工作。注意这里我们如何配置通用基于类的视图。我们不用自己编写任何逻辑:

    views.py

    1. from django.urls import reverse_lazy
    2. from myapp.models import Author
    3. model = Author
    4. fields = ['name']
    5. class AuthorUpdateView(UpdateView):
    6. model = Author
    7. fields = ['name']
    8. class AuthorDeleteView(DeleteView):
    9. model = Author
    10. success_url = reverse_lazy('author-list')

    注解

    我们必须在这里使用 reverse_lazy() 来代替 reverse() ,因为在文件导入时不加载 urls 。

    fields 属性的工作方式同 中内部 Meta 类的 fields 属性一样。除非你使用其他方式定义表单类,该属性是必需的,如果属性不存在,视图将引发 ImproperlyConfigured 异常。

    如果同时指定了 和 form_class 属性,将会引发 异常。

    最后将这些新视图挂钩到URLconf中:

    注解

    这些视图继承 SingleObjectTemplateResponseMixin ,它使用 来构建基于模型的 template_name

    在这个例子里:

    • UpdateView 使用 myapp/author_form.html
    • 使用 myapp/author_confirm_delete.html

    如果你想为 CreateView 和 制作单独的模板,你可以在视图类上设置 template_name 或 。

    若要跟踪使用 CreateView 创建的用户,你可以使用自定义的 来执行此操作。首先,在模型里添加外键关系:

    models.py

    1. from django.contrib.auth.models import User
    2. from django.db import models
    3. name = models.CharField(max_length=200)
    4. created_by = models.ForeignKey(User, on_delete=models.CASCADE)
    5. # ...

    在这个视图中,确保你没有在要编辑的字段列表中包含 created_by 字段 ,并且要覆盖 form_valid() 来添加用户:

    views.py

    防止那些未登录的用户访问表单。如果忽略,那么你将需要在 form_valid() 里处理未授权的用户。

    下面是一个展示了如何实现基于API的工作流以及普通POST表单一起使用的表单:

    1. from django.http import JsonResponse
    2. from django.views.generic.edit import CreateView
    3. from myapp.models import Author
    4. class JsonableResponseMixin:
    5. """
    6. Mixin to add JSON support to a form.
    7. Must be used with an object-based FormView (e.g. CreateView)
    8. """
    9. def form_invalid(self, form):
    10. response = super().form_invalid(form)
    11. if self.request.accepts('text/html'):
    12. return response
    13. else:
    14. return JsonResponse(form.errors, status=400)
    15. def form_valid(self, form):
    16. # We make sure to call the parent's form_valid() method because
    17. # it might do some processing (in the case of CreateView, it will
    18. # call form.save() for example).
    19. response = super().form_valid(form)
    20. if self.request.accepts('text/html'):
    21. return response
    22. else:
    23. data = {
    24. 'pk': self.object.pk,
    25. }
    26. return JsonResponse(data)
    27. class AuthorCreateView(JsonableResponseMixin, CreateView):
    28. fields = ['name']