在Audit.NET中使用DbContextFactory实现EF Core审计日志

背景介绍

在.NET应用程序开发中，数据访问审计是一项重要功能，能够记录对数据库的所有变更操作。Audit.NET是一个强大的审计日志库，提供了对Entity Framework Core的深度集成支持。本文将详细介绍如何在Audit.NET中结合DbContextFactory实现EF Core的审计功能。

核心配置要点

1. 基本DbContext配置

首先需要确保你的DbContext类正确配置。虽然Audit.NET提供了AuditDbContext基类，但并非必须继承它才能使用审计功能。一个典型的DbContext配置如下：

public class PgSqlDefaultDbContext : DbContext
{
    public PgSqlDefaultDbContext(DbContextOptions<PgSqlDefaultDbContext> options) : base(options)
    {
    }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        // 应用所有实现了IEntityTypeConfiguration的配置
        modelBuilder.ApplyConfigurationsFromAssembly(
            GetType().Assembly, 
            x => x.GetInterface(typeof(IEntityTypeConfiguration<>).FullName!) != null);
        
        // 配置审计日志表
        modelBuilder.Entity<AuditEventEntity>().ToTable("AuditEvents");
        
        base.OnModelCreating(modelBuilder);
    }
}

2. 使用OptIn模式进行选择性审计

Audit.NET提供了两种审计模式：

• 默认模式：审计所有实体
• OptIn模式：只审计显式指定的实体

OptIn模式更适合大型系统，可以精确控制需要审计的实体类型：

Audit.EntityFramework.Configuration.Setup()
    .ForContext<PgSqlDefaultDbContext>(config =>
    {
        config.IncludeEntityObjects()
              .AuditEventType("{context}:{database}")
              .ExcludeValidationResults();
    })
    .UseOptIn()  // 启用OptIn模式
    .Include<TerminalEntity>()  // 只审计TerminalEntity
    .Include<VehicleEntity>()   // 只审计VehicleEntity
    .Include<DriverEntity>();   // 只审计DriverEntity

3. 结合DbContextFactory的审计配置

当使用IDbContextFactory时，需要特别注意DbContext的生命周期管理。以下是完整的审计配置示例：

Audit.Core.Configuration.Setup().UseEntityFramework(option =>
{
    option.UseDbContext(_ => services.GetRequiredService<IDbContextFactory<PgSqlDefaultDbContext>>().CreateDbContext())
          .DisposeDbContext()  // 自动释放DbContext
          .AuditTypeExplicitMapper(mapper =>
          {
              // 必须为每个需要审计的实体类型显式映射
              mapper.Map<TerminalEntity, AuditEventEntity>()
                    .Map<VehicleEntity, AuditEventEntity>()
                    .Map<DriverEntity, AuditEventEntity>()
                    .AuditEntityAction<AuditEventEntity>((auditEvent, eventEntity, auditEntity) =>
                    {
                        // 自定义审计记录填充逻辑
                        auditEntity.Id = IdGenerator.Instance.NextId().ToString();
                        auditEntity.Data = eventEntity.ToJson();
                        auditEntity.EventType = eventEntity.EntityType.Name;
                        auditEntity.CreateDateTime = DateTimeOffset.UtcNow;
                    });
          });
});

关键注意事项

1. OptIn模式的顺序要求：Include方法必须在UseOptIn之后调用，否则不会生效。

2. 显式映射的必要性：在OptIn模式下，即使已经通过Include指定了要审计的实体类型，仍然需要在AuditTypeExplicitMapper中为每个类型进行映射。

3. DbContext生命周期管理：使用DisposeDbContext()确保每次审计操作后正确释放DbContext资源。

4. 服务获取优化：可以使用以下方式避免闭包问题，直接从当前DbContext获取服务：

option.UseDbContext(ev => 
    ev.GetEntityFrameworkEvent()
      .GetDbContext()
      .GetService<IDbContextFactory<PgSqlDefaultDbContext>>()
      .CreateDbContext())

最佳实践建议

1. 审计表设计：建议为审计日志设计专门的表结构，包含必要的字段如操作时间、操作类型、操作用户等。

2. 性能考虑：对于高频操作的系统，可以考虑将审计日志异步写入数据库或写入专门的日志存储。

3. 敏感数据处理：在审计配置中，可以使用Ignore方法排除敏感字段的审计记录。

4. 日志轮转：对于长期运行的系统，需要设计审计日志的归档和清理策略。

通过以上配置，开发者可以灵活地在使用DbContextFactory的环境中实现精确的EF Core数据访问审计功能，既保证了系统的安全性，又避免了不必要的性能开销。