EntityFramework-Plus 审计功能扩展实践：实现审计日志分组存储

审计功能扩展背景

在使用EntityFramework-Plus的审计功能时，开发者经常会遇到需要将审计记录分组存储的需求。例如，当一次事务中包含多个实体修改时，这些修改应该归属于同一个审计批次。虽然EF Plus提供了基础的审计功能，但在实际企业应用中，我们往往需要更精细的控制和扩展。

核心问题分析

EF Plus默认的审计模型包含三个主要类：

• Audit：表示一次审计操作
• AuditEntry：表示单个实体的审计条目
• AuditEntryProperty：表示实体属性的变更详情

默认情况下，Audit类不会被持久化到数据库，这导致我们无法直接建立审计操作与审计条目之间的持久化关联关系。虽然数据库表结构中会自动生成AuditId外键列，但在模型层面却无法直接访问这个关联关系。

解决方案实现

1. 创建自定义审计日志类

首先，我们需要创建一个继承自Audit的自定义类，并添加必要的属性：

public class CustomAudit : Audit
{
    public int Id { get; set; }
    public DateTime CreatedDate { get; set; }
    
    // 导航属性
    public ICollection<CustomAuditEntry> Entries { get; set; }
}

2. 扩展审计条目类

为了建立明确的关联关系，我们需要扩展AuditEntry类：

public class CustomAuditEntry : AuditEntry
{
    public int AuditId { get; set; }
    public CustomAudit ParentAudit { get; set; }
}

注意这里使用ParentAudit而非Parent，以避免与基类中可能存在的属性冲突。

3. 配置DbContext

在DbContext中进行正确的配置：

public DbSet<CustomAudit> AuditLogs { get; set; }
public DbSet<CustomAuditEntry> AuditEntries { get; set; }
public DbSet<AuditEntryProperty> AuditEntryProperties { get; set; }

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<CustomAudit>().ToTable("AuditLogs");
    modelBuilder.Entity<CustomAuditEntry>().ToTable("AuditEntries");
    modelBuilder.Entity<AuditEntryProperty>().ToTable("AuditEntryProperties");
    
    // 配置关系
    modelBuilder.Entity<CustomAuditEntry>()
        .HasOne(e => e.ParentAudit)
        .WithMany(a => a.Entries)
        .HasForeignKey(e => e.AuditId);
}

4. 实现审计保存逻辑

在保存审计日志时，需要手动设置关联关系：

var audit = new CustomAudit
{
    CreatedDate = DateTime.Now
};

var auditConfig = new AuditConfiguration();
auditConfig.AutoSavePreAction = (context, audit) => 
{
    var customAudit = (CustomAudit)audit;
    foreach (var entry in customAudit.Entries.Cast<CustomAuditEntry>())
    {
        entry.ParentAudit = customAudit;
        entry.AuditId = customAudit.Id;
    }
    
    context.Add(customAudit);
};

实际应用场景

这种扩展方式特别适用于以下场景：

1. 事务性操作审计：当一次业务操作涉及多个实体修改时，可以将这些修改归为同一审计批次
2. 审计还原系统：基于审计记录实现数据回滚功能时，需要明确操作批次
3. 审计分析报表：按操作批次统计和分析系统变更情况

注意事项

1. 确保在保存审计日志前正确设置关联关系
2. 考虑使用接口或基类来统一审计模型，便于扩展
3. 对于大型系统，考虑审计日志的分表策略
4. 注意审计日志的清理策略，避免数据量过大影响性能

通过这种扩展方式，我们可以在EF Plus提供的强大审计功能基础上，实现更符合企业需求的审计日志系统，为系统安全性和可追溯性提供更强保障。