EF7建立模型值生成篇

YataoFeng發表於2023-03-07
模型

在 EF7 中，生成的值是非常重要的，因為它們決定了資料庫表中的資料。在本文中，我們將以人員為例，使用 Fluent API 展示所有 EF7 生成值的功能。
我們先來看一下人員表的屬性：

public class Person
{
    public Guid Id { get; set; }
    public string Name { get; set; }
    public int NameLength { get; set; }
    public int Age { get; set; }
    public DateTime Birthday { get; set; }
    public DateTime CreationTime { get; set; }
    public DateTime LastUpdated { get; set; }
}

在EF7中，我們可以使用Fluent API來配置表的屬性。下面，我們將展示所有生成值的功能，並提供相應的程式碼示例。

預設值

預設值是指當實體物件的屬性沒有設定值時，將使用的值。使用 HasDefaultValue 方法設定預設值：

builder.Property(p => p.CreationTime).HasDefaultValue(DateTime.Now);

還可以使用 SQL 表示式為屬性指定一個預設值：

builder.Property(e => e.CreationTime).HasDefaultValueSql("getdate()");

計算列

計算列是指在資料庫中建立的一列，該列的值是由一系列計算表示式生成的。在 EF7 中，我們可以使用 HasComputedColumnSql 方法來建立計算列。例如，我們要將 Person 實體的 FullName 屬性設定為由 FirstName 和 LastName 屬性計算得出的值：

builder.Property(p => p.FullName)
    .HasComputedColumnSql("[FirstName] + ' ' + [LastName]");

HasComputedColumnSql 方法還有一個 stored 引數，當指定為 true 時，EF7 將在資料庫中建立一個儲存的計算列。這在插入新記錄時，計算列的值將由資料庫計算並儲存在該列中，而不是每次查詢時重新計算。以下程式碼將 Age 和 NameLength 屬性設定為儲存的計算列：

builder.Property(e => e.Age)
    .HasComputedColumnSql("[CreationTime].[Year] - [Birthday].[Year]", stored: true);

builder.Property(p => p.NameLength)
    .HasComputedColumnSql("LEN([LastName]) + LEN([FirstName])", stored: true);

顯示配置值生成

顯示配置值生成是指在 EF7 中明確指定生成的值。在 EF7 中，我們可以使用 ValueGeneratedOnAdd 方法允許我們指定屬性的值在插入新記錄時自動生成。例如，我們可以使用以下程式碼為 id 屬性指定自增值：

builder.Property(p => p.Id).ValueGeneratedOnAdd();

有些需求是修改，我們可以使用 ValueGeneratedOnAddOrUpdate 方法允許我們指定屬性的值在插入或更新記錄時自動生成。例如，我們可以使用以下程式碼為 LastUpdated 屬性指定預設值，並在插入或更新記錄時自動生成 LastUpdated 的值：

builder.Property(e => e.LastUpdated).HasDefaultValueSql("getdate()")
    .ValueGeneratedOnAddOrUpdate();

自定義值生成

在某些情況下，我們可能希望在插入新記錄時使用自定義的值生成策略。

builder.Property(p => p.Id)
    .HasValueGenerator<GuidValueGenerator>(); // 使用自定義的值生成器

public class GuidValueGenerator : ValueGenerator<Guid>
{
    public override bool GeneratesTemporaryValues => false;
    public override Guid Next(EntityEntry entry)
    {
        return Guid.NewGuid(); // 生成Guid值
    }
}

一般來說，EF資料庫提供程式已經幫我們實現好了Guid的演算法。使用顯示值生成就可以，不需要自定義。
見這篇文章：《EF7資料庫提供者的自定義值生成器》

替代值生成

在 EF7 中，當我們向資料庫中插入一條新記錄或更新現有記錄時，如果某些屬性的值未設定，則 EF7 會根據其配置生成預設值。然而，有時候我們可能希望在儲存更改後保留屬性的當前值而不是使用預設值，或者在屬性的值未設定時丟擲異常。
PropertySaveBehavior 列舉表示屬性在儲存更改時的行為。它有以下三個狀態：

  1. Save：屬性值應該被保留。
  2. Ignore：屬性值應該被忽略。
  3. Throw：如果屬性值未設定，則應該丟擲異常。

SetAfterSaveBehavior儲存更改前、SetBeforeSaveBehavior儲存更改後，方法允許我們為特定屬性設定這些行為。
例如，我們可以使用以下程式碼為 LastUpdated 屬性，雖然指定預設值是當前修改時間。但在儲存更改前，未設定預設值，則丟擲異常，而不會使用預設值：

builder.Property(b => b.LastUpdated).HasDefaultValue(DateTime.Now)
        .ValueGeneratedOnAddOrUpdate()
        .Metadata.SetAfterSaveBehavior(PropertySaveBehavior.Throw);

無值生成

無值生成是指在 EF7 中不生成任何值。在 EF7 中，我們可以使用 ValueGeneratedNever 方法來設定無值生成。例如，我們要將 Person 實體的 Email 屬性設定為不生成任何值：

builder.Property(p => p.Email).ValueGeneratedNever();

總結

在本文中，我們介紹了 EF7 中可用的各種生成值選項，並以人員為例演示瞭如何使用 Fluent API 配置這些選項。使用生成值選項可以使我們更方便地處理資料庫相關任務。例如，我們可以使用預設值、計算列和自動生成值等選項來簡化我們的程式碼，提高程式碼的可讀性和可維護性。
在使用這些選項時，我們需要了解每個選項的用途和適用場景，以便選擇合適的選項。在本文中，我們介紹了以下選項：

  • HasDefaultValue: 指定屬性的預設值
  • HasDefaultValueSql: 使用 SQL 表示式指定屬性的預設值
  • HasComputedColumnSql: 將屬性指定為儲存的計算列
  • HasComputedColumnSql stored: 將屬性指定為計算列並將其儲存在資料庫中
  • ValueGeneratedOnAdd: 指定屬性的值在插入新記錄時自動生成
  • ValueGeneratedOnAddOrUpdate: 指定屬性的值在插入或更新記錄時自動生成
  • 自定義值生成
  • 替代值生成
  • 無值生成

透過使用這些選項，我們可以輕鬆地配置我們的實體模型，並使其更符合我們的業務需求。

相關文章