EF Core 中实现事务性审计日志的最佳实践

在 EF Core 项目中实现审计日志功能是一个常见需求，但如何确保审计日志与业务数据在同一事务中持久化却是一个技术难点。本文将深入探讨在 EF Core 中实现事务性审计日志的几种方案及其优缺点。

审计日志的核心挑战

审计日志通常需要记录以下关键信息：

• 操作类型（增删改）
• 操作时间
• 操作用户
• 实体变更前后的值
• 事务ID等上下文信息

主要技术难点在于：

1. 获取数据库生成的值（如自增ID）
2. 确保审计日志与业务数据在同一事务中
3. 正确处理事务回滚场景

解决方案比较

方案一：使用 SavingChanges 拦截器

在 SavingChanges 拦截器中生成审计日志是最直观的做法，但存在以下限制：

• 此时数据库生成的值尚未设置
• 无法获取最终的实体状态

public class AuditInterceptor : SaveChangesInterceptor
{
    public override InterceptionResult<int> SavingChanges(
        DbContextEventData eventData, 
        InterceptionResult<int> result)
    {
        // 生成审计日志
        return base.SavingChanges(eventData, result);
    }
}

方案二：使用 SavedChanges 拦截器

在 SavedChanges 拦截器中：

• 可以获取数据库生成的值
• 但此时事务可能已经提交
• 需要额外的事务管理

public override void SavedChanges(SaveChangesCompletedEventData eventData)
{
    // 需要显式管理事务
}

方案三：使用 DbTransactionInterceptor

更底层的方案是使用事务拦截器：

• 在 TransactionCommittingAsync 中生成审计日志
• 需要手动调用 AcceptAllChanges()
• 需处理重复保存问题

public override async Task TransactionCommittingAsync(
    DbTransaction transaction,
    TransactionEventData eventData,
    CancellationToken cancellationToken = default)
{
    var context = eventData.Context;
    context.ChangeTracker.AcceptAllChanges();
    
    // 生成并保存审计日志
    await context.SaveChangesAsync(cancellationToken);
}

推荐方案：显式事务管理

最可靠的方案是使用显式事务包裹整个操作：

await using var transaction = await context.Database.BeginTransactionAsync();

try
{
    // 业务操作
    await context.SaveChangesAsync();
    
    // 审计日志操作
    await auditContext.SaveChangesAsync();
    
    await transaction.CommitAsync();
}
catch
{
    await transaction.RollbackAsync();
    throw;
}

这种方案的优点包括：

1. 完全控制事务边界
2. 清晰的错误处理
3. 支持重试机制
4. 审计日志与业务数据严格一致

审计日志设计建议

一个健壮的审计日志实体设计应包含：

public class EntityAuditEvent
{
    public Guid Id { get; private set; }
    public DateTime Timestamp { get; init; }
    public Guid TransactionId { get; init; }
    public string EntityType { get; init; }
    public string EntityName { get; init; }
    public string PrimaryKey { get; init; }
    public ChangeKind ChangeKind { get; init; }
    public IReadOnlyList<PropertyChange> Changes { get; init; }
}

public class PropertyChange
{
    public string Name { get; init; }
    public string OriginalValue { get; init; }
    public string NewValue { get; init; }
}

对于复杂属性的审计，可以使用递归方式处理：

public static Dictionary<string, object?> GetOriginalValue(
    ComplexPropertyEntry complexProperty)
{
    var regularProperties = complexProperty.Properties
        .Select(p => (p.Metadata.Name, p.OriginalValue));
    
    var complexProperties = complexProperty.ComplexProperties
        .Select(p => (p.Metadata.Name, GetOriginalValue(p)));
        
    return regularProperties.Concat(complexProperties)
        .ToDictionary(t => t.Name, t => t.Item2);
}

总结

在 EF Core 中实现事务性审计日志的关键点在于：

1. 根据需求选择合适的拦截点
2. 正确处理事务边界
3. 设计灵活的审计日志结构
4. 考虑错误处理和重试机制

对于大多数场景，推荐使用显式事务管理方案，它提供了最清晰的控制流和最可靠的保证。对于简单场景，可以使用拦截器方案，但需要注意其局限性。