Django 模型中的 clean() 方法详解：数据校验的最后防线
在 Django 的模型系统中，我们经常使用字段级别的校验器（validators）来约束某个字段的取值范围。但当校验逻辑涉及多个字段之间的关系时，字段级别校验就无能为力了。此时，clean() 方法就成为了我们进行模型层数据完整性校验的最后防线。
一、什么是 clean() 方法？
在 Django 的 models.Model 中，clean() 是一个内建方法，用于在模型实例保存之前，进行跨字段的逻辑校验。
- ✅ 它属于 模型级别的校验
- ✅ 常用于：多个字段组合判断 ，某种业务逻辑约束
- ✅ 在调用
full_clean()时会自动执行
二、什么时候执行 clean() 方法？
clean()不会自动在.save()时执行！它通常通过full_clean()触发。
触发 clean() 的常见方式有：
-
手动调用
pythoninstance.full_clean() # 会依次触发字段校验器和 clean() instance.save() -
在 Django Admin 中保存对象时
Django Admin 自动调用
full_clean()，所以clean()会生效。 -
在表单（ModelForm）中保存模型对象时
form.is_valid()会调用full_clean()，所以也会执行clean()。
三、为什么要用 clean()？
字段校验器解决的是单字段问题，clean() 可以处理以下典型场景：
| 业务场景 | 适合放在哪？ |
|---|---|
| 字段 A 和字段 B 不能同时为空 | clean() |
| type=button 时必须设置 code | clean() |
| 数量字段必须大于价格字段 | clean() |
| 文件上传字段与文件类型字段联动 | clean() |
四、代码示例：按钮权限必须设置 code
python
from django.db import models
from django.core.exceptions import ValidationError
class Permission(models.Model):
TYPE_CHOICES = (
('menu', '菜单'),
('page', '页面'),
('button', '按钮'),
)
name = models.CharField(max_length=100)
type = models.CharField(max_length=20, choices=TYPE_CHOICES)
code = models.CharField(max_length=100, null=True, blank=True)
def clean(self):
if self.type == 'button' and not self.code:
raise ValidationError('按钮类型的权限必须设置 code')
if self.type != 'button' and self.code:
raise ValidationError('非按钮类型权限不应设置 code')五、最佳实践建议
| 建议 | 原因 |
|---|---|
⚠️ 自定义模型校验请写在 clean() 而不是 save() |
save() 只管持久化，不适合做校验 |
✅ 表单/接口保存模型前，显式调用 full_clean() |
保证 clean() 能执行 |
✅ 用 ValidationError 抛出明确错误 |
可直接用于表单返回、接口响应等 |
| ✅ 在 admin 中使用，可以确保数据校验 | Django admin 默认支持 full_clean |
六、总结
| 要点 | 内容 |
|---|---|
| ✅ clean() 是什么 | 模型级别的多字段数据校验方法 |
| ✅ 何时触发 | 调用 .full_clean()、Django Admin 或表单校验中 |
| ✅ 为什么用 | 处理跨字段、业务逻辑相关的校验 |
| ✅ 如何用 | 在模型中覆写 clean() 方法 + 使用 ValidationError 抛错 |
| ✅ 最佳实践 | save 前调用 full_clean，确保数据完整性 |