Audit.NET 中拦截器更新元数据字段的审计问题解析

问题背景

在使用 Entity Framework Core 进行数据持久化时，开发者经常需要自动维护实体的元数据字段，如创建时间(CreatedAt)、创建人(CreatedBy)、更新时间(UpdatedAt)和更新人(UpdatedBy)等。这些字段通常通过实现自定义的 SaveChanges 拦截器来自动填充。

然而，当结合使用 Audit.NET 进行审计日志记录时，可能会遇到一个典型问题：虽然拦截器成功更新了这些元数据字段并且数据库中也正确存储了这些值，但在审计日志中这些字段的变更却未被记录，审计日志中对应的列显示为 NULL 值。

问题根源分析

这个问题的根本原因在于审计事件的创建时机与拦截器执行顺序的冲突。当使用 AuditDbContext 作为基类时，审计事件的创建发生在任何 SaveChanges 拦截器执行之前。具体流程如下：

1. 首先，AuditDbContext 会在操作开始时立即创建审计事件
2. 然后，开发者自定义的拦截器(如 EntityModificationInterceptor)才执行并更新元数据字段
3. 由于审计事件已经创建，它无法捕获拦截器后续对实体所做的修改

解决方案

要解决这个问题，我们需要调整审计日志的记录方式，确保它能够捕获所有拦截器对实体所做的修改。以下是推荐的解决方案：

1. 不再继承 AuditDbContext：改为直接从 DbContext 继承
2. 使用 AuditSaveChangesInterceptor：通过拦截器方式实现审计功能
3. 注意拦截器注册顺序：确保审计拦截器是最后一个注册的拦截器

具体实现代码如下：

public class AppDbContext : DbContext
{
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseSqlServer("...");
        // 先注册自定义元数据拦截器
        optionsBuilder.AddInterceptors(new EntityModificationInterceptor());
        // 最后注册审计拦截器
        optionsBuilder.AddInterceptors(new AuditSaveChangesInterceptor());
    }
}

实现原理

这种解决方案之所以有效，是因为：

1. 拦截器按照注册顺序执行，最后注册的拦截器最先执行
2. 审计拦截器作为最后一个注册的拦截器，会在所有其他拦截器执行完毕后执行
3. 此时所有对实体的修改(包括元数据字段的更新)都已经完成
4. 审计拦截器能够捕获到完整的实体状态变化

最佳实践建议

1. 拦截器执行顺序：始终将审计拦截器作为最后一个注册的拦截器
2. 元数据字段处理：确保元数据更新拦截器在审计拦截器之前执行
3. 测试验证：在实现后，应验证审计日志是否完整记录了所有字段变更
4. 性能考虑：对于高频更新的系统，审计日志量可能很大，需要考虑适当的日志清理策略

总结

通过调整审计日志的实现方式，我们可以确保所有对实体的修改(包括通过拦截器自动更新的元数据字段)都能被完整地记录到审计日志中。这种解决方案不仅解决了原始问题，还提供了更灵活的审计日志实现方式，使开发者能够更好地控制审计日志的生成过程。

理解这一机制对于开发需要完整审计功能的应用程序至关重要，特别是在需要自动维护元数据字段的企业级应用中。正确的实现方式可以确保系统既满足业务需求，又能提供完整可靠的操作审计记录。