如何实现“撤消”操作使用 Python/Django 的功能

Question

我有一个 Django 应用程序，允许用户导入包含联系人数据（成员编号、名字、姓氏等）的 CSV 文件。

导入文件时，应用程序会检查数据库中是否有匹配的记录，并且：1) 如果不存在匹配，则插入新记录，或者 2) 使用新数据更新现有数据。

我的问题是：使用 Django 或直接 Python 实现撤消功能的最佳方法是什么，以便用户可以撤消导入操作并将多个记录恢复到原始状态？

我最初的想法是创建一个像这样的表（伪代码）：

Table HISTORY
   unique_id
   record_affected_id
   old_value
   new_value

然后，如果用户单击“撤消”，我可以查找与其事务关联的 unique_id，并将受该事务影响的每个记录设置为 old_value。

我想知道是否有一种我缺少的更简单的方法来做到这一点，或者是否有人有类似的经验。

Answer 1

看一下 django-reversion。它为 Django 模型提供版本控制。可以轻松添加到现有项目中。

它不采用“当前”指针方法。相反，它会在每次保存对象时序列化对象，并将其存储在单独的 Version 模型中，并使用指向该对象的通用外键。 （默认情况下，关系字段被序列化为主键。）此外，它还允许以灵活的方式将 Version 分组为 Revision。

所以你可以这样做：

• 当用户上传 CSV 时，只需照常保存更改，但将 @revision.create_on_success 装饰器添加到执行导入的函数中，以便对该记录所做的任何更改函数将存储在单个修订版本中。
• 当用户点击“撤消”时，您只需恢复最新版本。

实现方法如下：：

@revision.create_on_success
def import_csv(request, csv):
    # Old versions of all objects save()d here will
    # belong to single revision.

def undo_last_csv_import(request):
    # First, get latest revision saved by this user.
    # (Assuming you create revisions only when user imports a CSV
    # and do not version control other data.)
    revision = Revision.objects.filter(user=request.user)\
        .order_by('-date_created')[0]
    # And revert it, delete=True means we want to delete
    # any newly added records as well
    revision.revert(delete=True)

它依赖于仅当用户导入 CSV 时才创建修订的事实。这意味着，如果您还计划对其他数据进行版本控制，那么您将需要实现某种标志，通过该标志您可以获得受最新导入影响的记录。然后你可以通过这个标志获取一条记录，获取它最新保存的版本，并恢复该版本所属的整个修订版。就像这样::

def undo_last_csv_import(request):
    some_record = Record.objects.by_user(request.user).from_the_last_import()[0]
    latest_saved_version_of_some_record = Version.objects.get_for_date(
        some_record,
        datetime.now(), # The latest saved Version at the moment.
        )
    # Revert all versions that belong to the same revision
    # as the version we got above.
    latest_saved_version_of_some_record.revision.revert()

这不是一个漂亮的解决方案，但肯定有一些方法可以通过这个应用程序做得更好。我建议查看代码以更好地理解 django-reversion 是如何工作的——文档非常详细，没有文档字符串就找不到函数。 ^_^d

（文档也很好，但结果对我来说有点误导，即他们编写 Version.objects.get_for_date(your_model, date) ，其中 your_model 实际上是一个模型实例。 )

更新： django-reversion 是积极维护的，所以不要太依赖上面的代码，最好检查他们的 wiki 了解如何管理版本和django 管理员之外的修订。例如，已经支持修订注释，这可能会稍微简化一些事情。

Answer 2

你需要进行版本控制，问题不在于Python或Django，而在于如何设计数据库来做到这一点。一种常见的方法是存储具有唯一 ID 的文档并跟踪哪个是“当前”。撤消只需将“当前”指针放回旧版本即可。据我所知，这就是你正在做的事情。

虽然这是常见的做法，但我不知道这是否是最好的。我从未见过任何其他方式，这可能意味着它是最好的，或者最好的方式并不明显。 :-)

在 Django 中以通用方式执行此操作可能是一个难题，但如果您让 Django 应用程序以自定义方式支持它，则会更容易。

然后，您会遇到有趣（而不是）的问题，例如如何在“未来”修订版中编辑内容，然后以暂存的内容方式立即发布一整套文档。但希望你不需要那个。 :-)

Answer 3

您的历史记录表看起来不错，只是您不需要 new_value 字段来执行撤消。是的，这就是通常实现“撤消”的方式（另一种选择是 Lennart 将版本号放入所有记录中的方法）。单独的日志表的优点是您不需要在常规查询中处理版本号。