get_error_message()是Django Form中常用的一个函数，其作用是获取表单验证错误信息。当表单提交后，若出现了表单验证错误，则可以使用get_error_message()函数获取表单验证错误信息，并将其展示给用户。在表单验证失败时，可以将错误信息展示给用户，让用户知道哪些部分填写了错误或未填写，这是一个非常重要的优化用户体验的步骤。
下面是get_error_message()函数使用的步骤和示例：
Step 1：导入该函数
在Django的Form中，可以通过如下方式导入该函数：
from django.forms.utils import ErrorList
Step 2：获取表单验证错误信息
使用get_error_message()函数可以轻松地获取表单验证失败时的详细错误信息。该函数通常需要在表单类内部的is_valid()方法中使用。比如：
def is_valid(self):
valid = super().is_valid()
if valid:
# 如果表单验证通过，则返回True
return True
# 如果表单验证不通过，则获取错误信息并返回False
errors = self.errors.get_json_data()
self.error_message = [error[0]["message"] for field, error in errors.items()]
return False
在上述示例中，get_error_message()函数被用来获取表单的所有验证错误信息，然后将其保存到实例变量self.error_message中，以便在提交表单后将错误信息展示给用户。
Step 3：使用错误信息展示给用户
Django通常将表单验证错误信息保存在Form.errors变量中，可以使用Form.errors方法获得所有的错误信息。例如：
{% if form.errors %}
{% for field, errors in form.errors.items %}
{% for error in errors %}
<div class="alert alert-danger">{{ error }}</div>
{% endfor %}
{% endfor %}
{% endif %}
上述代码会检查表单是否有任何验证错误并且将它们展示给用户。
现在让我们看两个实例，详细了解该函数的使用方法：
实例1：
在一个注册页面中，用户需要填写用户名、密码和确认密码等内容。在form表单提交后，需要使用get_error_message()函数获取验证错误信息。如果用户未填写用户名，则需要弹出错误提示信息：username不能为空。
from django.core.validators import MinLengthValidator, ValidationError
from django.forms import Form, CharField
class SignupForm(Form):
username = CharField(validators=[MinLengthValidator(3)], required=True)
password = CharField(label="Password", widget=forms.PasswordInput)
confirm_password = CharField(label="Confirm Password", widget=forms.PasswordInput)
def save(self):
# 保存用户的逻辑
...
def is_valid(self):
valid = super().is_valid()
if not self.cleaned_data.get("username"):
error_msg = {}
error_msg['username'] = ErrorList(['username不能为空'])
self.errors.update(error_msg)
return False
if self.cleaned_data.get("password") != self.cleaned_data.get("confirm_password"):
error_msg = {}
error_msg['confirm_password'] = ErrorList(['两次输入的密码不一致'])
self.errors.update(error_msg)
return False
if valid:
self.save()
return valid
在上述代码中，如果验证失败，则使用get_error_message()函数获取表单验证错误信息，并将其添加到Form.errors中然后返回False。同时，在get_error_message()函数中添加了“username不能为空”的错误提示。
实例2：
假设我们有一个投票表单，其中有一个选项列表，用户可以选择想要投票的选项。我们希望在每个选项边上显示一个圆点来表示用户选中的选项，但如果用户未选中选项，则需要使用get_error_message()函数获取验证错误信息，弹出错误提示信息：请选择一个选项。
from django.forms import Form, IntegerField, ChoiceField
from django.forms.utils import ErrorList
class VoteForm(Form):
option = ChoiceField(choices=VOTE_OPTIONS, required=True, error_messages={'required': '请选择一个选项'})
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.fields['option'].widget.attrs.update({'class': 'option-input', 'required': ''})
def process_vote(self):
vote = self.cleaned_data['option']
# 处理投票的逻辑
...
def is_valid(self):
valid = super().is_valid()
if not self.cleaned_data.get("option"):
error_msg = {}
error_msg['option'] = ErrorList(['请选择一个选项'])
self.errors.update(error_msg)
return False
if valid:
self.process_vote()
return valid
在上述代码中，我们在选项input前加了一个required属性来确保用户必须选择一个选项，如果用户未选择，则使用get_error_message()函数获取表单验证错误信息，并将其添加到Form.errors中然后返回False。同时，在get_error_message()函数中添加了“请选择一个选项”的错误提示。
这就是get_error_message()函数的使用方法和示例，使用这个函数可以更好地进行表单验证，并更好地优化用户体验。