注意：我使用的是 Entity Framework Core 2.0 (2.0.0-preview2-final)。正式版發布時，功能可能存在變動。

當您設計數據庫時，有時需要添加列以跟蹤記錄何時更改，以及誰進行了更改。例如，您添加以下列：

• CreatedAt

• CreatedBy

• LastUpdatedAt

• LastUpdatedBy

您可以?輕松?地使用默認值和觸發器來處理CreatedAt和LastUpdatedAt列。老實說，創建觸發器是件無聊的事情，你也不想自己做。此外，很難設置用戶名，因為它是應用程序的信息；實際上，在Web程序的上下文中，它們只是連接到數據庫的一個用戶，因此，您無法使用數據庫中CURRENT_USER函數設置跟蹤列的值。

當然，您不想訪問這個屬性。相反，您希望 Entity Framework 為您自動執行，所以，解決的辦法是調用SaveChanges或SaveChangesAsync方法之前自動設置這些屬性的值。在模型中有多種方法處理這些屬性：您可以在模型中添加讀寫（R/W）屬性；您也可以使用只讀（R/O）屬性；還有一種方案，您可以使用陰影（Shadow）屬性。在最后一種方案中，是將列不映射到模型中的屬性，只有 Entity Framework 才知道這些屬性。是的，EF Core 非常靈活:)

我們用 Entity Framework 實現這3種方案！

讀寫屬性

在這種情況下，實體將具有讀/寫屬性。這意味著，您可以在代碼中更改屬性的值。

public interface ITrackable{
?DateTime CreatedAt { get; set; } ?
?string CreatedBy { get; set; }DateTime LastUpdatedAt { get; set; } ?
?
??string LastUpdatedBy { get; set; } }
??public class Post : ITrackable{ ? ?
??public int Id { get; set; } ?
?? ?public string Title { get; set; } ?
?? ??public string Content { get; set; }
?? ??? ?public DateTime CreatedAt { get; set; }
?? ??? ?? ?public string CreatedBy { get; set; } ?
?? ??? ?? ??public DateTime LastUpdatedAt { get; set; } ?
?? ??? ?? ?? ?public string LastUpdatedBy { get; set; } }

現在，我們將更改SaveChanges方法的默認行為來設置跟蹤屬性的值。要小心，有兩個方法要重寫：SaveChanges和異步方法SaveChangesAsync。在代碼中遍歷上下文中跟蹤的實體，并根據狀態設置跟蹤屬性的值。代碼非常簡單：

public class BloggingContext : DbContext{ ?

?public DbSet<Post> Posts { get; set; } ?
?
? ?public override int SaveChanges(bool acceptAllChangesOnSuccess) ? ?{OnBeforeSaving(); ? ?
? ?? ?return base.SaveChanges(acceptAllChangesOnSuccess);}
? ?public override Task<int> SaveChangesAsync(bool acceptAllChangesOnSuccess, CancellationToken cancellationToken = default(CancellationToken)) ? ?{OnBeforeSaving(); ? ? ?
? ? ?return base.SaveChangesAsync(acceptAllChangesOnSuccess, cancellationToken);} ?
? ? ?
? ??private void OnBeforeSaving() ? ?{ ? ? ?
? ?? ?var entries = ChangeTracker.Entries(); ? ? ?
? ?? ? ?foreach (var entry in entries){ ? ? ? ? ?
? ?? ? ??if (entry.Entity is ITrackable trackable){ ? ? ? ? ? ? ?
? ?? ? ???var now = DateTime.UtcNow; ? ? ? ?
? ?? ? ?? ? ? ? ?var user = GetCurrentUser(); ? ? ? ?
? ?? ? ?? ? ? ?switch (entry.State){ ? ? ? ? ? ? ? ?
? ?? ? ?? ? ? ?? ?case EntityState.Modified:trackable.LastUpdatedAt = now;trackable.LastUpdatedBy = user; ? ?
? ?? ? ?? ? ? ?? ?? ? ? ? ? ? ? ? ? ?break; ? ? ?
? ?? ? ?? ? ? ?? ? case EntityState.Added:trackable.CreatedAt = now;trackable.CreatedAt = user;trackable.LastUpdatedAt = now;trackable.LastUpdatedBy = user; ? ? ? ? ? ? ? ? ? ? ? ?break;}}}} ?
? ??
? ???private string GetCurrentUser() ? ?{ ? ?? ?? ? ??
? ?? ? ?? ??return "UserName"; // TODO implement your own logic} }

這個方案有個不容忽視的問題，屬性是可寫的，您不希望在代碼中設置屬性的值。讓我們看看如何使用只讀屬性。

只讀屬性

Entity Framework Core 允許將列映射到字段。這樣，您可以使用只讀屬性，我們來修改?Post類：

public class Post{ ?
?private DateTime _createdAt; ?
? ?private string _createdBy; ?
? ??private DateTime _lastUpdatedAt; ?
? ?? ?private string _lastUpdatedBy; ?
? ?? ? ?public int Id { get; set; }
? ?? ? ?public string Title { get; set; }
? ?? ? ?public string Content { get; set; } ?
? ?? ? ?public DateTime CreatedAt => _createdAt;
? ?? ? ?public string CreatedBy => _createdBy; ?
? ?? ? ?public DateTime LastUpdatedAt => _lastUpdatedAt; ?
? ?? ? ?public string LastUpdatedBy => _lastUpdatedBy; }

上面的代碼有點麻煩，但屬性現在是只讀的。您需要指引 Entity Framework 使用這些字段來設置列的值。

public class BloggingContext : DbContext{ ?

?public DbSet<Post> Posts { get; set; } ?
??protected override void OnModelCreating(ModelBuilder modelBuilder) ? ?{ ? ? ? ?base.OnModelCreating(modelBuilder);modelBuilder.Entity<Post>().Property(post => post.CreatedAt).HasField("_createdAt");modelBuilder.Entity<Post>().Property(post => post.CreatedBy).HasField("_createdBy");modelBuilder.Entity<Post>().Property(post => post.LastUpdatedAt).HasField("_lastUpdatedAt");modelBuilder.Entity<Post>().Property(post => post.LastUpdatedBy).HasField("_lastUpdatedBy");} }

您不能像以前那樣實現OnBeforeSaving方法，因為屬性沒有setter。不過，您可以使用?ChangeTracker來指引 Entity Framework 為屬性設置值。這種方式無需訪問屬性或字段。

? ?private void OnBeforeSaving() ? ?{ ? ?
? ? ? ?var entries = ChangeTracker.Entries(); ? ?
? ? ? ?foreach (var entry in entries){ ? ? ? ?
? ? ? ?? ?if (entry.Entity is Post post){ ? ? ? ? ? ? ?
? ? ? ?? ? ? ?var now = DateTime.UtcNow; ? ? ? ?
? ? ? ?? ? ? ?var user = GetCurrentUser(); ? ? ? ? ?
? ? ? ?? ?? ? ?switch (entry.State){ ? ? ? ? ? ? ? ? ?
? ? ? ?? ?? ? ??case EntityState.Modified:entry.CurrentValues["LastUpdatedAt"] = now;entry.CurrentValues["LastUpdatedBy"] = user; ? ? ? ? ? ? ? ? ? ? ? ?break; ? ? ? ? ? ? ? ?
? ? ? ?? ?? ? ?? ? ?case EntityState.Added:entry.CurrentValues["CreatedAt"] = now;entry.CurrentValues["CreatedBy"] = user;entry.CurrentValues["LastUpdatedAt"] = now;entry.CurrentValues["LastUpdatedBy"] = user; ? ? ? ? ? ? ? ? ? ? ? ?break;}}}} }

我認為應是使用的方式，因為這種方式很清晰。

不定義屬性

在某些情況下，您可能需要設置列的值而不在模型中定義屬性。例如，您可能會公開最后更新的日期，但不會顯示誰做了更改。Entity Framework Core 可以通過使用陰影（Shadow ）屬性來處理這個。陰影屬性在OnModelCreating方法中聲明，但在類中不存在。您可以使用ChangeTracker讀取和寫入陰影屬性的值。

public class Post{ ?
? ??public int Id { get; set; } ?
? ? ?public string Title { get; set; } ?
? ? ?public string Content { get; set; } } public class BloggingContext : DbContext{ ?

?protected override void OnModelCreating(ModelBuilder modelBuilder) ? ?{ ? ? ? ?base.OnModelCreating(modelBuilder); ? ? ?
? ?// Declare propertiesmodelBuilder.Entity<Post>().Property<DateTime>("CreatedAt");modelBuilder.Entity<Post>().Property<string>("CreatedBy");modelBuilder.Entity<Post>().Property<DateTime>("LastUpdatedAt");modelBuilder.Entity<Post>().Property<string>("LastUpdatedBy");} ?
? ?
? ??private void OnBeforeSaving() ? ?{ ? ? ?
? ??var entries = ChangeTracker.Entries(); ? ?
? ??? ?foreach (var entry in entries){ ? ? ?
? ??? ?? ? ?if (entry.Entity is Post post){ ? ? ? ? ? ?
? ??? ?? ? ? ? ?var now = DateTime.UtcNow; ? ? ? ? ? ?
? ?? ?var user = GetCurrentUser(); ? ? ? ?
? ?? ?? ? ? ?switch (entry.State){ ? ? ? ? ? ? ? ? ?
? ?? ?? ? ? ? ?case EntityState.Modified:entry.CurrentValues["LastUpdatedAt"] = now;entry.CurrentValues["LastUpdatedBy"] = user; ? ? ? ? ? ? ? ? ? ? ? ?break; ? ? ? ? ? ? ? ?
? ?? ?? ? ? ? ? ? ?case EntityState.Added:entry.CurrentValues["CreatedAt"] = now;entry.CurrentValues["CreatedBy"] = user;entry.CurrentValues["LastUpdatedAt"] = now;entry.CurrentValues["LastUpdatedBy"] = user; ? ? ? ? ? ? ? ? ? ? ? ?break;}}}} }

總結

使用 Entity Framework Core，您可以根據需求將數據庫表映射到對象模型。這允許創建干凈的類，不需要公開您不想要的屬性。Very nice :)

原文地址：http://www.cnblogs.com/tdfblog/p/entity-framework-core-generate-tracking-columns.html

---

.NET社區新聞，深度好文，微信中搜索dotNET跨平臺或掃描二維碼關注

總結

以上是生活随笔為你收集整理的Entity Framework Core 生成跟踪列的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。