Django – 更改字段验证消息

在本文中，我们将介绍如何在Django中更改字段验证消息。字段验证消息是指在用户提交数据时，如果数据不符合字段验证规则，系统返回给用户的错误提示信息。Django默认提供了一些通用的验证消息，但有时我们需要根据特定的需求，自定义字段验证消息。

阅读更多：Django 教程

Django字段验证消息的格式

在开始之前，让我们先了解一下Django字段验证消息的格式。Django使用 ValidationError 类来表示字段验证错误。这个类有一个 message 属性，用于存储验证错误的消息。当然，验证错误可能是多个，所以 message 属性其实是一个列表。示例如下：

from django.core.exceptions import ValidationError

error_message = 'This field is required.'
errors = [ValidationError(error_message)]

print(errors[0].message)
# 输出: This field is required.

上面的代码演示了一个最简单的字段验证消息的创建和输出。

在模型中更改字段验证消息

首先，让我们看看如何在Django模型中更改字段验证消息。假设我们有一个用户模型 User，其中有一个 email 字段，我们希望在用户提交的email格式不正确时给出一个特定的错误提示消息。

from django.core.exceptions import ValidationError
from django.db import models

def validate_email(value):
    if not value.endswith('@example.com'):
        raise ValidationError('Please enter a valid email address ending with @example.com.')

class User(models.Model):
    email = models.EmailField(validators=[validate_email])

在上面的示例中，我们定义了一个名为 validate_email 的函数作为email字段的验证器。如果用户提交的email不是以 “@example.com” 结尾，则会抛出一个 ValidationError 异常，异常消息将会是我们指定的错误提示消息。

在表单中更改字段验证消息

除了在模型中更改字段验证消息之外，我们还可以在Django表单中进行更改。假设我们有一个简单的用户注册表单 UserForm，其中有一个 email 字段，我们希望在用户提交的email格式不正确时给出一个特定的错误提示消息。

from django import forms

class UserForm(forms.Form):
    email = forms.EmailField(error_messages={
        'invalid': 'Please enter a valid email address ending with @example.com.'
    })

在上面的示例中，我们使用了 error_messages 属性来更改字段验证消息。通过设置 'invalid' 错误类型的消息值，我们可以自定义字段验证错误的提示消息。

在视图函数中更改字段验证消息

有时候，我们也可以在Django视图函数中对字段验证消息进行更改。在视图函数中，我们可以通过捕获验证错误并重新定义其消息来实现自定义字段验证消息的目的。

from django.core.exceptions import ValidationError
from django.shortcuts import render
from .forms import UserForm

def user_signup(request):
    if request.method == 'POST':
        form = UserForm(request.POST)
        try:
            form.is_valid()
        except ValidationError as e:
            e.error_dict['email'][0] = 'Please enter a valid email address ending with @example.com.'
    else:
        form = UserForm()

    return render(request, 'signup.html', {'form': form})

上面的代码演示了在视图函数中更改字段验证消息的过程。当用户提交表单数据时，我们首先调用 form.is_valid() 方法进行表单验证。如果验证失败，我们捕获 ValidationError 异常，并通过更改其中的消息来自定义字段验证错误的提示消息。