本文翻譯自《Entity Framework Core: Generate tracking columns》，由于水平有限，故無法保證翻譯完全正確，歡迎指出錯(cuò)誤。謝謝！

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

當(dāng)您設(shè)計(jì)數(shù)據(jù)庫時(shí)，有時(shí)需要添加列以跟蹤記錄何時(shí)更改，以及誰進(jìn)行了更改。例如，您添加以下列：

  • CreatedAt

  • CreatedBy

  • LastUpdatedAt

  • LastUpdatedBy

您可以 輕松 地使用默認(rèn)值和觸發(fā)器來處理CreatedAt和LastUpdatedAt列。老實(shí)說，創(chuàng)建觸發(fā)器是件無聊的事情，你也不想自己做。此外，很難設(shè)置用戶名，因?yàn)樗菓?yīng)用程序的信息；實(shí)際上，在Web程序的上下文中，它們只是連接到數(shù)據(jù)庫的一個(gè)用戶，因此，您無法使用數(shù)據(jù)庫中CURRENT_USER函數(shù)設(shè)置跟蹤列的值。

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

我們用 Entity Framework 實(shí)現(xiàn)這3種方案！

讀寫屬性

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

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

現(xiàn)在，我們將更改SaveChanges方法的默認(rèn)行為來設(shè)置跟蹤屬性的值。要小心，有兩個(gè)方法要重寫：SaveChanges和異步方法SaveChangesAsync。在代碼中遍歷上下文中跟蹤的實(shí)體，并根據(jù)狀態(tài)設(shè)置跟蹤屬性的值。代碼非常簡(jiǎn)單：

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

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

只讀屬性

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

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

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

您不能像以前那樣實(shí)現(xiàn)OnBeforeSaving方法，因?yàn)閷傩詻]有setter。不過，您可以使用 ChangeTracker來指引 Entity Framework 為屬性設(shè)置值。這種方式無需訪問屬性或字段。

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

我認(rèn)為應(yīng)是使用的方式，因?yàn)檫@種方式很清晰。

不定義屬性

在某些情況下，您可能需要設(shè)置列的值而不在模型中定義屬性。例如，您可能會(huì)公開最后更新的日期，但不會(huì)顯示誰做了更改。Entity Framework Core 可以通過使用陰影（Shadow ）屬性來處理這個(gè)。陰影屬性在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 properties
        modelBuilder.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;
                }
            }
        }
    }
}

總結(jié)

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

轉(zhuǎn)載請(qǐng)注明出處，原文鏈接：http://www.cnblogs.com/tdfblog/p/entity-framework-core-generate-tracking-columns.html。

如果您覺得閱讀本文對(duì)您有幫助，請(qǐng)點(diǎn)一下“推薦”按鈕，您的“推薦”將是我最大的寫作動(dòng)力！

歡迎各位轉(zhuǎn)載，轉(zhuǎn)載文章之后必須在文章頁面明顯位置給出作者和原文連接。

分類: Entity Framework Core

http://www.cnblogs.com/tdfblog/p/entity-framework-core-generate-tracking-columns.html