如何用Entity Framework Core捕獲審計數據

作者：朱鋼 2019-11-13 15:40:00

在 Entity Framework Core 中，只要捕獲到了數據變更記錄，我們就可以將數據隨時還原到變更前的狀態，在這里數據庫變更記錄被稱為審計數據。

【51CTO.com原創稿件】在實際項目中，我們往往需要記錄存儲在數據庫中數據的變動（例如修改數據前記錄下數據的原始值），這樣一來在發生誤操作時可以將數據恢復到變動前的狀態，也可以追溯到數據的修改人。大部分開發人員會自己定義記錄數據變動的代碼，但是這樣不僅費時費力有時還會影響到這個業務的性能。當然，我們也可以利用數據庫觸發器來記錄這些操作，在 SQL Server 數據庫 2017 以上版本中給我們提供了跟蹤數據庫數據更改的功能，利用這個功能可以準確的記錄數據庫數據的變動。這個功能雖然強大但是某些時候我們使用的數據庫并不是 SQL Server 數據庫，或者某些情況下我們不適合使用 SQL Server 數據庫所提供的這個功能。那么這個時候該怎么辦呢？如果你使用的是 Entity Framework Core 2.0 及以上版本來開發項目的話，那這個問題就好解決了。在 Entity Framework Core 中，只要捕獲到了數據變更記錄，我們就可以將數據隨時還原到變更前的狀態，在這里數據庫變更記錄被稱為審計數據。那么我們先來看兩個問題：

審計數據是在什么時候產生并寫入數據庫的呢？
數據的新舊值是如何獲取到的呢？要解答上述兩個問題，那就跟著我一起來看看怎么利用 Entity Framework Core 來捕獲審計數據。

一、創建審計模型

捕獲審計數據并存入數據庫的第一步是創建審計模型，只有具有了審計模型的審計數據才能正確的存入數據庫。

public class Audit 
{ 
    public int Id { get; set; } 
    public string TableName { get; set; } 
    public DateTime DateTime { get; set; } 
    [NotMapped] 
    public Operation Operation { get; set; } 
    public string OperationString 
    { 
        get { return Operation.ToString(); } 
        private set { Operation = (Operation)Enum.Parse(typeof(Operation), value, true); } 
    } 
    public string Key { get; set; } 
    public string Old { get; set; } 
    /// <summary> 
    /// 操作后的數據 
    /// </summary> 
    public string New { get; set; } 
} 
/// <summary> 
/// 操作類型 
/// </summary> 
public enum Operation 
{ 
    Add = 0, 
    Delete = 1, 
    Modified = 2 
}

上述代碼創建的審計模型包含被操作表的名稱 TableName 、操作的類型 Operation 、被操作數據的主鍵 Key 、操作前的數據 Old 以及操作后的數據 New ，其中操作類型包含了增刪改。

二、創建審計數據存儲

現在我們有了審計模型，但是只有審計模型還不行，我們還需要創建和存儲審計數據相關的類，下面我們就來一起創建這個類。

public class AuditDb 
{ 
    public EntityEntry _entityEntry { get; set; } 
    public AuditDb(EntityEntry entityEntry) 
    { 
        this._entityEntry = entityEntry; 
    } 
    public string TableName { get; set; } 
    public Operation Operation { get; set; } 
    public Dictionary<string, object> keys { get; } = new Dictionary<string, object>(); 
    public Dictionary<string, object> olds { get; } = new Dictionary<string, object>(); 
    public Dictionary<string, object> news { get; } = new Dictionary<string, object>(); 
    public List<PropertyEntry> propertyEntries { get; } = new List<PropertyEntry>(); 
    public bool HasPropertyEntries => propertyEntries.Any(); 
    public Audit ToAudit() 
    { 
        Audit audit = new Audit 
        { 
            TableNameTableName = TableName, 
            OperationOperation = Operation, 
            DateTimeDateTime = DateTime.Now, 
            Key = JsonConvert.SerializeObject(keys), 
            Old = olds.Count == 0 ? null : JsonConvert.SerializeObject(olds), 
            New = news.Count == 0 ? null : JsonConvert.SerializeObject(news) 
        }; 
        return audit; 
    } 
}

這個類主要是用于存儲表名稱，被操作數據的主鍵Id，被操作前的數據和被操作后的數據。在上面的代碼中我們看到我們將被操作數據的主鍵Id、被操作前的數據和被操作后的數據的變量都定義成了字典類型，這是因為我們的程序中有可能出現批量操作的問題。在將上述信息轉換成 Audit 時提示我們對被操作前的數據和被操作后的數據進行了一個長度判斷，這是因為當我們新增數據的時候是沒有舊數據的，當我們對數據沒有進行任何更改就提交數據的時候是不存在新數據的。

三、重寫 SaveChanges

這個例子重寫的是 SaveChanges ，對于 SaveChangesAsync 同樣適用。我們需要在 OnBeforSaveBehavior 方法中創建 AuditDb 列表。

public class EFContext : DbContext 
{ 
    public override int SaveChanges(bool acceptAllChangesOnSuccess) 
    { 
        List<AuditDb> auditDbs = OnBeforeSaveBehavior(); 
        var result = base.SaveChanges(acceptAllChangesOnSuccess); 
        return result; 
    } 
    List<AuditDb> OnBeforeSaveBehavior() 
    { 
        ChangeTracker.DetectChanges(); 
        List<AuditDb> auditDbs = new List<AuditDb>(); 
        foreach (EntityEntry entity in ChangeTracker.Entries()) 
        { 
            if (entity.Entity is Audit || entity.State == EntityState.Detached || entity.State == EntityState.Unchanged) 
            { 
                continue; 
            } 
            AuditDb auditDb = new AuditDb(entity) 
            { 
                TableName = entity.Metadata.Name 
            }; 
            auditDbs.Add(auditDb); 
            foreach (var property in entity.Properties) 
            { 
                if (property.IsTemporary) 
                { 
                    auditDb.propertyEntries.Add(property); 
                    continue; 
                } 
                var propertName = property.Metadata.Name; 
                if (property.Metadata.IsPrimaryKey()) 
                { 
                    auditDb.keys[propertName] = property.CurrentValue; 
                    continue; 
                } 
                switch (entity.State) 
                { 
                    case EntityState.Deleted: 
                        auditDb.Operation = Operation.Delete; 
                        auditDb.olds[propertName] = property.OriginalValue; 
                        break; 
                    case EntityState.Modified: 
                        if (property.IsModified) 
                        { 
                            auditDb.Operation = Operation.Modified; 
                            auditDb.olds[propertName] = property.OriginalValue; 
                            auditDb.news[propertName] = property.CurrentValue; 
                        } 
                        break; 
                    case EntityState.Added: 
                        auditDb.Operation = Operation.Add; 
                        auditDb.news[propertName] = property.CurrentValue; 
                        break; 
                } 
            } 
        } 
        List<Audit> audits = new List<Audit>(); 
        foreach (var item in auditDbs.Where(p => !p.HasPropertyEntries)) 
        { 
            audits.Add(item.ToAudit()); 
        } 
        return auditDbs.Where(p => p.HasPropertyEntries).ToList(); 
    } 
}

到目前為止，捕獲審計數據的所有代碼已經完成，這里需要注意的一點是部分實體屬性是由數據庫生成的，例如當前日期、Id等，這些值需要等待 SaveChanges 方法執行完畢后方可獲得，也就是說在這種情況下保存審計數據必須在 SaveChanges 方法之后。

四、總結

通過前面的代碼示例和講解，我們就可以解答前面提出的兩個問題了，除了部分數據是由數據庫自動生成的情況下，大部分情況下在調用SaveChanges方法之前，我們通過上下文中的ChangeTracker屬性來獲取舊值和新值并保存。上述代碼理解起來比較簡單，適用于大部分情況，可以直接放在項目中使用。

作者簡介：

朱鋼，筆名喵叔，國內某技術博客認證專家，.NET高級開發工程師，7年一線開發經驗，參與過電子政務系統和AI客服系統的開發，以及互聯網招聘網站的架構設計，目前就職于一家初創公司，從事企業級安全監控系統的開發。

【51CTO原創稿件，合作站點轉載請注明原文作者和出處為51CTO.com】

責任編輯：龐桂玉來源： 51CTO