EF Core Shadow Properties

前言

使用 EF Core 想要 DB Table 中有欄位，但不想出現在 Class 中的屬性要怎麼做呢?
例如，要在一個 Customers Table 中新增一個 LastUpdated 的欄位，但不想在 Customer Class 屬性中對應。
這時可以設定為 陰影屬性

實作

Customer 欄位中並沒有 LastUpdated 這個屬性

public class Customer
{
    public int Id { get; set; }

    public string FirstName { get;set; }

    public string LastName { get; set; }

    public string FullName => FirstName+ " " + LastName;
}

在 DbContext 類別中 OnModelCreating Method 設定 Property，

public partial class 你的Context: DbContext
{
    // ... other codes ...
    public virtual DbSet<Customer> Customers { get; set; } = null!;

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity<Customer>(entity =>
        {
            entity.HasKey(e=>e.Id);
            entity.Property<DateTime>("LastUpdated").HasDefaultValue(new DateTime(2020, 4, 9));
        });
    }

}

當更新到 DB 後，Customers 會有一個 LastUpdated 欄位

要取得它的值，需要透過 EF Property 來取得，如下，

var _dbContext = new 你的Context();

//方法1
var customer = _dbContext
    .Customers
    .AsTracking()
    .First();

var lastUpdated = _dbContext.Entry(customer).Property<DateTime>("LastUpdated").CurrentValue;

//方法2
var lastUpdated2 = _dbContext
    .Customers
    .AsNoTracking()
    .Select(c => EF.Property<DateTime>(c, "LastUpdated"))
    .First();

//方法3
var lastUpdated2 = _dbContext
    .Customers
    .Select(c => EF.Property<DateTime>(c, "LastUpdated"))
    .First();

更新欄位值則是設定 CurrentValue

var _dbContext = new 你的Context();

var customer = _dbContext
    .Customers
    .AsTracking()
    .First();

_dbContext.Entry(customer).Property<DateTime>("LastUpdated").CurrentValue = DateTime.Now;

_dbContext.SaveChanges();

參考資源

陰影和索引子屬性