如何用C#实现数据库的审计日志?步骤是什么?

幻夢星雲
发布: 2025-10-18 14:29:01
原创
128人浏览过
通过重写EF的SaveChanges方法实现数据库审计日志,1. 创建AuditLog表存储变更信息;2. 定义AuditLog实体类;3. 在DbContext中利用ChangeTracker捕获增删改操作;4. 使用AuditEntry临时类收集变更数据并转换为日志实体;5. 自动将日志写入数据库。

如何用c#实现数据库的审计日志?步骤是什么?

在C#中实现数据库审计日志,核心是记录数据变更(增、删、改)的时间、操作人、变更内容等信息。常见做法结合实体框架(Entity Framework)的拦截机制,在保存更改前自动捕获变化并写入日志表。以下是具体实现步骤。

1. 设计审计日志表结构

先在数据库中创建用于存储审计信息的表,包含关键字段:

  • Id:主键
  • TableName:被修改的表名
  • RecordId:被修改记录的主键值
  • Action:操作类型(Insert、Update、Delete)
  • ChangedBy:操作用户(如用户名或ID)
  • ChangedAt:操作时间
  • OldValues:修改前的数据(JSON格式)
  • NewValues:修改后的数据(JSON格式)
  • IpAddress:客户端IP(可选)
示例SQL:
CREATE TABLE AuditLog (
    Id INT IDENTITY(1,1) PRIMARY KEY,
    TableName NVARCHAR(100),
    RecordId NVARCHAR(50),
    Action NVARCHAR(10),
    ChangedBy NVARCHAR(100),
    ChangedAt DATETIME2 DEFAULT GETUTCDATE(),
    OldValues NVARCHAR(MAX),
    NewValues NVARCHAR(MAX)
);
登录后复制

2. 创建审计日志实体类

在C#项目中定义与日志表对应的实体类:

public class AuditLog
{
    public int Id { get; set; }
    public string TableName { get; set; }
    public string RecordId { get; set; }
    public string Action { get; set; } // Insert, Update, Delete
    public string ChangedBy { get; set; }
    public DateTime ChangedAt { get; set; }
    public string OldValues { get; set; }
    public string NewValues { get; set; }
}
登录后复制

3. 在DbContext中重写SaveChanges方法

利用EF的ChangeTracker获取所有被修改的实体,并生成审计记录。

在你的DbContext中添加如下代码:

阿里云-虚拟数字人
阿里云-虚拟数字人

阿里云-虚拟数字人是什么? ...

阿里云-虚拟数字人2
查看详情 阿里云-虚拟数字人
public override int SaveChanges()
{
    var auditEntries = OnBeforeSaving("system"); // 可替换为实际用户
    var result = base.SaveChanges();
    OnAfterSaving();
    return result;
}

private List<AuditEntry> OnBeforeSaving(string userId)
{
    var auditEntries = new List<AuditEntry>();
    foreach (var entry in ChangeTracker.Entries())
    {
        if (entry.Entity is AuditLog || entry.State == EntityState.Detached || entry.State == EntityState.Unchanged)
            continue;

        var auditEntry = new AuditEntry(entry)
        {
            TableName = entry.Entity.GetType().Name,
            ChangedBy = userId
        };

        auditEntries.Add(auditEntry);

        foreach (var property in entry.Properties)
        {
            string propertyName = property.Metadata.Name;
            if (property.Metadata.IsPrimaryKey())
            {
                auditEntry.RecordId = property.CurrentValue?.ToString();
                continue;
            }

            switch (entry.State)
            {
                case EntityState.Added:
                    auditEntry.NewValues[propertyName] = property.CurrentValue;
                    break;
                case EntityState.Deleted:
                    auditEntry.OldValues[propertyName] = property.OriginalValue;
                    break;
                case EntityState.Modified:
                    if (property.IsModified)
                    {
                        auditEntry.OldValues[propertyName] = property.OriginalValue;
                        auditEntry.NewValues[propertyName] = property.CurrentValue;
                    }
                    break;
            }
        }
    }

    foreach (var auditEntry in auditEntries)
    {
        AuditLogs.Add(auditEntry.ToAudit());
    }

    return auditEntries;
}

private void OnAfterSaving()
{
    // 可用于清理或异步写入
}
登录后复制

4. 创建临时AuditEntry类辅助处理

用于中间收集变更数据,再转换为AuditLog实体。

public class AuditEntry
{
    public AuditEntry(EntityEntry entry)
    {
        Entry = entry;
        OldValues = new Dictionary<string, object>();
        NewValues = new Dictionary<string, object>();
    }

    public EntityEntry Entry { get; }
    public string TableName { get; set; }
    public string RecordId { get; set; }
    public string Action { get; set; }
    public string ChangedBy { get; set; }
    public Dictionary<string, object> OldValues { get; } = new();
    public Dictionary<string, object> NewValues { get; } = new();

    public AuditLog ToAudit()
    {
        var jsonSerializerOptions = new JsonSerializerOptions { WriteIndented = true };
        return new AuditLog
        {
            TableName = TableName,
            RecordId = RecordId,
            Action = Entry.State.ToString(),
            ChangedBy = ChangedBy,
            ChangedAt = DateTime.UtcNow,
            OldValues = OldValues.Count != 0 ? JsonSerializer.Serialize(OldValues, jsonSerializerOptions) : null,
            NewValues = NewValues.Count != 0 ? JsonSerializer.Serialize(NewValues, jsonSerializerOptions) : null
        };
    }
}
登录后复制

5. 注册DbSet和迁移

确保在DbContext中添加:

public DbSet<AuditLog> AuditLogs { get; set; }
登录后复制

然后使用EF Core命令添加迁移并更新数据库:

dotnet ef migrations add AddAuditLogTable
dotnet ef database update
登录后复制
基本上就这些。只要调用SaveChanges(),所有变更都会自动记录到审计表中。你可以进一步扩展支持异步保存、过滤特定实体、记录IP地址等。关键是利用ChangeTracker和重写SaveChanges的时机。

以上就是如何用C#实现数据库的审计日志?步骤是什么?的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习
PHP中文网抖音号
发现有趣的

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号