ABP v3.4.0实体历史追踪：如何在更新事件中获取历史信息？

我来帮你梳理下ABP v3.4.0中实体历史追踪的正确用法，解决你遇到的问题：

你之前遇到的核心问题是：实体更新事件（比如EntityUpdatedEventData）触发时机在SaveChanges之前，这时候ABP还没把实体变更记录写入数据库，所以直接查询IRepository<EntityChangeSet,long>自然拿不到数据。

正确的实现思路：监听实体历史保存后的事件 #

ABP专门提供了EntityHistorySavedEventData事件，它会在实体历史记录被成功保存到数据库之后触发，这时候你就能完整获取到所有变更信息了。

具体实现步骤 #

1. 确保实体已开启审计追踪
   首先要确认你关注的实体已经启用了历史记录：

   • 在实体类上添加[Audited]特性：

     [Audited]
     public class MyEntity : FullAuditedEntity<long>
     {
         public bool Enabled { get; set; }
         // 其他属性...
     }
     

   • 或者在模块的ConfigureServices中全局启用实体历史功能：

     public override void ConfigureServices(ServiceConfigurationContext context)
     {
         GlobalFeatureManager.Instance.Enable<EntityHistoryFeature>();
         // 其他配置...
     }
     

2. 创建EntityHistorySavedEventData事件处理器
   编写一个事件处理类，订阅该事件并处理属性变更逻辑：

   public class EntityChangeHandler : IEventHandler<EntityHistorySavedEventData>, ITransientDependency
   {
       // 可以注入你需要的服务，比如通知服务、其他仓库等
       private readonly ILogger<EntityChangeHandler> _logger;
   
       public EntityChangeHandler(ILogger<EntityChangeHandler> logger)
       {
           _logger = logger;
       }
   
       public Task HandleEventAsync(EntityHistorySavedEventData eventData)
       {
           // 遍历本次SaveChanges中所有的实体变更记录
           foreach (var entityChange in eventData.EntityChangeSet.EntityChanges)
           {
               // 过滤出你关注的实体类型
               if (entityChange.EntityTypeFullName == typeof(MyEntity).FullName)
               {
                   // 查找Enabled属性的变更详情
                   var enabledPropertyChange = entityChange.PropertyChanges
                       .FirstOrDefault(pc => pc.PropertyName == nameof(MyEntity.Enabled));
   
                   if (enabledPropertyChange != null)
                   {
                       // 判断属性是否从Enabled变为Disabled
                       var oldValue = bool.Parse(enabledPropertyChange.OldValue);
                       var newValue = bool.Parse(enabledPropertyChange.NewValue);
                       if (oldValue && !newValue)
                       {
                           // 这里执行你的后续操作，比如发送通知、更新关联数据等
                           _logger.LogInformation($"实体ID {entityChange.EntityId} 的Enabled属性从启用变为禁用");
                           // 示例：await _notificationService.SendAsync(...);
                       }
                   }
               }
           }
   
           return Task.CompletedTask;
       }
   }
   

补充说明 #

• EntityHistorySavedEventData中的EntityChangeSet包含了本次数据库提交中所有的实体变更（新增、修改、删除），你可以根据需求过滤操作类型（entityChange.ChangeType）
• 如果需要处理单个实体的变更逻辑，也可以结合领域服务，但跨实体或通用的变更监听用事件处理器更灵活
• 注意属性值的类型转换：ABP存储的属性值是字符串格式，需要根据实际类型解析

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