Django 对象唯一性地狱与 M2M 字段

Question

class Badge(SafeDeleteModel):
    owner = models.ForeignKey(settings.AUTH_USER_MODEL,
                              blank=True, null=True,
                              on_delete=models.PROTECT)
    restaurants = models.ManyToManyField(Restaurant)
    identifier = models.CharField(max_length=2048)  # not unique at a DB level!

我想确保对于任何徽章，对于给定的餐厅，它必须具有唯一的标识符。以下是我的 4 个想法：

• idea #1：使用 unique_together -> 不适用于 M2M 字段，如 [in documentation] 所述 (https://docs.djangoproject.com/en/2.1/ref/models/options/#unique-together)
• 想法#2：覆盖save() 方法。不完全适用于 M2M，因为在调用 add 或 remove 方法时，不会调用 save()。

• idea #3：使用显式的through 模型，但由于我在生产环境中，我想避免在迁移重要结构（如论文）时冒险。 编辑：想了想，我看不出它实际上有什么帮助。

• 想法#4：在调用add() 方法时，使用m2m_changedsignal 来检查唯一性。

我最终得到了idea 4，并认为一切都很好，有了这个信号......

@receiver(m2m_changed, sender=Badge.restaurants.through)
def check_uniqueness(sender, **kwargs):
    badge = kwargs.get('instance', None)
    action = kwargs.get('action', None)
    restaurant_pks = kwargs.get('pk_set', None)

    if action == 'pre_add':
        for restaurant_pk in restaurant_pks:
            if Badge.objects.filter(identifier=badge.identifier).filter(restaurants=restaurant_pk):
                raise BadgeNotUnique(MSG_BADGE_NOT_UNIQUE.format(
                    identifier=badge.identifier,
                    restaurant=Restaurant.objects.get(pk=restaurant_pk)
                ))

...直到今天我在我的数据库中发现许多具有相同标识符但没有餐厅的徽章（不应该在业务级别发生） 我知道save() 和信号之间没有原子性。 这意味着，如果用户在尝试创建徽章时遇到关于唯一性的错误，则会创建徽章，但没有与其关联的餐厅。

所以，问题是：您如何在模型级别确保如果信号引发错误，save() 不会被提交？

谢谢！

Answer 1

您可以为您的 M2M 模型指定 your own connecting model，然后在成员模型的元类中添加 unique_together 约束

class Badge(SafeDeleteModel):
    ...
    restaurants = models.ManyToManyField(Restaurant, through='BadgeMembership')

class BadgeMembership(models.Model):
    restaurant = models.ForeignKey(Restaurant, null=False, blank=False, on_delete=models.CASCADE)
    badge = models.ForeignKey(Badge, null=False, blank=False, on_delete=models.CASCADE)

    class Meta:
        unique_together = (("restaurant", "badge"),)

这将创建一个位于 Badge 和 Restaurant 之间的对象，该对象对于每个餐厅的每个徽章都是唯一的。

可选：保存检查

您还可以添加自定义save 函数，您可以在其中手动检查唯一性。通过这种方式，您可以手动引发异常。

class BadgeMembership(models.Model):
    restaurant = models.ForeignKey(Restaurant, null=False, blank=False, on_delete=models.CASCADE)
    badge = models.ForeignKey(Badge, null=False, blank=False, on_delete=models.CASCADE)

    def save(self, *args, **kwargs):
        # Only save if the object is new, updating won't do anything
        if self.pk is None:
            membershipCount = BadgeMembership.objects.filter(
                Q(restaurant=self.restaurant) &
                Q(badge=self.badge)
            ).count()
            if membershipCount > 0:
                raise BadgeNotUnique(...);
            super(BadgeMembership, self).save(*args, **kwargs)

Answer 2

恐怕真正实现这一目标的正确方法是采用“通过”模型。但请记住，在数据库级别，这种“通过”模型已经存在，因此您的迁移只是添加一个唯一约束。这是一个相当简单的操作，实际上并不涉及任何真正的迁移，我们经常在生产环境中这样做。

看看this example，它几乎概括了你需要的一切。

Answer 3

我在这里看到两个不同的问题：

1. 您希望对数据实施特定约束。

2. 如果违反了约束，您希望恢复以前的操作。特别是，如果在违反约束的同一请求中添加了任何 Restaurants，您希望恢复 Badge 实例的创建。

关于 1，您的约束很复杂，因为它涉及多个表。这排除了数据库约束（好吧，您可能可以使用触发器来完成）或简单的模型级验证。

您上面的代码显然可以有效地防止违反约束的adds。但请注意，如果现有 Badge 的标识符发生更改，也可能违反此约束。大概您也想防止这种情况发生？如果是这样，您需要向Badge 添加类似的验证（例如在Badge.clean() 中）。

关于 2，如果您希望在违反约束时恢复 Badge 实例的创建，您需要确保将操作包装在数据库事务中。您还没有告诉我们这些对象区域创建的视图（自定义视图？Django 管理员？），因此很难给出具体建议。本质上，你想要这样：

with transaction.atomic():
    badge_instance.save()
    badge_instance.add(...)

如果这样做，您的 M2M pre_add 信号引发的异常将回滚事务，并且您不会在数据库中获得剩余的 Badge。请注意，管理员视图默认在事务中运行，因此如果您使用管理员，这应该已经发生了。

另一种方法是在创建Badge 对象之前进行验证。例如，请参阅 this answer 关于在 Django 管理中使用 ModelForm 验证。