Django邮箱验证错误处理：表单内展示而非跳转错误页

问题场景 #

自定义User模型后，邮箱验证逻辑在输入无效邮箱时直接抛出ValidationError并跳转错误页，需求改为将错误信息显示在注册表单内，保持用户在表单页面。

现有代码 #

User模型 #

class User(AbstractUser):
    first_name = models.CharField(max_length=50, null=True)
    last_name = models.CharField(max_length=50, null=True)
    email = models.EmailField(unique=True, null=True)
    username = models.TextField(unique=True, null=True)
    bio = models.TextField(null=True)
    
    #avatar = models.ImageField(null=True, default="avatar.svg")
    USERNAME_FIELD = 'email'
    REQUIRED_FIELDS = ['username']

    def __str__(self):
        return self.email

导入代码 #

from django.core.validators import validate_email   
from django.core.exceptions import ValidationError

验证逻辑（存在问题） #

is_valid = validate_email(user.email)
try:
    if is_valid == True:
        password1 = request.POST.get('txtPassword')
        password2 = request.POST.get('txtConfPassword')
except ValidationError:
    messages.error(request, "Email address is invalid...")

当前错误页面信息 #

/register/ 路径下触发ValidationError
['请输入有效的邮箱地址。']
请求方法: POST
请求URL: http://127.0.0.1:8000/register/
Django版本: 4.2.5
异常类型: ValidationError
异常信息:
['请输入有效的邮箱地址。']
异常位置: E:\theparams\theparamsenv\Lib\site-packages\django\core\validators.py, 第210行, __call__方法中
触发视图: theparams.views.registerPage
Python可执行文件: E:\theparams\theparamsenv\Scripts\python.exe
Python版本: 3.11.4
Python路径:
['E:\theparams',
'C:\Users\Win\AppData\Local\Programs\Python\Python311\python311.zip',
'C:\Users\Win\AppData\Local\Programs\Python\Python311\DLLs',
'C:\Users\Win\AppData\Local\Programs\Python\Python311\Lib',
'C:\Users\Win\AppData\Local\Programs\Python\Python311',
'E:\theparams\theparamsenv',
'E:\theparams\theparamsenv\Lib\site-packages']
服务器时间: 2023年9月29日 周五 11:10:10 +0000

解决方案 #

1. 紧急修复验证逻辑的异常捕获 #

当前代码的核心问题是在try块外调用了validate_email，导致异常无法被捕获，直接触发全局错误页。调整代码，把验证操作放到try块内：

try:
    validate_email(user.email)
    # 验证通过才执行后续密码逻辑
    password1 = request.POST.get('txtPassword')
    password2 = request.POST.get('txtConfPassword')
except ValidationError:
    messages.error(request, "邮箱地址无效，请重新输入")
    # 重定向回注册页面，保持用户在表单页
    return redirect('register')

2. 推荐使用ModelForm处理表单验证（更规范） #

Django的ModelForm会自动继承模型字段的验证规则（包括邮箱格式验证），错误信息会直接绑定到对应表单字段，无需手动调用validate_email，是更符合Django规范的实现方式。

步骤1：创建表单类

在项目的forms.py中定义注册表单：

from django import forms
from django.contrib.auth.forms import UserCreationForm
from .models import User

class RegisterForm(UserCreationForm):
    class Meta:
        model = User
        fields = ['email', 'username', 'first_name', 'last_name', 'password1', 'password2']

步骤2：修改视图逻辑

在视图中用表单处理提交请求，验证失败时返回携带错误信息的表单到模板：

from django.shortcuts import render, redirect
from .forms import RegisterForm

def registerPage(request):
    if request.method == 'POST':
        form = RegisterForm(request.POST)
        if form.is_valid():
            form.save()
            # 注册成功后的跳转逻辑，示例为跳转到登录页
            return redirect('login')
        # 验证失败时，form自动携带错误信息，直接渲染模板即可
    else:
        form = RegisterForm()
    return render(request, 'register.html', {'form': form})

步骤3：模板中渲染表单及错误信息

在register.html中渲染表单，自动显示字段对应的错误信息：

<form method="POST">
    {% csrf_token %}
    {% for field in form %}
        <div>
            {{ field.label_tag }}
            {{ field }}
            {% if field.errors %}
                <div class="text-red-500">
                    {% for error in field.errors %}
                        {{ error }}
                    {% endfor %}
                </div>
            {% endif %}
        </div>
    {% endfor %}
    <button type="submit">注册</button>
</form>

这样处理后，当用户输入无效邮箱时，错误信息会直接显示在邮箱输入框下方，用户停留在注册表单页面，无需跳转错误页。

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