在 Django 中的字段中添加额外的约束

Question

在继承 db.models.Model 时，有时必须添加额外的检查/约束。

例如我有一个带有start_date 和end_date 的Event 模型。

我想在字段或模型中添加验证，以便end_date > start_date。

有多少种可能的方法来做到这一点？

至少我知道这可以在models.Model 之外在ModelForm 验证中完成。

但是如何附加到字段和models.Model？

Answer 1

在模型的 save 方法中执行此操作：

def save(self, *args, **kwargs):
    if(self.end_date > self.start_date):
        super(Foo, self).save(*args, **kwargs)
    else:
        raise Exception, "end_date should be greater than start_date" 

Answer 2

我不会在 save 方法中加入这样的约束，为时已晚。在那里引发异常，对以错误方式输入数据的用户没有帮助，因为它最终会显示为 500，并且用户不会得到错误的表单等。

您确实应该在 Forms/ModelForms clean 方法中检查这一点并引发 ValidationError，因此 form.is_valid() 返回 false，您可以将表单中的错误发送回用户以进行更正。

还要注意，从 1.2 版开始，Django 已经有了Model Validation。

看起来像这样：

class Foo(models.Model):
    #  ... model stuff...
    def clean(self):
        if self.start_date > self.end_date:
            raise ValidationError('Start date is after end date')

Answer 3

正如@stefanw 所说，检查表单的 clean 方法会带来更好的用户体验。

如果您非常确定没有而且永远不会有另一种更改值的方法，这就足够了。但是由于您很少能确定这一点，如果数据库一致性很重要，您可以添加另一个检查（除了表单），其中之一是：

• @umnik700 说，更简单且独立于数据库的方法是在模型的保存方法中。请注意，这仍然不能阻止数据库的其他用户（其他应用或管理界面）创建不一致的状态。

• 要“完全”确定数据库是一致的，您可以添加数据库级别的约束。例如。您可以使用 RunSQL 和 SQL 创建迁移，例如（未测试）：

  migrations.RunSQL('ALTER TABLE app_event ADD CONSTRAINT chronology CHECK (start_date > end_date);')
  

  （未测试）。这可能取决于数据库，这当然是一个缺点。

在您的示例中，这可能不值得（不正确的开始/结束时间看起来有点奇怪，但只会影响一个不一致的事件），并且您不希望手动更改架构。但它在一致性至关重要的情况下很有用。

编辑：您也可以只保存开始时间和持续时间，而不是开始和结束时间。

Answer 4

截至今天，postgres 9.4 和 MS SQL Server >= 2008 都支持 sql 中的检查约束。最重要的是，django issue 11964 似乎从昨天开始就准备好进行审查了，所以希望我们能看到它集成到 django 2 中。rapilabs/django-db-constraints 项目似乎也实现了这一点。

Answer 5

从 Django 2.2 开始，支持数据库级别 constraints：

from django.db import models
from django.db.models import CheckConstraint, Q, F

class Event(models.Model):
    start_date = models.DatetimeField() 
    end_date = models.DatetimeField()

    class Meta:
        constraints = [
            CheckConstraint(
                check = Q(end_date__gt=F('start_date')), 
                name = 'check_start_date',
            ),
        ]

Answer 6

总结之前的答案，这是我在一个项目中使用的完整解决方案：

from django.db import models
from django.db.models import CheckConstraint, Q, F
from django.utils.translation import gettext_lazy as _

class Event(models.Model):
    start_date = models.DatetimeField() 
    end_date = models.DatetimeField()

    class Meta:
        constraints = [
            # Ensures constraint on DB level, raises IntegrityError (500 on debug=False)
            CheckConstraint(
                check=Q(end_date__gt=F('start_date')), name='check_start_date',
            ),
        ]

    def clean(self):
        # Ensures constraint on model level, raises ValidationError
        if self.start_date > self.end_date:
            # raise error for field
            raise ValidationError({'end_date': _('End date cannot be smaller then start date.')})

太糟糕了，没有django.core.validators可以处理这个问题:(