使用Audit.NET实现自定义审计日志存储的最佳实践

审计日志存储的常见需求

在企业级应用中，审计日志是系统安全性和可追溯性的重要组成部分。许多开发者在使用Audit.NET时，会遇到需要将审计日志存储到自定义数据库表的需求。本文将介绍两种实现方式及其适用场景。

方法一：通过DbContext事务控制

这种方式适合需要将审计日志与业务数据保持事务一致性的场景。核心实现要点包括：

1. 继承自AuditDbContext并配置审计数据提供者为NullDataProvider
2. 在OnScopeCreated中开始事务
3. 在OnScopeSaving中处理审计日志保存
4. 为审计日志实体添加[AuditIgnore]特性

public class MyContext : AuditDbContext
{
    public MyContext(DbContextOptions<MyContext> options) : base(options)
    {
        AuditDataProvider = new NullDataProvider();
    }
    
    public DbSet<AuditEntry> AuditEntry { get; set; }

    public override void OnScopeCreated(IAuditScope auditScope)
    {
        Database.BeginTransaction();
    }

    public override void OnScopeSaving(IAuditScope auditScope)
    {
        var efe = auditScope.GetEntityFrameworkEvent();
        if (efe.Success)
        {
            foreach (var item in efe.Entries)
            {
                var entry = new AuditEntry
                {
                    Data = item.ToJson() 
                };
                AuditEntry.Add(entry);
            }
            SaveChanges();
            Database.CurrentTransaction!.Commit();
        }
        else
        {
            Database.CurrentTransaction!.Rollback();
        }
    }
}

[AuditIgnore]
public class AuditEntry
{
    public int Id { get; set; }
    public string Data { get; set; }
}

优点：保证了业务数据和审计日志的事务一致性，如果审计日志保存失败，业务操作也会回滚。

缺点：实现相对复杂，需要手动管理事务。

方法二：使用全局配置

这种方式适合对事务一致性要求不高，但希望配置更简单的场景。

Audit.Core.Configuration.Setup()
    .UseEntityFramework(_ => _
        .AuditTypeMapper(t => typeof(AuditLog))  
        .AuditEntityAction<AuditLog>((ev, entry, entity) =>
        {
            entity.AuditData = entry.ToJson();
            entity.EntityType = entry.EntityType.Name;
            entity.AuditDate = DateTime.Now;
            entity.AuditUser = Environment.UserName;
            entity.TablePk = entry.PrimaryKey.First().Value.ToString();
        })
    .IgnoreMatchedProperties(true));

优点：配置简单，无需修改DbContext代码。

缺点：审计日志保存失败不会影响业务操作，缺乏事务一致性保证。

技术选型建议

1. 对于金融、医疗等对数据一致性要求高的领域，推荐使用方法一，确保审计日志与业务数据同步。
2. 对于一般业务系统，方法二更加简单易用。
3. 无论采用哪种方式，都应为审计日志实体添加[AuditIgnore]特性，避免审计系统记录审计日志本身。

常见问题解决

1. 事务冲突问题：确保审计日志实体不被审计系统跟踪，添加[AuditIgnore]特性。
2. 性能考虑：对于高频操作，建议将审计日志保存与业务操作分离，采用异步写入方式。
3. 日志格式：可以根据需要选择存储整个事件对象JSON或只存储变更条目。

通过合理选择实现方式，可以构建既满足业务需求又具备良好性能的审计日志系统。