博客

详解Django的 form_invalid_message() 函数：返回表单验证失败后的消息

  • Post category:Python

form_invalid_message()函数是Django form类中的一个方法，用于提供在表单验证失败时，显示给用户的错误信息。通过该函数，我们可以定制化和个性化地设置错误信息，以方便用户更好地理解错误原因和解决方法。

下面是使用方法的攻略：

一、作用

在使用Django框架时，我们经常需要对表单进行验证，以保证用户提交的信息符合要求。但当用户提交的信息不符合要求，我们需要及时地向其提示错误信息，以便用户能够及时修改并重新提交。此时，form_invalid_message()函数派上用场，它可以将错误信息显示在页面上，方便用户查看。

二、使用方法

form_invalid_message()函数的使用方法如下：

1.在你的Django form类中，覆盖form_invalid_message()方法，并返回一个字符串，表示表单验证失败时，需要向用户显示的错误信息。

2.在你的Django view函数中，根据用户提交的表单数据，实例化该 form，然后调用form.is_valid()方法，验证表单数据是否符合要求。如果验证失败，则调用form_invalid_message()方法，生成需要向用户显示的错误信息。最后，将错误信息渲染到页面上，供用户查看。

下面是一个简单的使用示例，假设我们有一个注册页面，用户需要提供用户名、电子邮件地址和密码。当用户提交的表单数据不符合要求时，我们需要向用户显示相应的错误信息。

#forms.py

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

class SignupForm(UserCreationForm):
  email = forms.EmailField(max_length=254, required=True, help_text='Required. Enter a valid email address.')

  def form_invalid_message(self):
    return "Please correct the errors below and try again."

在这个例子中，我们自定义了 SignupForm 类，并覆盖了 form_invalid_message() 方法。当表单验证失败时，系统会调用这个方法，生成需要向用户显示的错误信息。在这个例子里，我们只是简单地返回了一个常量字符串。

#views.py

from django.shortcuts import render
from .forms import SignupForm

def signup(request):
  if request.method == 'POST':
    form = SignupForm(request.POST)
    if form.is_valid():
      # 处理合法提交...
      return redirect('index')
    else:
      error_message = form.form_invalid_message()
  else:
    form = SignupForm()
    error_message = None

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

在这个例子中，我们定义了 signup 视图函数，用于处理用户在注册页面中提交的表单数据。当用户提交表单数据后，我们先实例化 SignupForm 并调用其 is_valid() 方法进行表单验证，如果验证失败，则调用 form_invalid_message() 方法，生成错误信息并将其传递给模板页面进行显示。

三、实例说明

下面是两个实际应用中的例子：

1. 注册页面

class RegistrationForm(forms.ModelForm):
    username = forms.CharField(label='用户名', max_length=30)
    email = forms.EmailField(label='电子邮件')
    password1 = forms.CharField(label='密码', widget=forms.PasswordInput)
    password2 = forms.CharField(label='确认密码', widget=forms.PasswordInput)

    def clean_username(self):
        username = self.cleaned_data['username']
        if not re.search(r'^\w+$', username):
            raise forms.ValidationError("用户名中只能包含字母、数字或下划线")
        try:
            User.objects.get(username=username)
        except User.DoesNotExist:
            return username
        raise forms.ValidationError("用户名已存在")

    def clean(self):
        cleaned_data = self.cleaned_data
        if 'password1' in cleaned_data and 'password2' in cleaned_data:
            if cleaned_data['password1'] != cleaned_data['password2']:
                raise forms.ValidationError("两次输入的密码不一致")
        return cleaned_data

    def form_invalid_message(self):
        return "请检查错误并重试"


class RegistrationView(FormView):
    template_name = 'registration_form.html'
    form_class = RegistrationForm
    success_url = '/account/register/'

    def form_valid(self, form):
        username = form.cleaned_data['username']
        email = form.cleaned_data['email']
        password = form.cleaned_data['password1']
        user = User.objects.create_user(
            username=username,
            email=email,
            password=password,
        )
        return super(RegistrationView, self).form_valid(form)

在以上例子中，我们使用 form_invalid_message() 函数定义了表单验证失败时要返回的信息。当用户提交的表单数据不符合要求，会自动调用该函数，在页面上显示相应的错误信息。

2. 添加书籍页面

class AddBookForm(forms.ModelForm):
    title = forms.CharField(max_length=100)
    authors = forms.ModelMultipleChoiceField(queryset=Author.objects.all())
    publisher = forms.ModelChoiceField(queryset=Publisher.objects.all())
    publication_date = forms.DateField(widget=forms.SelectDateWidget)

    def form_invalid_message(self):
        return "图书信息填写不完整或者输入格式错误"

    class Meta:
        model = Book
        fields = ('title', 'authors', 'publisher', 'publication_date', 'cover', 'description')


class AddBookView(LoginRequiredMixin, FormView):
    template_name = 'add_book.html'
    form_class = AddBookForm
    success_url = '/catalog/books/'

    def form_valid(self, form):
        book = Book.objects.create(
            title=form.cleaned_data['title'],
            publisher=form.cleaned_data['publisher'],
            publication_date=form.cleaned_data['publication_date'],
            cover=form.cleaned_data['cover'],
            description=form.cleaned_data['description']
        )
        book.authors.set(form.cleaned_data['authors'])
        return super(AddBookView, self).form_valid(form)

以上代码是一个图书添加页面的例子，当用户提交的表单数据验证失败时，会自动调用 form_invalid_message() 函数，在页面上显示相应的错误信息。在这个例子中，我们使用 form_invalid_message() 函数定义了表单验证失败时要返回的信息。

Tags: