Entity framework core 如何使用audit.NET EntityFramework.Core为每个更改的属性编写审核日志项

我正在尝试让Audit:NET EntityFramework.Core扩展为每个更改的属性编写一个AuditLog条目

为此，我使用自定义数据提供程序覆盖了

EntityFrameworkDataProvider.InsertEvent

问题是，使用

DbContextHelper.Core.CreateAuditEvent

创建新的EntityFrameworkEvent返回null

原因似乎是，在代码执行的这一点上，

DbContextHelper.GetModifiedEntries

确定所有EF条目都具有

状态。未修改的

，即使它们明确包含在EventEntry更改中

由于私有/内部属性的原因，我试图通过手动创建内容来规避CreateAuditEvent

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

审计实体类别

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; }
}

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;
    }
}

启动配置

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;
            }
        }

Audit.Core.Configuration.Setup（）
.UseCustomProvider（新的CustomEntityFrameworkDataProvider（x=>x
.AuditEntityAction（（ev、ent、auditEntity）=>
{
auditEntity.AuditDateTime=DateTime.Now；
auditEntity.AuditAction=ent.Action；
foreach（会计科目变动中的var变动）
{
auditEntity.OldValue=change.OriginalValue.ToString（）；
auditEntity.NewValue=change.NewValue.ToString（）；
auditEntity.PropertyName=change.ColumnName；
}
}

自定义数据提供程序类

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; }
}

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;
    }
}

公共类CustomEntityFrameworkDataProvider:EntityFrameworkDataProvider
{
公共重写对象插入事件（AuditEvent AuditEvent）
{
var auditEventEf=auditEvent作为AuditEventEntityFramework；
如果（auditEventEf==null）
返回null；
对象结果=空；
foreach（auditEventEf.EntityFrameworkEvent.Entries中的var条目）
{
if（entry.Changes==null | | entry.Changes.Count==0）
继续；
foreach（分录中的var变更。变更）
{
var contextHelper=new DbContextHelper（）；
var newEfEvent=contextHelper.CreateAuditEvent（（IAuditDbContext）auditEventEf.EntityFrameworkEvent.GetDbContext（））；
if（newEfEvent==null）
继续；
Entries=newlist（）{entry}；
entry.Changes=新列表{change}；
auditEventEf.EntityFrameworkEvent=newEfEvent；
结果=base.InsertEvent（auditEvent）；
}
}
返回结果；
}
}

在这里检查我的答案

您不需要调用

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;
}

公共重写对象插入事件（AuditEvent AuditEvent）
{
var auditEventEf=auditEvent作为AuditEventEntityFramework；
如果（auditEventEf==null）
返回null；
对象结果=空；
foreach（auditEventEf.EntityFrameworkEvent.Entries中的var条目）
{
if（entry.Changes==null | | entry.Changes.Count==0）
继续；
//为每个更改调用base.InsertEvent
var originalChanges=条目。更改；
foreach（原始变化中的var变化）
{
entry.Changes=新列表（）{change}；
结果=base.InsertEvent（auditEvent）；
}
条目变更=原始变更；
}
返回结果；
}

注:

• 这可能会影响性能，因为它会为每个列更改触发对数据库的插入
• 如果计划使用对DbContext.SaveChangesAsync的异步调用，还应在CustomDataProvider上实现InsertEventAsync方法
• Changes属性仅适用于更新，因此如果您还希望审核插入和删除，则需要添加逻辑以从事件的ColumnValues属性获取列值