python - 无论数据源如何，使用 Django/Django Rest Framework 验证和保存数据的正确过程是什么？

Question

我有一个特定的模型，我想对其执行自定义验证。我想保证在创建新实例时至少始终存在一个标识符字段，这样就不可能在没有这些字段之一的情况下创建实例，尽管没有特别需要单独的字段。

from django.db import models

class Security(models.Model):
    symbol = models.CharField(unique=True, blank=True)
    sedol = models.CharField(unique=True, blank=True)
    tradingitemid = models.Charfield(unique=True, blank=True)

我想要一种干净、可靠的方法来执行此操作，无论原始数据来自何处(例如，API 帖子或从其他来源(如 .csv 文件)获取此数据的内部函数)。

我知道我可以覆盖模型 .save() 方法并执行验证，但最佳实践指出 here建议在 .save() 方法中引发验证错误是一个坏主意，因为 View 只会返回 500 响应，而不是向 post 请求返回验证错误。

我知道我可以使用 validator 定义自定义序列化器使用 Django Rest Framework 来验证数据的模型(这对于创建对象的 ModelViewSet 来说是一个很好的解决方案，我可以保证每次都会使用这个序列化器)。但是，这种数据完整性保证仅在该 API 端点上有效，并且开发人员每次在代码库中的其他位置创建对象时都记得使用该序列化器(对象可以在整个代码库中从除网络 API)。

我也熟悉Django的.clean() and .full_clean() methods 。这些看起来像是完美的解决方案，只不过它再次依赖于开发人员始终记得调用这些方法——这取决于开发人员的内存力。我知道使用 ModelForm 时会自动调用这些方法，但同样，对于我的用例模型也可以从 .csv 下载创建 - 我需要一个通用的保证，这是最佳实践。我可以将 .clean() 放入模型的 .save() 方法中，但是这个 answer (以及帖子中的相关评论和链接)似乎使这种方法引起争议，并且可能是一种反模式。

有没有一种干净、直接的方法来保证这个模型永远不会在没有以下三个字段之一的情况下被保存:1.不会通过 View 引发 500 个错误，2.不依赖于开发人员创建对象时在整个代码库中显式使用正确的序列化程序，以及 3. 不依赖于将对 .clean() 的调用侵入到模型的 .save() 方法中(看似反模式)？我觉得这里必须有一个干净的解决方案，它不是将一些验证放入序列化器中的大杂烩，一些验证放在 .clean() 方法中，黑客 .save() 方法来调用 .clean() (它会被调用两次并从 ModelForms 保存)，等等...

Answer 1

人们当然可以想象一种设计，其中 save() 承担双重职责并为您处理验证。由于各种原因(部分总结在链接 here 中)，Django 决定将此过程分为两步。因此，我同意您发现的共识，即尝试将验证硬塞到 Model.save() 中是一种反模式。它与 Django 的设计背道而驰，并且可能会在以后引起问题。

您已经找到了“完美的解决方案”，即使用 Model.full_clean() 进行验证。我不同意你的观点，记住这一点会给开发人员带来负担。我的意思是，记住做正确的事情可能很困难，尤其是对于一个庞大而强大的框架，但这个特殊的事情很简单，有很好的文档记录，并且是 Django 的 ORM 设计的基础。

当您考虑到实际上对开发人员来说很困难(即错误处理本身)时，这一点尤其正确。开发人员不能只执行 model.validate_and_save()。相反，他们必须这样做:

try:
    model.validate_and_save()
except ValidationError:
    # handle error - this is the hard part

而 Django 的习惯用法是:

try:
    model.full_clean()
except ValidationError:
    # handle error - this is the hard part
else:
    model.save()

我不认为 Django 的版本更困难。 (也就是说，没有什么可以阻止您编写自己的 validate_and_save 便捷方法。)

最后，我建议也根据您的要求添加数据库约束。这就是当您添加一个它知道如何在数据库级别强制执行的约束时 Django 所做的事情。例如，当您在字段上使用 unique=True 时，Django 将创建数据库约束并添加 Python 代码来验证该要求。但是如果你想创建一个 Django 不知道的约束，你可以自己做同样的事情。除了在 clean() 中编写您自己的 Python 版本之外，您只需编写一个 Migration 来创建适当的数据库约束。这样，如果代码中存在错误并且验证未完成，最终会出现未捕获的异常 (IntegrityError)，而不是损坏的数据。