Entity Framework Core 捕獲資料庫變動
一起養成寫作習慣！這是我參與「掘金日新計劃 · 4 月更文挑戰」的第21天，點選檢視活動詳情。
在實際專案中我們往往需要記錄儲存在資料庫中資料的變動（例如修改資料前記錄下資料的原始值），這樣一來在發生誤操作時可以將資料恢復到變動前的狀態，也可以追溯到資料的修改人。大部分開發人員會自己定義記錄資料變動的程式碼，但是這樣不僅費時費力有時還會影響到這個業務的效能。當然，我們也可以利用資料庫觸發器來記錄這些操作，在 SQL Server 資料庫 2017 以上版本中給我們提供了跟蹤資料庫資料更改的功能，利用這個功能可以準確的記錄資料庫資料的變動。這個功能雖然強大但是某些時候我們使用的資料庫並不是 SQL Server 資料庫，或者某些情況下我們不適合使用 SQL Server 資料庫所提供的這個功能。那麼這個時候該怎麼辦呢？如果你使用的是 Entity Framework Core 2.0 及以上版本來開發專案的話，那這個問題就好解決了。在 Entity Framework Core 中，只要捕獲到了資料變更記錄，我們就可以將資料隨時還原到變更前的狀態，在這裡資料庫變更記錄被稱為審計資料。那麼我們先來看兩個問題： 1. 審計資料是在什麼時候產生並寫入資料庫的呢？ 2. 資料的新舊值是如何獲取到的呢？ 要解答上述兩個問題，那就跟著我一起來看看怎麼利用 Entity Framework Core 來捕獲審計資料。
零、建立審計模型
捕獲審計資料並存入資料庫的第一步是建立審計模型，只有具有了審計模型的審計資料才能正確的存入資料庫。
csharp
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 ，其中操作型別包含了增刪改。
一、建立審計資料儲存
現在我們有了審計模型，但是隻有審計模型還不行，我們還需要建立和儲存審計資料相關的類，下面我們就來一起建立這個類。
csharp
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
{
TableName = TableName,
Operation = Operation,
DateTime = 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 列表。
csharp
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屬性來獲取舊值和新值並儲存。上述程式碼理解起來比較簡單，適用於大部分情況，可以直接放在專案中使用。