Django自定义form validator无法向前端渲染验证错误如何解决？

为什么当前错误无法传到前端 #

你在form.is_valid()校验通过后直接抛出ValidationError，这个异常没有被表单实例捕获，Django会将其识别为未处理的服务器错误，仅会在后端终端和调试页面展示，不会传递给前端模板。另外抛出异常后的代码确实永远不会执行，IDE的提示是正确的。

临时修复方案（不改动表单结构，仅修改视图） #

不要直接抛出验证异常，而是使用表单的add_error()方法将错误绑定到表单实例上，再重新渲染表单即可让前端获取到错误：

# 把你原有视图中判断空格的逻辑替换成下面的代码
if ' ' in poller_choice_one or ' ' in poller_choice_two:
    # 第一个参数传字段名可以把错误绑定到对应字段，传None则为全局错误
    form.add_error('poller_choice_one', '选项请限制为单个单词')
    form.add_error('poller_choice_two', '选项请限制为单个单词')
# 验证通过再走保存逻辑
else:
    # 你原来的保存poller到数据库、重定向的代码

此时你原有的模板不用做任何修改，{{ form }}会自动渲染每个字段对应的错误信息。

自定义验证的最佳实践 #

不推荐将自定义校验逻辑放在视图的form.is_valid()之后，正确的实现位置是表单类内部，符合Django的分层设计，校验逻辑可以复用，代码更整洁。有两种常用实现方式：

1. 单字段校验（适合每个字段单独验证规则） #

在PollersForm类中定义clean_<字段名>方法，Django在执行form.is_valid()时会自动调用这类方法做校验：

from django import forms
from django.core.exceptions import ValidationError
from .models import Pollers

class PollersForm(forms.ModelForm):
    class Meta:
        model = Pollers
        fields = ['poller_nature', 'poller_text', 'poller_categories', 'poller_choice_one', 'poller_choice_two']

    def clean_poller_choice_one(self):
        data = self.cleaned_data['poller_choice_one']
        if ' ' in data:
            raise ValidationError('选项请限制为单个单词', code='invalid')
        return data

    def clean_poller_choice_two(self):
        data = self.cleaned_data['poller_choice_two']
        if ' ' in data:
            raise ValidationError('选项请限制为单个单词', code='invalid')
        return data

2. 跨字段校验（适合多个字段关联验证的场景） #

如果你的校验规则需要关联多个字段的取值，可以重写表单的clean()方法：

def clean(self):
    cleaned_data = super().clean()
    choice1 = cleaned_data.get('poller_choice_one')
    choice2 = cleaned_data.get('poller_choice_two')
    if choice1 and choice2 and (' ' in choice1 or ' ' in choice2):
        raise ValidationError('所有选项请限制为单个单词', code='invalid')
    return cleaned_data

按上述方式修改后，你可以完全删掉视图中自定义的校验逻辑，form.is_valid()会自动执行所有表单内部的校验规则，校验失败时错误会自动绑定到表单实例，前端渲染时直接展示。

内容的提问来源于stack exchange，提问作者JSRB