[[282224]]

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

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

一、創(chuàng)建審計模型

捕獲審計數(shù)據(jù)并存入數(shù)據(jù)庫的第一步是創(chuàng)建審計模型，只有具有了審計模型的審計數(shù)據(jù)才能正確的存入數(shù)據(jù)庫。

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> 
    /// 操作后的數(shù)據(jù) 
    /// </summary> 
    public string New { get; set; } 
} 
/// <summary> 
/// 操作類型 
/// </summary> 
public enum Operation 
{ 
    Add = 0, 
    Delete = 1, 
    Modified = 2 
} 

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

二、創(chuàng)建審計數(shù)據(jù)存儲

現(xiàn)在我們有了審計模型，但是只有審計模型還不行，我們還需要創(chuàng)建和存儲審計數(shù)據(jù)相關(guān)的類，下面我們就來一起創(chuàng)建這個類。

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; 
    } 
} 

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

三、重寫 SaveChanges

這個例子重寫的是 SaveChanges ，對于 SaveChangesAsync 同樣適用。我們需要在 OnBeforSaveBehavior 方法中創(chuàng)建 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(); 
    } 
} 

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

四、總結(jié)

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

作者簡介： 

朱鋼，筆名喵叔，國內(nèi)某技術(shù)博客認(rèn)證專家，.NET高級開發(fā)工程師，7年一線開發(fā)經(jīng)驗，參與過電子政務(wù)系統(tǒng)和AI客服系統(tǒng)的開發(fā)，以及互聯(lián)網(wǎng)招聘網(wǎng)站的架構(gòu)設(shè)計，目前就職于一家初創(chuàng)公司，從事企業(yè)級安全監(jiān)控系統(tǒng)的開發(fā)。

【51CTO原創(chuàng)稿件，合作站點轉(zhuǎn)載請注明原文作者和出處為51CTO.com】