实体框架4.1 DbContext覆盖SaveChanges以审核属性更改

Question

我正在尝试将属性更改的约束"审计日志"实现为一组类中的属性.我已成功找到如何设置CreatedOn | ModifiedOn类型属性,但未能找到如何"找到"已修改的属性.

例:

public class TestContext : DbContext
{
    public override int SaveChanges()
    {
        var utcNowAuditDate = DateTime.UtcNow;
        var changeSet = ChangeTracker.Entries<IAuditable>();
        if (changeSet != null)
            foreach (DbEntityEntry<IAuditable> dbEntityEntry in changeSet)
            {

                switch (dbEntityEntry.State)
                {
                    case EntityState.Added:
                        dbEntityEntry.Entity.CreatedOn = utcNowAuditDate;
                        dbEntityEntry.Entity.ModifiedOn = utcNowAuditDate;
                        break;
                    case EntityState.Modified:
                        dbEntityEntry.Entity.ModifiedOn = utcNowAuditDate;
                        //some way to access the name and value of property that changed here
                        var changedThing = SomeMethodHere(dbEntityEntry);
                        Log.WriteAudit("Entry: {0} Origianl :{1} New: {2}", changedThing.Name,
                                        changedThing.OrigianlValue, changedThing.NewValue)
                        break;
                }
            }
        return base.SaveChanges();
    }
}

那么,有没有办法访问在EF 4.1 DbContext中以这种详细程度更改的属性？

Answer 1

非常非常粗略的想法:

foreach (var property in dbEntityEntry.Entity.GetType().GetProperties())
{
    DbPropertyEntry propertyEntry = dbEntityEntry.Property(property.Name);
    if (propertyEntry.IsModified)
    {
        Log.WriteAudit("Entry: {0} Original :{1} New: {2}", property.Name,
            propertyEntry.OriginalValue, propertyEntry.CurrentValue);
    }
}

我不知道这是否真的有效,但我会尝试这是第一步.当然可能有多个属性已经改变,因此循环和可能多次调用WriteAudit.

SaveChanges内部的反射内容可能会成为一场表演噩梦.

编辑

也许最好访问底层证券ObjectContext.那么这样的事情是可能的:

public class TestContext : DbContext
{
    public override int SaveChanges()
    {
        ChangeTracker.DetectChanges(); // Important!

        ObjectContext ctx = ((IObjectContextAdapter)this).ObjectContext;

        List<ObjectStateEntry> objectStateEntryList =
            ctx.ObjectStateManager.GetObjectStateEntries(EntityState.Added
                                                       | EntityState.Modified 
                                                       | EntityState.Deleted)
            .ToList();

       foreach (ObjectStateEntry entry in objectStateEntryList)
       {
           if (!entry.IsRelationship)
           {
               switch (entry.State)
               {
                   case EntityState.Added:
                       // write log...
                       break;
                   case EntityState.Deleted:
                       // write log...
                       break;
                   case EntityState.Modified:
                   {
                       foreach (string propertyName in
                                    entry.GetModifiedProperties())
                       {
                           DbDataRecord original = entry.OriginalValues;
                           string oldValue = original.GetValue(
                               original.GetOrdinal(propertyName))
                               .ToString();

                           CurrentValueRecord current = entry.CurrentValues;
                           string newValue = current.GetValue(
                               current.GetOrdinal(propertyName))
                               .ToString();

                           if (oldValue != newValue) // probably not necessary
                           {
                               Log.WriteAudit(
                                   "Entry: {0} Original :{1} New: {2}",
                                   entry.Entity.GetType().Name,
                                   oldValue, newValue);
                           }
                       }
                       break;
                   }
               }
           }
       }
       return base.SaveChanges();
    }
}

我自己在EF 4.0中使用过它.我GetModifiedProperties在DbContextAPI中找不到相应的方法(这是避免反射代码的关键).

编辑2

重要提示:使用POCO实体时,上面的代码需要DbContext.ChangeTracker.DetectChanges()在开头调用.原因是base.SaveChanges在这里调用太晚了(在方法结束时).内部base.SaveChanges调用DetectChanges,但由于我们之前想要分析和记录更改,我们必须DetectChanges手动调用,以便EF可以找到所有已修改的属性并正确设置更改跟踪器中的状态.

在某些情况下,代码可以在不调用的情况下工作DetectChanges,例如,如果在最后一次属性修改之后使用DbContext/DbSet方法Add,Remove则这些方法也会在DetectChanges内部调用.但是,例如,如果实体刚从DB加载,则会更改一些属性,然后SaveChanges调用此派生,之前不会发生自动更改检测base.SaveChanges,最终导致修改属性的日志条目丢失.

我相应地更新了上面的代码.

Answer 2

您可以使用Slauma建议的SaveChanges()方法,但不是覆盖方法,而是可以处理SavingChanges事件以便更容易实现.