实体框架7审计日志

Question

我正在将一个旧项目移植到ASP.NET 5和Entity Framework 7。我使用了数据库优先的方法（DNX scaffold）来创建模型。

旧项目基于实体框架4，通过覆盖DbContext:的SaveChanges方法来实现审计跟踪

public override int SaveChanges(System.Data.Objects.SaveOptions options)
{
    int? UserId = null;
    if (System.Web.HttpContext.Current != null) 
        UserId = (from user in Users.Where(u => u.UserName == System.Web.HttpContext.Current.User.Identity.Name) select user.Id).SingleOrDefault();
    foreach (ObjectStateEntry entry in ObjectStateManager.GetObjectStateEntries(EntityState.Added | EntityState.Modified))
    {
        Type EntityType = entry.Entity.GetType();
        PropertyInfo pCreated = EntityType.GetProperty("Created");
        PropertyInfo pCreatedById = EntityType.GetProperty("CreatedById");
        PropertyInfo pModified = EntityType.GetProperty("Modified");
        PropertyInfo pModifiedById = EntityType.GetProperty("ModifiedById");
        if (entry.State == EntityState.Added)
        {
            if (pCreated != null)
                pCreated.SetValue(entry.Entity, DateTime.Now, new object[0]);
            if (pCreatedById != null && UserId != null)
                pCreatedById.SetValue(entry.Entity, UserId, new object[0]);
        }
        if (pModified != null)
            pModified.SetValue(entry.Entity, DateTime.Now, new object[0]);
        if (pModifiedById != null && UserId != null)
            pModifiedById.SetValue(entry.Entity, UserId, new object[0]);
        }
    }
    return base.SaveChanges(options);
}

我的问题是，如何在实体框架7中实现这一点？我必须采取代码优先的方法吗？

Answer 1

基本上有两种方法可以实现这一点：

使用ChangeTracker API（EF 6+）：

这是我们目前在EF 6中的做法，它仍然有效，适用于EF 7:

首先，您必须确保您的实体正在实现审计字段的通用接口：

public interface IAuditableEntity 
{
    int? CreatedById { get; set; }
    DateTime Created { get; set; }
    int? ModifiedById { get; set; }
    DateTime Modified { get; set; }
}

然后，您可以覆盖SaveChanges并使用审核值更新每个公共字段：

public override int SaveChanges()
{
    int? userId = null;
    if (System.Web.HttpContext.Current != null)
        userId = (from user in Users.Where(u => u.UserName == System.Web.HttpContext.Current.User.Identity.Name) select user.Id).SingleOrDefault();
    var modifiedEntries = ChangeTracker.Entries<IAuditableEntity>()
            .Where(e => e.State == EntityState.Added || e.State == EntityState.Modified);
    foreach (EntityEntry<IAuditableEntity> entry in modifiedEntries)
    {
        entry.Entity.ModifiedById = UserId;
        entry.Entity.Modified = DateTime.Now;
        if (entry.State == EntityState.Added)
        {
            entry.Entity.CreatedById = UserId;
            entry.Entity.Created = DateTime.Now;
        }
    }
    return base.SaveChanges();
}

使用EF 7新的"阴影属性"功能：

阴影属性是实体类中不存在的属性。这些属性的值和状态纯粹在"更改跟踪器"中进行维护。

换言之，审计列将不会在您的实体上公开，这似乎是一个更好的选择，与上面必须将其包含在实体中的审计列相比。

要实现阴影属性，首先必须在实体上配置它们。举个例子，您有一个User对象，它需要一些审核列：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<User>().Property<int>("CreatedById");
    modelBuilder.Entity<User>().Property<DateTime>("Created");
    modelBuilder.Entity<User>().Property<int>("ModifiedById");
    modelBuilder.Entity<User>().Property<DateTime>("Modified");
}

配置后，现在您可以在SaveChanges（）覆盖上访问它们，并相应地更新它们的值：

public override int SaveChanges()
{
    int? userId = null;
    if (System.Web.HttpContext.Current != null)
        userId = (from user in Users.Where(u => u.UserName == System.Web.HttpContext.Current.User.Identity.Name) select user.Id).SingleOrDefault();
    var modifiedBidEntries = ChangeTracker.Entries<User>()
        .Where(e => e.State == EntityState.Added || e.State == EntityState.Modified);
    foreach (EntityEntry<User> entry in modifiedBidEntries)
    {
        entry.Property("Modified").CurrentValue = DateTime.UtcNow;
        entry.Property("ModifiedById").CurrentValue = userId;
        if (entry.State == EntityState.Added)
        {
            entry.Property("Created").CurrentValue = DateTime.UtcNow;
            entry.Property("CreatedById").CurrentValue = userId;
        }
    }
    return base.SaveChanges();
}

最终想法：

对于实现审计列之类的东西，我将采用阴影属性方法，因为这些都是交叉关注的问题，不一定属于我的域对象，所以以这种方式实现它们将保持我的域物体的整洁。

Answer 2

我开发了一个可能会有所帮助的库。

看看Audit.EntityFramework库，它截取了SaveChanges()，并与EF Core版本兼容。