EF7创建模型值生成篇

时间：2021-07-31 00:44:39

在 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: 指定属性的值在插入或更新记录时自动生成
  • 自定义值生成
  • 替代值生成
  • 无值生成

通过使用这些选项，我们可以轻松地配置我们的实体模型，并使其更符合我们的业务需求。

相关文章