Audit.NET 中实现外键变更时记录关联实体字段的审计日志方案

背景介绍

在企业级应用开发中，审计日志是确保数据可追溯性的重要组成部分。当使用 Entity Framework 进行数据操作时，Audit.NET 是一个强大的审计日志记录库，它能够自动跟踪数据变更。然而，在处理外键关系时，直接记录外键ID往往缺乏业务含义，我们需要记录更具可读性的关联实体字段。

问题分析

假设我们有一个学生管理系统，包含 Student 和 Course 两个实体。Student 实体通过 CourseId 外键关联到 Course 实体。当学生更换课程时，审计日志默认只记录 CourseId 的变化，而业务上我们更关心的是课程名称(CourseName)的变化。

解决方案

1. 基础实体定义

首先定义我们的数据模型：

public class Student
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Address { get; set; }
    public int CourseId { get; set; }
    
    [ForeignKey("CourseId")]
    [InverseProperty("Students")]
    public virtual Course Course { get; set; }
}

public class Course
{
    public int Id { get; set; }
    public string CourseName { get; set; }
    public string Description { get; set; }
    
    [InverseProperty("Course")]
    public virtual ICollection<Student> Students { get; set; }
}

2. 审计日志模型

定义审计日志存储结构：

[AuditIgnore]
public class AuditLog
{
    [Key]
    public int AuditId { get; set; }
    public string TableName { get; set; }
    public List<AuditChanges> Changes { get; set; }
    public int PrimaryKey { get; set; }
    public DateTime ModifiedOn { get; set; }
    public int ModifiedById { get; set; }
}

public class AuditChanges
{
    public string ColumnName { get; set; }
    public object OriginalValue { get; set; }
    public object NewValue { get; set; }
}

3. 高级审计配置

关键点在于自定义审计实体动作，在记录外键变更时同时记录关联实体的业务字段：

Audit.Core.Configuration.Setup()
    .UseEntityFramework(ef => ef
        .AuditTypeExplicitMapper(m => m
            .Map<Student>(m => m.Action == "Update" ? typeof(AuditLog) : null)
            .AuditEntityAction<AuditLog>((ev, entry, auditLog) =>
            {
                auditLog.TableName = entry.Table;
                auditLog.ModifiedOn = DateTime.Now;
                auditLog.ModifiedById = 1;
                auditLog.PrimaryKey = (int)entry.PrimaryKey.First().Value;
                
                // 记录标准字段变更
                auditLog.Changes = entry.Changes.Select(ch => new AuditChanges
                {
                    ColumnName = ch.ColumnName,
                    OriginalValue = ch.OriginalValue,
                    NewValue = ch.NewValue
                }).ToList();

                // 特殊处理外键字段，添加关联实体信息
                if (entry.Changes.Any(c => c.ColumnName == "CourseId"))
                {
                    var student = entry.GetEntry().Entity as Student;
                    if (student?.Course != null)
                    {
                        auditLog.Changes.Add(new AuditChanges
                        {
                            ColumnName = "CourseName",
                            NewValue = student.Course.CourseName
                            // 如果需要原值，可以在此查询数据库获取
                        });
                    }
                }
            }));

实现原理

1. 变更检测：Audit.NET 会自动检测实体属性的变更，包括外键字段
2. 自定义映射：通过 AuditEntityAction 我们可以自定义审计记录的内容
3. 关联实体访问：当外键变更时，我们可以访问导航属性获取关联实体的业务字段
4. 扩展记录：在标准变更记录基础上，添加业务意义的字段信息

注意事项

1. 性能考虑：访问导航属性时确保关联实体已加载，否则可能导致额外数据库查询
2. 历史值处理：如果需要记录变更前的关联实体信息，需要额外查询数据库
3. 事务一致性：确保审计日志记录与业务操作在同一事务中
4. 字段命名：建议使用明确的字段命名区分原始外键和业务字段

扩展思考

这种模式可以推广到各种外键关系场景，如：

• 用户变更时记录用户名而非用户ID
• 部门变更时记录部门名称而非部门编号
• 产品变更时记录产品名称而非产品ID

通过这种增强型审计日志，业务人员可以更直观地理解数据变更历史，提高系统的可维护性和可审计性。