Django模型完整历史记录实现及字段新旧值追踪咨询

嘿，我来帮你梳理下Django里实现模型完整历史记录的最优方案，尤其是你关心的字段新旧值展示问题～

首先明确：用成熟的第三方库是最优选择，比如django-reversion。你原本计划的手动为每个模型创建历史模型的方案，虽然可行，但会面临重复代码多、边缘场景处理复杂（比如批量操作、事务回滚、关联模型同步）等问题，而django-reversion已经封装好了这些核心逻辑，能帮你省大量开发时间。

一、手把手教你用django-reversion存储并展示字段新旧值 #

1. 基础配置 #

先安装库：

pip install django-reversion

然后把它添加到项目的INSTALLED_APPS中：

INSTALLED_APPS = [
    # ... 你的其他应用
    'reversion',
]

最后执行数据库迁移，创建django-reversion需要的表：

python manage.py migrate

2. 给目标模型注册版本控制 #

有两种常用方式，选你顺手的就行：

• 装饰器方式（推荐，适合全局生效）：直接给模型类加@reversion.register()装饰器，这样不管是在admin还是视图里操作模型，都会自动保存版本：

from django.db import models
import reversion

@reversion.register()
class Product(models.Model):
    name = models.CharField(max_length=100)
    price = models.DecimalField(max_digits=10, decimal_places=2)
    stock = models.IntegerField(default=0)
    # ... 其他字段

• Admin注册方式（仅在admin后台生效）：如果只需要在admin里记录版本，直接用VersionAdmin注册模型即可：

from django.contrib import admin
from reversion.admin import VersionAdmin
from .models import Product

admin.site.register(Product, VersionAdmin)

3. 获取并展示字段的新旧值 #

django-reversion会自动把每次修改（创建、更新、删除）的版本数据存在Revision和Version表中，每个Version实例包含了模型修改前后的序列化字段数据。

比如在视图中获取某个模型实例的所有历史版本，并对比新旧值：

import reversion
from django.shortcuts import get_object_or_404, render
from .models import Product

def product_history(request, pk):
    product = get_object_or_404(Product, pk=pk)
    # 获取该商品的所有版本，按操作时间倒序排列
    versions = reversion.get_for_object(product).order_by('-revision__date_created')
    
    history_records = []
    for idx, version in enumerate(versions):
        current_data = version.field_dict
        revision_info = {
            "date": version.revision.date_created,
            "user": version.revision.user,
        }
        
        # 第一个版本是创建记录
        if idx == 0:
            revision_info["action"] = "创建商品"
            revision_info["fields"] = current_data
        else:
            # 和上一个版本对比，找出变化的字段
            prev_version = versions[idx-1]
            prev_data = prev_version.field_dict
            
            changed_fields = {}
            for field_name in current_data:
                if current_data[field_name] != prev_data[field_name]:
                    changed_fields[field_name] = {
                        "old_value": prev_data[field_name],
                        "new_value": current_data[field_name]
                    }
            
            if changed_fields:
                revision_info["action"] = "修改商品"
                revision_info["changed_fields"] = changed_fields
        
        history_records.append(revision_info)
    
    return render(request, "products/history.html", {"history": history_records})

然后在模板history.html里可以这样展示：

<div class="history-container">
    {% for record in history %}
        <div class="history-item">
            <h4>{{ record.action }}</h4>
            <p>操作时间: {{ record.date|date:"Y-m-d H:i:s" }}</p>
            <p>操作人: {{ record.user.username|default:"系统" }}</p>
            
            {% if record.fields %}
                <p>初始字段值:</p>
                <ul>
                    {% for field, value in record.fields.items %}
                        <li>{{ field }}: {{ value }}</li>
                    {% endfor %}
                </ul>
            {% endif %}
            
            {% if record.changed_fields %}
                <p>修改的字段:</p>
                <ul>
                    {% for field, values in record.changed_fields.items %}
                        <li>{{ field }}: {{ values.old_value }} → {{ values.new_value }}</li>
                    {% endfor %}
                </ul>
            {% endif %}
            <hr>
        </div>
    {% empty %}
        <p>暂无历史记录</p>
    {% endfor %}
</div>

4. 进阶：自定义版本备注 #

如果需要给每个版本添加操作备注（比如“调整商品价格”），可以用上下文管理器手动创建版本：

# 在视图的保存逻辑中
with reversion.create_revision():
    # 设置版本备注
    reversion.set_comment("因促销活动调整商品价格")
    # 保存模型
    product.save()

如果需要自动关联当前登录用户，还可以加上reversion.set_user(request.user)（前提是视图能拿到request对象）。

二、为什么不推荐手动写历史模型？ #

你原本的思路是为每个模型建对应历史模型，这种方式的痛点很明显：

• 重复代码冗余：每个模型都要复制一遍字段到历史模型，原模型改字段时，历史模型必须同步修改，维护成本极高
• 边缘场景难处理：要手动处理创建、更新、删除的同步逻辑，还要考虑批量操作、事务回滚、关联模型的历史记录，很容易遗漏
• 缺少内置关联：自己写的话要手动记录操作人、操作时间，而django-reversion已经自动关联了Django的User模型和操作时间
• 版本对比繁琐：手动存储新旧值需要额外的逻辑，而django-reversion已经序列化了每个版本的完整数据，对比起来更高效

三、其他可选库（如果有特殊需求） #

如果django-reversion满足不了你的特定场景，还有两个不错的替代选项：

• django-simple-history：API更简洁，核心功能和django-reversion类似，也支持字段新旧值对比
• django-auditlog：专注于审计日志场景，适合需要严格记录所有操作痕迹的系统

不过对于大部分常规业务场景，django-reversion已经足够稳定好用了。

内容的提问来源于stack exchange，提问作者Ahmed Othman Mohamed Nazim