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

时间:2011-05-27 19:27:15

标签: entity-framework

我正在尝试将属性更改的约束“审核日志”实现为一组类中的属性。我已成功找到如何设置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中以这种详细程度更改的属性?

5 个答案:

答案 0 :(得分:44)

非常非常粗略的想法:

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 API中找到DbContext(这是避免反射代码的关键)的相应方法。

修改2

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

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

我已相应更新了上面的代码。

答案 1 :(得分:7)

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

答案 2 :(得分:1)

似乎Slauma的答案不会审核复杂类型属性的内部属性的更改。

如果这对您来说是个问题,我的回答here可能会有所帮助。如果属性是一个复杂的属性并且它已经更改,我将整个复杂属性序列化为审计日志记录。它不是最有效的解决方案,但它并不是太糟糕,它可以完成工作。

答案 3 :(得分:1)

我真的很喜欢Slauma的解决方案。我通常更喜欢跟踪修改后的表并记录主键。这是一个非常简单的方法,您可以使用它来调用getEntityKeys(entry)

    public static string getEntityKeys(ObjectStateEntry entry)
    {
        return string.Join(", ", entry.EntityKey.EntityKeyValues
                                .Select(x => x.Key + "=" + x.Value));
    }

答案 4 :(得分:0)

请参阅Using Entity Framework 4.1 DbContext Change Tracking for Audit Logging

使用DbEntityEntry。详细审核添加,删除,修改