Django是一款性能出色的Web框架，其优雅的设计使得我们编写Web应用程序变得轻而易举。在Django框架中，表单验证是非常重要的一部分，表单验证可以保证我们从用户那里获取的数据是合法可用的，不会产生任何潜在的安全问题。在这篇文章中，我们要介绍Django表单验证的一个重要函数——def clean()，通过这个函数，我们可以有效地对表单中的数据进行验证操作。
1. 什么是def clean()函数
在Django框架中，表单验证是通过form表单类中的clean()函数来实现的。clean()函数是一个表单验证的核心函数，当我们在表单中定义了这个函数之后，Django会自动调用这个函数来验证表单数据。该函数的主要功能是验证表单中接收到的数据是否有效。在本节中，我们将详细介绍def clean()函数的基本语法和工作原理。
1.1 函数基本语法
class MyForm(forms.Form):
#定义表单字段
my_field = forms.CharField(max_length=100)
def clean_my_field(self):
#验证函数实现
data = self.cleaned_data['my_field']
if 'bad' in data:
raise ValidationError("不能包含'bad'关键字")
return data
在上面的示例代码中，我们定义了一个表单类MyForm，该表单类包含一个名为my_field的CharField字段。clean_my_field是一个实例函数，它用于验证my_field的数据内容。该验证函数提供了一个cleaned_data字典，即表单类的已验证数据。在这个函数内部，我们可以对数据进行任何自定义的验证操作，如果验证失败，可以抛出ValidationError异常。如果数据验证成功，则将数据返回到cleaned_data中。
1.2 函数工作原理
Django在处理表单数据时，会首先执行自动验证操作，即将表单数据转换为Python对象或字符串类型，然后再执行手动验证操作，即执行表单类中定义的验证函数。在手动验证操作中，Django会遍历表单类中定义的全部验证函数，并将每个函数名处理成“clean_字段名”的格式，然后执行这些函数的验证操作。例如，如果表单类中定义了一个名为“my_field”的字段，那么Django会尝试执行名为“clean_my_field”的验证函数，如果这个函数存在，则会将my_field的数据作为参数传递给这个验证函数，然后执行相应的验证操作。
2. clean()函数的使用
现在，我们已经初步了解了clean()函数的基本语法和工作原理。在本节中，我们将详细说明如何使用clean()函数来验证表单数据，并给出一些实用的示例代码，以帮助您更好地理解其使用方法。
2.1 字段级别的验证
表单验证中最基本的验证方式是字段级别的验证，即对每一个表单字段进行单独的验证操作。字段级别的验证在表单类中定义单个字段的clean_字段名的验证函数，以验证该字段的数据是否有效。
以下是一个简单的示例，演示如何对字符字段进行验证。
class ContactForm(forms.Form):
message = forms.CharField(widget=forms.Textarea)
def clean_message(self):
message = self.cleaned_data['message']
num_words = len(message.split())
if num_words < 4:
raise forms.ValidationError("你需要输入至少4个单词！")
return message
在上面的示例代码中，我们定义了包含一个message字段的表单类ContactForm。为了验证该字段的有效性，我们定义了一个名为clean_message的验证函数。在该函数中，我们对‘message’数据进行了自定义的验证，如果数据不符合要求，这个验证函数会抛出ValidationError异常。这个例子中的自定义验证条件是要求 message 字段中至少包含 4 个单词。如果验证通过，则返回变量 message 并将其添加到 cleaned_data 字典中。
2.2 整体表单验证
如果需要更全面的表单验证，可以在表单类中定义一个通用的clean()验证函数。clean()函数并不和任何特定的表单字段关联，因此它可以对整个表单进行全面的验证。
下面是一个例子，演示如何在clean()函数中对多个表单字段进行联合验证。这个示例演示了如何验证两个密码字段是否一致。
class PasswordChangeForm(forms.Form):
current_password = forms.CharField(widget=forms.PasswordInput())
new_password = forms.CharField(widget=forms.PasswordInput())
new_password_again = forms.CharField(widget=forms.PasswordInput())
def clean(self):
cleaned_data = self.cleaned_data
password = cleaned_data.get('new_password')
password_again = cleaned_data.get('new_password_again')
if password and password_again and password != password_again:
raise forms.ValidationError("两次输入的密码不匹配！")
return cleaned_data
在上面的示例代码中，我们定义了一个表单类PasswordChangeForm，包含3个字段:current_password、new_password和new_password_again。为了验证这些字段，我们定义了一个通用的clean()函数。在其中，我们从cleaned_data字典中获取密码字段的数据，并比较密码是否一致。如果密码不一致，该函数将抛出ValidationError异常。否则，将数据添加到 cleaned_data 字典中，以实现整体表单验证。
3. 实际应用
在上面的两个示例中，我们演示了如何使用clean()函数来验证表单数据。在实际应用中，这个函数可以用于各种验证操作，如数据格式、字段匹配、安全性等方面。以下是一些实际应用场景，这些场景演示了如何正确使用clean()函数。
3.1 数据格式验证
在表单中接收到数据时，我们通常需要对数据格式进行一些验证。例如，如果一个字段是数字类型，我们需要确保输入的是数字而不是文本；又如，如果一个字段是电子邮件类型，我们需要确保输入的文本是一个有效的电子邮件地址。这个时候clean()函数就能派上用场。
以下是一个演示如何验证电子邮件格式的表单。在这个表单中，验证函数会检查email字段中输入的文本是否符合电子邮件格式。
class ContactForm(forms.Form):
subject = forms.CharField(max_length=100)
message = forms.CharField(widget=forms.Textarea)
sender = forms.EmailField()
cc_myself = forms.BooleanField(required=False)
def clean_sender(self):
sender = self.cleaned_data['sender']
if not re.match("^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$", sender):
raise forms.ValidationError("您输入的电子邮件格式错误，请重新输入！")
return sender
在上面的示例代码中，我们定义了一个包含电子邮件字段的表单类ContactForm。为了验证电子邮件的格式，我们定义了一个名为clean_sender的验证函数，并且用正则表达式来匹配输入的电子邮件地址。如果验证失败，这个函数将抛出ValidationError异常。
3.2 字段匹配验证
在一些情况下，我们需要确保两个或多个字段的数据一致。例如，在注册表单中，我们需要确保密码和确认密码输入的文本相同。这个时候，我们可以使用在第二个示例中定义的整体表单验证。
以下是一个演示如何验证密码匹配的表单。在这个表单中，我们会检查new_password和new_password_again两个字段输入的文本是否一致。
class PasswordChangeForm(forms.Form):
current_password = forms.CharField(widget=forms.PasswordInput())
new_password = forms.CharField(widget=forms.PasswordInput())
new_password_again = forms.CharField(widget=forms.PasswordInput())
def clean(self):
cleaned_data = self.cleaned_data
password = cleaned_data.get('new_password')
password_again = cleaned_data.get('new_password_again')
if password and password_again and password != password_again:
raise forms.ValidationError("两次输入的密码不匹配，请重新输入！")
return cleaned_data
在上面的示例代码中，我们定义了一个包含两个密码字段的表单类PasswordChangeForm。为了验证这两个字段的匹配情况，我们在clean()函数中比较它们的输入文本。如果密码不匹配，这个函数会抛出ValidationError异常。
3.3 安全性验证
另一个常见的用途是表单验证提高Web应用程序的安全性，防止请求伪造或其他安全问题。在这种情况下，我们将在验证函数中添加一些自定义的安全性验证，以避免不必要的安全漏洞。
以下是一个演示如何增加防止跨站点请求伪造（CSRF）攻击的表单。在这个表单中，我们使用{% csrf_token %}标签生成CSRF令牌，并在clean()函数中检查请求中是否包含正确的CSRF令牌。
class MyForm(forms.Form):
my_field = forms.CharField()
csrfmiddlewaretoken = forms.CharField(widget=forms.HiddenInput())
def clean(self):
cleaned_data = super(MyForm, self).clean()
csrfmiddlewaretoken = cleaned_data.get("csrfmiddlewaretoken")
request_csrfmiddlewaretoken = self.request.POST.get("csrfmiddlewaretoken")
if not request_csrfmiddlewaretoken or request_csrfmiddlewaretoken != csrfmiddlewaretoken:
raise forms.ValidationError("CSRF令牌验证失败！")
return cleaned_data
在上面的示例代码中，我们定义了一个表单类MyForm，包括一个名为my_field的CharField字段和一个名为csrfmiddlewaretoken的隐式的hidden字段。我们使用{% csrf_token %}标签生成CSRF令牌，并将令牌添加到请求中以进行验证。然后，在表单的clean()函数中，我们检查请求中是否包含正确的CSRF令牌。如果CSRF令牌验证失败，这个函数会抛出ValidationError异常。
4. 总结
在这篇文章中，我们详细介绍了Django表单验证的一个重要函数——def clean()。我们从函数基本语法和工作原理入手，详细解释了如何使用这个函数来验证表单数据。在实际应用中，我们可以使用clean()函数来对各种验证操作进行自定义，如数据格式、字段匹配、安全性等方面。
此外，我们还介绍了一些实际应用的场景，并给出了相应的代码示例。通过这些实例，我们可以更加清晰地了解clean()函数的使用方法，以及如何在实际应用中优雅地处理表单验证。相信这些知识能够帮助您更好地理解Django表单验证和clean()函数的作用。