EFCore.AuditLogging 1.0.8

EFCore.AuditLogging

Entity Framework Core 审计日志记录库，用于追踪实体的增删改操作。

快速开始

步骤 1：实现审计日志实体接口

你需要创建两个实体类来实现审计日志接口：

using EFCore.AuditLogging;

// 审计日志主表
public class EfAuditLog : IEfAuditLog
{
    public Guid Id { get; set; }
    public string EntityId { get; set; } = string.Empty;
    public string EntityName { get; set; } = string.Empty;
    public string? UserId { get; set; }
    public ActionType ActionType { get; set; }
    public DateTime CreatOn { get; set; }
}

// 审计日志变更详情表
public class EfAuditLogChange : IEfAuditLogChange
{
    public Guid Id { get; set; }
    public Guid EfAuditLogId { get; set; }
    public string FieldName { get; set; } = string.Empty;
    public string? OldValue { get; set; }
    public string? NewValue { get; set; }
}

步骤 2：实现用户标识接口

using EFCore.AuditLogging;

// 包会自动注入实现了IAuditUser的类
public class AuditUser : IAuditUser
{
    public Task<string?> ObtainCurrentUserIdAsync(CancellationToken cancellationToken = default)
    {
        // 从当前上下文获取用户ID
        // 示例：从 HttpContext、ClaimsPrincipal 等获取
        return Task.FromResult("user-id");
    }
}

步骤 3：注册服务

在 Program.cs 或 Startup.cs 中注册服务：

var builder = WebApplication.CreateBuilder(args);

// 注册审计日志服务
builder.Services.AddEfAuditLogger<EfAuditLog, EfAuditLogChange>(new EfAuditLoggerOptions
{
    Enabled = true,
    ExcludedEntities = [], // 可选：排除不需要审计的实体
    RecordFullValues = false // 可选：是否记录完整的新值和旧值
});

var app = builder.Build();

步骤 4：在保存时调用审计日志

在你的 DbContext 中重写 SaveChanges 和 SaveChangesAsync 方法，调用 AuditLoggingInsert()：

using Microsoft.EntityFrameworkCore;

public class YourDbContext : DbContext
{
    private readonly EfAuditLoggingInserter<EfAuditLog, EfAuditLogChange> _auditLogger;

    public YourDbContext(DbContextOptions<YourDbContext> options, 
        EfAuditLoggingInserter<EfAuditLog, EfAuditLogChange> auditLogger) 
        : base(options)
    {
        _auditLogger = auditLogger;
    }

    public override int SaveChanges()
    {
        // 调用审计日志插入方法
        _auditLogger.AuditLoggingInsert();
        return base.SaveChanges();
    }

    public override Task<int> SaveChangesAsync(CancellationToken cancellationToken = default)
    {
        // 调用审计日志插入方法
        _auditLogger.AuditLoggingInsert();
        return base.SaveChangesAsync(cancellationToken);
    }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity<EfAuditLog>(entity =>
        {
            entity.HasKey(e => e.Id);
            entity.Property(e => e.EntityId).IsRequired();
            entity.Property(e => e.EntityName).IsRequired();
        });

        modelBuilder.Entity<EfAuditLogChange>(entity =>
        {
            entity.HasKey(e => e.Id);
            entity.Property(e => e.FieldName).IsRequired();
        });

        base.OnModelCreating(modelBuilder);
    }
}

配置选项

EfAuditLoggerOptions 提供以下配置选项：

审计日志数据结构

EfAuditLog 表（主表）

EfAuditLogChange 表（变更详情表）

使用示例

排除特定实体

builder.Services.AddEfAuditLogger<EfAuditLog, EfAuditLogChange>(new EfAuditLoggerOptions
{
    ExcludedEntities = new[] { typeof(Log), typeof(AuditLog) }
});

查询审计日志

// 查询某个实体的审计日志
var logs = await context.Set<EfAuditLog>()
    .Where(l => l.EntityName == "User" && l.EntityId == "123")
    .OrderByDescending(l => l.CreatOn)
    .ToListAsync();

// 查询某个审计日志的详细变更
var changes = await context.Set<EfAuditLogChange>()
    .Where(c => c.EfAuditLogId == logId)
    .ToListAsync();

技术细节

• 基于 EF Core 的 SaveChanges 拦截机制
• 使用 ChangeTracker 监听实体状态变化
• 支持异步和同步保存操作
• 自动捕获 Added（新增）、Modified（修改）、Deleted（删除）三种操作

要求

• .NET 8.0+
• Entity Framework Core 8.0.6+

安装

通过 NuGet 包管理器安装：

Install-Package EFCore.AuditLogging

或使用 .NET CLI：

dotnet add package EFCore.AuditLogging