事件溯源实践：基于EF自动检测字段变更的最优Payload结构探讨

核心思路：通用化字段变更事件 + 强类型元数据 #

既规避字典存储的类型不安全问题，又避免为每个字段编写重复事件类，核心是打造通用型字段变更事件，同时通过强类型机制保障类型安全，兼顾灵活性与可维护性。

方案实现步骤 #

1. 定义通用变更事件结构
   创建泛型基类事件，绑定聚合根类型，内置聚合根ID、字段名、新旧值、字段类型及基础元数据，字段移除场景可单独做精简版事件：

   public class AggregateFieldChangedEvent<T> where T : AggregateRoot
   {
       public Guid AggregateId { get; set; }
       public string FieldName { get; set; }
       public object? OldValue { get; set; }
       public object? NewValue { get; set; }
       public Type FieldType { get; set; }
       public DateTimeOffset ChangedAt { get; set; }
       public string ChangedBy { get; set; }
   }
   
   // 字段移除事件（针对属性置空或逻辑移除场景）
   public class AggregateFieldRemovedEvent<T> where T : AggregateRoot
   {
       public Guid AggregateId { get; set; }
       public string FieldName { get; set; }
       public object? RemovedValue { get; set; }
       public DateTimeOffset RemovedAt { get; set; }
       public string RemovedBy { get; set; }
   }
   

2. 基于EF变更追踪生成强类型事件
   遍历EF变更追踪器中的聚合根修改记录，通过反射获取字段的类型与值，直接实例化通用事件，替代字典存储：

   var trackedAggregates = _context.ChangeTracker.Entries<AggregateRoot>();
   foreach (var entry in trackedAggregates)
   {
       if (entry.State == EntityState.Modified)
       {
           foreach (var prop in entry.Properties.Where(p => p.IsModified))
           {
               var changeEvent = new AggregateFieldChangedEvent<AggregateRoot>
               {
                   AggregateId = entry.Entity.Id,
                   FieldName = prop.Metadata.Name,
                   OldValue = prop.OriginalValue,
                   NewValue = prop.CurrentValue,
                   FieldType = prop.Metadata.ClrType,
                   ChangedAt = DateTimeOffset.UtcNow,
                   ChangedBy = _currentUserService.GetUserId()
               };
               _eventStore.SaveEvent(changeEvent);
           }
       }
       // 处理字段移除场景（例如属性从非空变为null）
       else if (entry.State == EntityState.Modified)
       {
           foreach (var prop in entry.Properties.Where(p => p.CurrentValue == null && p.OriginalValue != null))
           {
               var removeEvent = new AggregateFieldRemovedEvent<AggregateRoot>
               {
                   AggregateId = entry.Entity.Id,
                   FieldName = prop.Metadata.Name,
                   RemovedValue = prop.OriginalValue,
                   RemovedAt = DateTimeOffset.UtcNow,
                   RemovedBy = _currentUserService.GetUserId()
               };
               _eventStore.SaveEvent(removeEvent);
           }
       }
   }
   

3. 序列化/反序列化的类型安全保障
   利用事件中存储的FieldType字段，在反序列化回放时做类型转换，避免类型错误。以Newtonsoft.Json为例，可自定义转换器：

   public class FieldValueConverter : JsonConverter
   {
       public override bool CanConvert(Type objectType) => true;
   
       public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
       {
           var eventObj = (JObject)JToken.ReadFrom(reader);
           var fieldType = Type.GetType(eventObj["FieldType"].ToString());
           return eventObj["NewValue"].ToObject(fieldType);
       }
   
       public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
       {
           serializer.Serialize(writer, value);
       }
   }
   

4. 事件回放的简化处理
   通过反射批量处理事件赋值，无需为每个字段编写单独的回放逻辑：

   public void Apply(AggregateFieldChangedEvent<MyAggregate> @event)
   {
       var prop = typeof(MyAggregate).GetProperty(@event.FieldName);
       if (prop != null && prop.CanWrite)
       {
           var typedValue = Convert.ChangeType(@event.NewValue, @event.FieldType);
           prop.SetValue(this, typedValue);
       }
   }
   

额外优化建议 #

• 高频字段分组事件：针对经常一起变更的字段（如用户的姓名、邮箱、手机号），可创建少量分组事件（如UserProfileUpdatedEvent），平衡事件数量与灵活性。
• 事件版本控制：为事件添加版本号，后续字段类型变更时，可在回放阶段做兼容处理。
• 过滤无意义变更：跳过计算字段、审计字段等业务无关的属性修改，减少冗余事件。

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