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

- 審計(jì)數(shù)據(jù)是在什么時(shí)候產(chǎn)生并寫(xiě)入數(shù)據(jù)庫(kù)的呢?
- 數(shù)據(jù)的新舊值是如何獲取到的呢? 要解答上述兩個(gè)問(wèn)題,那就跟著我一起來(lái)看看怎么利用 Entity Framework Core 來(lái)捕獲審計(jì)數(shù)據(jù)。
一、創(chuàng)建審計(jì)模型
捕獲審計(jì)數(shù)據(jù)并存入數(shù)據(jù)庫(kù)的第一步是創(chuàng)建審計(jì)模型,只有具有了審計(jì)模型的審計(jì)數(shù)據(jù)才能正確的存入數(shù)據(jù)庫(kù)。
- 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; }
- ///
- /// 操作后的數(shù)據(jù)
- ///
- public string New { get; set; }
- }
- ///
- /// 操作類(lèi)型
- ///
- public enum Operation
- {
- Add = 0,
- Delete = 1,
- Modified = 2
- }
上述代碼創(chuàng)建的審計(jì)模型包含被操作表的名稱(chēng) TableName 、操作的類(lèi)型 Operation 、被操作數(shù)據(jù)的主鍵 Key 、 操作前的數(shù)據(jù) Old 以及操作后的數(shù)據(jù) New ,其中操作類(lèi)型包含了增刪改。
二、創(chuàng)建審計(jì)數(shù)據(jù)存儲(chǔ)
現(xiàn)在我們有了審計(jì)模型,但是只有審計(jì)模型還不行,我們還需要?jiǎng)?chuàng)建和存儲(chǔ)審計(jì)數(shù)據(jù)相關(guān)的類(lèi),下面我們就來(lái)一起創(chuàng)建這個(gè)類(lèi)。
- 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
keys { get; } = new Dictionary (); - public Dictionary
olds { get; } = new Dictionary (); - public Dictionary
news { get; } = new Dictionary (); - public List
propertyEntries { get; } = new List (); - 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;
- }
- }
這個(gè)類(lèi)主要是用于存儲(chǔ)表名稱(chēng),被操作數(shù)據(jù)的主鍵Id,被操作前的數(shù)據(jù)和被操作后的數(shù)據(jù)。在上面的代碼中我們看到我們將被操作數(shù)據(jù)的主鍵Id、被操作前的數(shù)據(jù)和被操作后的數(shù)據(jù)的變量都定義成了字典類(lèi)型,這是因?yàn)槲覀兊某绦蛑杏锌赡艹霈F(xiàn)批量操作的問(wèn)題。 在將上述信息轉(zhuǎn)換成 Audit 時(shí)提示我們對(duì)被操作前的數(shù)據(jù)和被操作后的數(shù)據(jù)進(jìn)行了一個(gè)長(zhǎng)度判斷,這是因?yàn)楫?dāng)我們新增數(shù)據(jù)的時(shí)候是沒(méi)有舊數(shù)據(jù)的,當(dāng)我們對(duì)數(shù)據(jù)沒(méi)有進(jìn)行任何更改就提交數(shù)據(jù)的時(shí)候是不存在新數(shù)據(jù)的。
三、重寫(xiě) SaveChanges
這個(gè)例子重寫(xiě)的是 SaveChanges ,對(duì)于 SaveChangesAsync 同樣適用。我們需要在 OnBeforSaveBehavior 方法中創(chuàng)建 AuditDb 列表。
- public class EFContext : DbContext
- {
- public override int SaveChanges(bool acceptAllChangesOnSuccess)
- {
- List
auditDbs = OnBeforeSaveBehavior(); - var result = base.SaveChanges(acceptAllChangesOnSuccess);
- return result;
- }
- List
OnBeforeSaveBehavior() - {
- ChangeTracker.DetectChanges();
- List
auditDbs = new List (); - 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
audits = new List (); - foreach (var item in auditDbs.Where(p => !p.HasPropertyEntries))
- {
- audits.Add(item.ToAudit());
- }
- return auditDbs.Where(p => p.HasPropertyEntries).ToList();
- }
- }
到目前為止,捕獲審計(jì)數(shù)據(jù)的所有代碼已經(jīng)完成,這里需要注意的一點(diǎn)是部分實(shí)體屬性是由數(shù)據(jù)庫(kù)生成的,例如當(dāng)前日期、Id等,這些值需要等待 SaveChanges 方法執(zhí)行完畢后方可獲得,也就是說(shuō)在這種情況下保存審計(jì)數(shù)據(jù)必須在 SaveChanges 方法之后。
四、總結(jié)
通過(guò)前面的代碼示例和講解,我們就可以解答前面提出的兩個(gè)問(wèn)題了,除了部分?jǐn)?shù)據(jù)是由數(shù)據(jù)庫(kù)自動(dòng)生成的情況下,大部分情況下在調(diào)用SaveChanges方法之前,我們通過(guò)上下文中的ChangeTracker屬性來(lái)獲取舊值和新值并保存。上述代碼理解起來(lái)比較簡(jiǎn)單,適用于大部分情況,可以直接放在項(xiàng)目中使用。
作者簡(jiǎn)介:
朱鋼,筆名喵叔,國(guó)內(nèi)某技術(shù)博客認(rèn)證專(zhuān)家,.NET高級(jí)開(kāi)發(fā)工程師,7年一線(xiàn)開(kāi)發(fā)經(jīng)驗(yàn),參與過(guò)電子政務(wù)系統(tǒng)和AI客服系統(tǒng)的開(kāi)發(fā),以及互聯(lián)網(wǎng)招聘網(wǎng)站的架構(gòu)設(shè)計(jì),目前就職于一家初創(chuàng)公司,從事企業(yè)級(jí)安全監(jiān)控系統(tǒng)的開(kāi)發(fā)。
【原創(chuàng)稿件,合作站點(diǎn)轉(zhuǎn)載請(qǐng)注明原文作者和出處為.com】
當(dāng)前文章:如何用Entity Framework Core捕獲審計(jì)數(shù)據(jù)
文章網(wǎng)址:http://m.fisionsoft.com.cn/article/cdhiesh.html


咨詢(xún)
建站咨詢(xún)
