Audit.NET 中如何为审计工作流添加自定义用户信息

在开发基于 Audit.NET 的应用程序时，我们经常需要将当前用户信息记录到审计日志中。本文将详细介绍如何在 Entity Framework 审计工作流中添加自定义用户字段，并确保这些信息被正确记录到审计表中。

核心解决方案

Audit.NET 提供了 AddAuditCustomField() 方法，允许开发者在 Entity Framework 的 DbContext 中添加自定义字段。这些字段会被自动包含在审计事件中，并可根据配置存储到审计表中。

using(var context = new MyEntitites())
{
    context.AddAuditCustomField("UserName", userName);
    context.SaveChanges();
}

实现原理

1. 审计事件扩展：调用 AddAuditCustomField() 会将自定义字段添加到 AuditEventEntityFramework 对象中
2. 数据存储：自定义字段的最终存储方式取决于配置的数据提供程序(Data Provider)
3. 字段访问：在审计实体操作中可以通过事件对象的 CustomFields 字典访问这些值

完整配置示例

对于使用 Entity Framework 数据提供程序的情况，可以在全局配置中设置审计实体操作来访问这些自定义字段：

Audit.Core.Configuration.Setup()
    .UseEntityFramework(x => x
        .UseDbContext<YourDbContext>()
        .AuditTypeMapper(t => typeof(YourAuditEntity))
        .AuditEntityAction((ev, ent, obj) =>
        {
            var userName = ev.CustomFields["UserName"]?.ToString();
            // 将用户名设置到审计实体中
            ((YourAuditEntity)obj).UserName = userName;
        });

实际应用场景

这种方法特别适用于以下场景：

1. Blazor 应用程序：在无法通过 Startup.cs/Program.cs 获取用户信息的架构中
2. 多租户系统：需要记录操作所属租户信息
3. 细粒度审计：需要区分不同用户或角色的操作记录

注意事项

1. 确保在调用 SaveChanges() 之前添加自定义字段
2. 自定义字段名称应保持一致，避免拼写错误
3. 考虑字段值为空的情况，做好空值处理
4. 对于频繁使用的字段，可以创建扩展方法简化调用

通过这种方式，开发者可以灵活地将各种上下文信息纳入审计日志，满足复杂的审计需求。