Django：如何保存模型实例快照以跟踪修改差异？

方案一：post_init信号+model_to_dict存储字段快照 #

利用Django内置的model_to_dict工具，在实例初始化时保存原始字段的字典快照，避免引用同步问题，同时自动处理外键字段（默认转为关联对象ID），无需手动序列化。

from django.db.models.signals import post_init, pre_save
from django.dispatch import receiver
from django.forms.models import model_to_dict
from myapp.models import Document  # 导入你的模型

@receiver(post_init, sender=Document)
def store_original_fields(sender, instance, **kwargs):
    # 存储原始字段的字典快照，自动处理外键为对应ID
    instance.__original_fields = model_to_dict(instance)

@receiver(pre_save, sender=Document)
def track_changes_on_save(sender, instance, **kwargs):
    current_fields = model_to_dict(instance)
    changes = {}
    
    # 对比原始快照与当前字段的差异
    for field, original_value in instance.__original_fields.items():
        current_value = current_fields.get(field)
        if original_value != current_value:
            changes[field] = (original_value, current_value)
    
    # 这里可添加自定义逻辑，比如记录变更日志
    if changes:
        print(f"Document {instance.id} 变更内容: {changes}")

优势 #

• 无需手动处理外键、多对多等关联字段，model_to_dict自动适配
• 避免JSON序列化/反序列化的繁琐操作
• 可轻松扩展到多模型：编写通用信号函数，批量注册即可

方案二：pre_save时直接从数据库拉取原始实例 #

如果不需要在实例生命周期内保留快照，可在保存前直接从数据库获取原始实例进行对比，逻辑更直接。

@receiver(pre_save, sender=Document)
def track_changes_pre_save(sender, instance, **kwargs):
    # 仅针对已存在的实例（更新操作）
    if instance.pk is None:
        return
    
    # 从数据库获取未修改的原始实例
    original_instance = sender.objects.get(pk=instance.pk)
    original_fields = model_to_dict(original_instance)
    current_fields = model_to_dict(instance)
    
    # 提取差异
    changes = {
        field: (original_fields[field], current_fields[field])
        for field in original_fields
        if original_fields[field] != current_fields[field]
    }
    
    if changes:
        print(f"Document {instance.id} 变更内容: {changes}")

注意点 #

• 每次保存会触发一次数据库查询，对高频率更新的模型需评估性能影响
• 无需额外存储实例属性，逻辑更轻量化

方案三：复用通用信号处理函数（多模型场景） #

如果需要给多个模型添加变更跟踪，可以编写通用信号函数，批量注册到目标模型：

def store_original_fields(sender, instance, **kwargs):
    instance.__original_fields = model_to_dict(instance)

def compare_changes(sender, instance, **kwargs):
    if not hasattr(instance, '__original_fields'):
        return
    
    current_fields = model_to_dict(instance)
    changes = {}
    for field, orig_val in instance.__original_fields.items():
        curr_val = current_fields.get(field)
        if orig_val != curr_val:
            changes[field] = (orig_val, curr_val)
    
    if changes:
        print(f"{sender.__name__} {instance.id} 变更内容: {changes}")

# 批量注册到多个模型
target_models = [Document, DocumentType, YourOtherModel]
for model in target_models:
    post_init.connect(store_original_fields, sender=model)
    pre_save.connect(compare_changes, sender=model)

内容的提问来源于stack exchange，提问作者Atro_TLT