如何为 Django 模型字段添加检查约束？

Question

在子类化db.models.Model时，有时有必要添加额外的检查/约束。

例如，我有一个带有 start_date 和 end_date 的 Event 模型：我想在字段或模型中添加验证，以便 结束日期>开始日期。

至少我知道这可以在 ModelForm 验证内的 models.Model 之外完成。但是如何附加到字段和 models.Model 呢？

Answer 1

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

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 2

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

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

另请注意，自版本 1.2 以来，Django 具有 模型验证 。

它看起来像这样：

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

在模型的 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 4

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

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

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

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

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

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

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

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

Answer 5

截至今天，postgres 9.4 和 MS SQL Server >= 2008 支持检查约束在 SQL 中。除此之外，还有 django issues 11964 似乎从昨天开始就已经准备好接受审查，所以希望我们能看到它集成到 django 2 中。该项目 rapilabs/django-db-constraints< /a> 似乎也实现了这一点。

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 可以处理这个:(