如何根据 属性 和 Audit.NET EntityFramework.Core 的更改写入审核日志条目

How to write an audit log entry per changed property with Audit.NET EntityFramework.Core

我正在尝试获取 Audit:NET EntityFramework.Core 扩展来为每次更改写入 AuditLog 条目 属性。

为此,我用自定义 DataProvider 覆盖了 EntityFrameworkDataProvider.InsertEvent

问题是,使用 DbContextHelper.Core.CreateAuditEvent 创建一个新的 EntityFrameworkEvent returns null。

原因似乎是,此时在代码执行中DbContextHelper.GetModifiedEntries 确定所有EF Entries 都有State.Unmodified,即使它们明确包含在EventEntry 更改中。

由于 private/internal 属性,我无法通过手动创建内容来规避 CreateAuditEvent。

也许我没有看到这个问题的替代解决方案,我愿意接受所有建议。

审计实体class

public class AuditLog
{
    public int Id { get; set; }
    public string Description { get; set; }
    public string OldValue { get; set; }
    public string NewValue { get; set; }
    public string PropertyName { get; set; }
    public DateTime AuditDateTime { get; set; }
    public Guid? AuditIssuerUserId { get; set; }
    public string AuditAction { get; set; }
    public string TableName { get; set; }
    public int TablePK { get; set; }
}

启动配置

Audit.Core.Configuration.Setup()
    .UseCustomProvider(new CustomEntityFrameworkDataProvider(x => x
        .AuditEntityAction<AuditLog>((ev, ent, auditEntity) =>
        {
            auditEntity.AuditDateTime = DateTime.Now;
            auditEntity.AuditAction = ent.Action;
            foreach(var change in ent.Changes)
            {
                auditEntity.OldValue = change.OriginalValue.ToString();
                auditEntity.NewValue = change.NewValue.ToString();
                auditEntity.PropertyName = change.ColumnName;
            }
        }

自定义数据提供者class

public class CustomEntityFrameworkDataProvider : EntityFrameworkDataProvider
{
    public override object InsertEvent(AuditEvent auditEvent)
    {
        var auditEventEf = auditEvent as AuditEventEntityFramework;
        if (auditEventEf == null)
            return null;

        object result = null;
        foreach (var entry in auditEventEf.EntityFrameworkEvent.Entries)
        {
            if (entry.Changes == null || entry.Changes.Count == 0)
                continue;

            foreach (var change in entry.Changes)
            {
                var contextHelper = new DbContextHelper();
                var newEfEvent = contextHelper.CreateAuditEvent((IAuditDbContext)auditEventEf.EntityFrameworkEvent.GetDbContext());
                if (newEfEvent == null)
                    continue;
                newEfEvent.Entries = new List<EventEntry>() { entry };
                entry.Changes = new List<EventEntryChange> { change };
                auditEventEf.EntityFrameworkEvent = newEfEvent;
                result = base.InsertEvent(auditEvent);

            }
        }
        return result;
    }
}

在这里查看我的回答https://github.com/thepirat000/Audit.NET/issues/323#issuecomment-673007204

您不需要调用 CreateAuditEvent() 您应该能够遍历原始事件的更改列表并为每个更改调用 base.InsertEvent(),如下所示:

public override object InsertEvent(AuditEvent auditEvent)
{
    var auditEventEf = auditEvent as AuditEventEntityFramework;
    if (auditEventEf == null)
        return null;

    object result = null;
    foreach (var entry in auditEventEf.EntityFrameworkEvent.Entries)
    {
        if (entry.Changes == null || entry.Changes.Count == 0)
            continue;

        // Call base.InsertEvent for each change
        var originalChanges = entry.Changes;
        foreach (var change in originalChanges)
        {
            entry.Changes = new List<EventEntryChange>() { change };
            result = base.InsertEvent(auditEvent);
        }
        entry.Changes = originalChanges;

    }
    return result;
}

备注:

  • 这可能会影响性能,因为它会为每个列更改触发向数据库的插入。
  • 如果您打算使用对 DbContext.SaveChangesAsync 的异步调用,您还应该在 CustomDataProvider
  • 上实现 InsertEventAsync 方法
  • 更改 属性 仅适用于更新,因此如果您还想审核插入和删除,则需要添加逻辑以从 ColumnValues 属性 中获取列值在活动中