博客

详解Django的 form_invalid_json() 函数：返回表单验证失败后的 JSON 数据

  • Post category:Python

form_invalid_json 是 Django 中 FormMixin 类中定义的一个方法，用于在表单验证失败时返回 JSON 格式的错误信息。

使用方法：
1. 在视图中定义 form_invalid_json 方法，调用父类的方法返回一个包含错误信息的 JSON 数据。
2. 在前端 AJAX 请求中，在 error 函数中解析该 JSON 数据，并按需处理错误信息。

下面是一个示例：

from django.http import JsonResponse
from django.views.generic.edit import FormMixin
from django.views.generic.base import TemplateView

from .forms import MyForm

class MyView(FormMixin, TemplateView):
    template_name = 'my_template.html'
    form_class = MyForm

    def post(self, request, *args, **kwargs):
        form = self.get_form()
        if form.is_valid():
            # 处理有效表单数据
            return self.form_valid(form)
        else:
            return self.form_invalid(form)

    def form_valid(self, form):
        # 如果表单验证通过，重定向到成功页面
        return redirect('success')

    def form_invalid(self, form):
        # 如果表单验证失败，返回 JSON 格式的错误信息
        return self.form_invalid_json(form)

    def form_invalid_json(self, form):
        errors = []
        for field, messages in form.errors.items():
            errors.append({'field': field, 'messages': messages})
        return JsonResponse({'errors': errors})

在上面的示例中，如果表单验证失败，form_invalid 方法会调用 form_invalid_json 方法返回 JSON 格式的错误信息。form_invalid_json 方法将表单的错误信息转化为一个包含错误信息及其对应表单字段的字典数组，并返回 JsonResponse 对象。在前端 AJAX 请求中，可以解析该 JSON 数据并显示错误信息。

接下来，我们来看下面两个实例。

实例1

假如有一个登录页面，要求用户输入用户名和密码。当用户提交表单时，如果用户名或密码为空，后端应该返回错误信息。

在这种情况下，您可以使用 Django 的表单组件编写一个包括用户名和密码输入字段的表单。当用户提交表单时，您可以在后端使用 form_invalid_json 返回错误信息。

在这个示例中，form_invalid_json 方法会返回一个包含错误信息及其对应表单字段的 JSON 格式的字典数组。在前端 AJAX 请求中，可以解析该 JSON 数据并显示错误信息。

实例2

假设您正在为一个在线商店编写注册页面。在该页面中，用户需要填写其用户名、电子邮件、密码及确认密码等信息，以便进行注册。当用户提交表单时，如果填写的电子邮件无效，后端应该返回错误信息。

在这种情况下，您可以使用 Django 的表单组件编写一个包括用户名、电子邮件、密码及确认密码的表单。当用户提交表单时，您可以在后端使用 form_invalid_json 返回错误信息。

在这个示例中，form_invalid_json 方法将返回一个包含错误信息及其对应表单字段的 JSON 格式的字典数组。在前端 AJAX 请求中，可以解析该 JSON 数据并显示错误信息。

Tags: