Fluent API - 配置和映射属性和类型

使用 Entity Framework Code First 时，默认行为是使用嵌入 EF 的一组约定将 POCO 类映射到表。 但是，有时，你不能或不想遵循这些约定，并且需要将实体映射到约定所规定的内容以外的其他内容。

可以通过两种主要方式将 EF 配置为使用约定以外的其他方法，即 批注 或 EFs Fluent API。 批注仅涵盖 Fluent API 功能的子集，因此无法使用批注实现映射方案。 本文旨在演示如何使用 Fluent API 配置属性。

在派生的 DbContext 上重写 OnModelCreating 方法是最常用来访问 Code First Fluent API 的方式。 以下示例旨在演示如何使用 fluent api 执行各种任务，并允许你将代码复制出来并对其进行自定义以适合模型，如果你希望看到模型可与 as-is 一起使用，本文末尾会提供该模型。

模型范围内设置

默认架构（EF6 及更高版本）

从 EF6 开始，可以使用 DbModelBuilder 类中的 HasDefaultSchema 方法指定数据库架构，以用于所有表、存储过程等。对于那些已显式配置其他架构的对象，此默认设置将被覆盖。

modelBuilder.HasDefaultSchema("sales");

自定义约定（EF6 及更高版本）

从 EF6 开始，可以创建自己的约定来补充 Code First 中包含的约定。 有关详细信息，请参阅 自定义代码优先约定。

属性映射

Property 方法用于为属于实体或复杂类型的每个属性配置属性。 Property 方法用于获取给定属性的配置对象。 配置对象上的选项特定于所配置的类型;IsUnicode 仅适用于字符串属性，例如。

配置主键

主键的 Entity Framework 约定为：

1. 类定义名称为“ID”或“Id”的属性
2. 或类名后跟“ID”或“Id”

若要将属性显式设置为主键，可以使用 HasKey 方法。 在以下示例中，HasKey 方法用于在 OfficeAssignment 类型上配置 InstructorID 主键。

modelBuilder.Entity<OfficeAssignment>().HasKey(t => t.InstructorID);

配置复合主键

以下示例将 DepartmentID 和 Name 属性配置为 Department 类型的复合主键。

modelBuilder.Entity<Department>().HasKey(t => new { t.DepartmentID, t.Name });

关闭数字主键的标识

以下示例将 DepartmentID 属性设置为 System.ComponentModel.DataAnnotations.DatabaseGeneratedOption.None，以指示该值不会由数据库生成。

modelBuilder.Entity<Department>().Property(t => t.DepartmentID)
    .HasDatabaseGeneratedOption(DatabaseGeneratedOption.None);

指定属性的最大长度

在以下示例中，Name 属性不应超过 50 个字符。 如果使值超过 50 个字符，将收到 DbEntityValidationException 异常。 如果 Code First 从此模型创建数据库，它还会将 Name 列的最大长度设置为 50 个字符。

modelBuilder.Entity<Department>().Property(t => t.Name).HasMaxLength(50);

将属性配置为必需

在以下示例中，需要 Name 属性。 如果未指定 Name，将会抛出 DbEntityValidationException 异常。 如果 Code First 从此模型创建数据库，则用于存储此属性的列通常不可为 null。

modelBuilder.Entity<Department>().Property(t => t.Name).IsRequired();

在一个或多个属性上配置索引

Fluent API 本身不支持创建索引，但可以通过 Fluent API 使用 IndexAttribute 的支持。 索引属性是通过在模型上包括模型注释来处理的，该批注随后在管道中的数据库中转换为索引。 可以使用 Fluent API 手动添加这些相同的批注。

执行此操作的最简单方法是创建包含新索引的所有设置的 IndexAttribute 实例。 然后，可以创建 IndexAnnotation 的实例，该实例是一种 EF 特定类型，它将 IndexAttribute 设置转换为可存储在 EF 模型中的模型注释。 然后，可以将这些值传递给 Fluent API 上的 HasColumnAnnotation 方法，并指定批注的名称 Index 。

modelBuilder
    .Entity<Department>()
    .Property(t => t.Name)
    .HasColumnAnnotation("Index", new IndexAnnotation(new IndexAttribute()));

有关 IndexAttribute 中可用的设置的完整列表，请参阅 Code First 数据注释的“索引”部分。 这包括自定义索引名称、创建唯一索引和创建多列索引。

可以通过将 IndexAttribute 数组传递给 IndexAnnotation 的构造函数，在单个属性上指定多个索引批注。

modelBuilder
    .Entity<Department>()
    .Property(t => t.Name)
    .HasColumnAnnotation(
        "Index",  
        new IndexAnnotation(new[]
            {
                new IndexAttribute("Index1"),
                new IndexAttribute("Index2") { IsUnique = true }
            })));

指定不将 CLR 属性映射到数据库中的列

以下示例演示如何指定 CLR 类型的属性未映射到数据库中的列。

modelBuilder.Entity<Department>().Ignore(t => t.Budget);

将 CLR 属性映射到数据库中的特定列

以下示例将 Name CLR 属性映射到 DepartmentName 数据库列。

modelBuilder.Entity<Department>()
    .Property(t => t.Name)
    .HasColumnName("DepartmentName");

重命名模型中未定义的外键

如果您选择不对 CLR 类型定义外键，但想要指定数据库中应具有的名称，请执行以下操作：

modelBuilder.Entity<Course>()
    .HasRequired(c => c.Department)
    .WithMany(t => t.Courses)
    .Map(m => m.MapKey("ChangedDepartmentID"));

配置字符串属性是否支持 Unicode 内容

默认情况下，字符串为 Unicode（SQL Server 中的 nvarchar）。 可以使用 IsUnicode 方法指定字符串应为 varchar 类型。

modelBuilder.Entity<Department>()
    .Property(t => t.Name)
    .IsUnicode(false);

配置数据库列的数据类型

HasColumnType 方法允许映射到相同基本类型的不同表示形式。 使用此方法不会让你在运行时执行任何数据转换。 请注意，IsUnicode 是将列设置为 varchar 的首选方法，因为它与数据库无关。

modelBuilder.Entity<Department>()   
    .Property(p => p.Name)   
    .HasColumnType("varchar");

在复杂类型上配置属性

可通过两种方法在复杂类型上配置标量属性。

可以在 ComplexTypeConfiguration 上调用属性。

modelBuilder.ComplexType<Details>()
    .Property(t => t.Location)
    .HasMaxLength(20);

还可以使用点表示法访问复杂类型的属性。

modelBuilder.Entity<OnsiteCourse>()
    .Property(t => t.Details.Location)
    .HasMaxLength(20);

将属性配置为用作乐观并发令牌

若要指定实体中的属性表示并发令牌，可以使用 ConcurrencyCheck 属性或 IsConcurrencyToken 方法。

modelBuilder.Entity<OfficeAssignment>()
    .Property(t => t.Timestamp)
    .IsConcurrencyToken();

还可以使用 IsRowVersion 方法将属性配置为数据库中的行版本。 将属性设置为行版本号会自动将其配置为乐观并发控制标记。

modelBuilder.Entity<OfficeAssignment>()
    .Property(t => t.Timestamp)
    .IsRowVersion();

类型映射

将类指定为复杂类型

按照约定，没有指定主键的类型被视为复杂类型。 在某些情况下，Code First 不会检测复杂类型（例如，如果有一个名为 ID 的属性，但这并不意味着它是主键）。 在这种情况下，将使用 Fluent API 显式指定类型是复杂类型。

modelBuilder.ComplexType<Details>();

指定不将 CLR 实体类型映射到数据库中的表

以下示例演示如何防止将 CLR 类型映射到数据库中的表。

modelBuilder.Ignore<OnlineCourse>();

将实体类型映射到数据库中的特定表

Department 的所有属性将映射到名为 t_ Department 的表中的列。

modelBuilder.Entity<Department>()  
    .ToTable("t_Department");

还可以指定架构名称，如下所示：

modelBuilder.Entity<Department>()  
    .ToTable("t_Department", "school");

映射每层级一表 (TPH) 继承

在 TPH 映射方案中，继承层次结构中的所有类型都映射到单个表。 使用鉴别器列来标识每行的类型。 使用 Code First 创建模型时，TPH 是参与继承层次结构的类型的默认策略。 默认情况下，将鉴别器列添加到表中，其名称为“鉴别器”，层次结构中每种类型的 CLR 类型名称用于鉴别器值。 可以使用 fluent API 修改默认行为。

modelBuilder.Entity<Course>()  
    .Map<Course>(m => m.Requires("Type").HasValue("Course"))  
    .Map<OnsiteCourse>(m => m.Requires("Type").HasValue("OnsiteCourse"));

每类型一表继承映射

在 TPT 映射方案中，所有类型都映射到单个表。 仅属于基类型或派生类型的属性存储在映射到该类型的表中。 映射到派生类型的表还存储将派生表与基表联接的外键。

modelBuilder.Entity<Course>().ToTable("Course");  
modelBuilder.Entity<OnsiteCourse>().ToTable("OnsiteCourse");

具体类表（TPC）继承映射

在 TPC 映射方案中，层次结构中的所有非抽象类型都映射到单个表。 映射到派生类的表与映射到数据库中基类的表没有关系。 类的所有属性（包括继承的属性）都映射到相应表的列。

调用 MapInheritedProperties 方法以配置每个派生类型。 MapInheritedProperties 将继承自基类的所有属性重新映射到派生类的表中的新列。

modelBuilder.Entity<Course>()
    .Property(c => c.CourseID)
    .HasDatabaseGeneratedOption(DatabaseGeneratedOption.None);

modelBuilder.Entity<OnsiteCourse>().Map(m =>
{
    m.MapInheritedProperties();
    m.ToTable("OnsiteCourse");
});

modelBuilder.Entity<OnlineCourse>().Map(m =>
{
    m.MapInheritedProperties();
    m.ToTable("OnlineCourse");
});

将实体类型的属性映射到数据库中的多个表（实体拆分）

实体拆分允许实体类型的属性分布在多个表中。 在以下示例中，Department 实体对象被拆分为两个表：Department 和 部门详情。 实体拆分使用对 Map 方法的多个调用将属性子集映射到特定表。

modelBuilder.Entity<Department>()
    .Map(m =>
    {
        m.Properties(t => new { t.DepartmentID, t.Name });
        m.ToTable("Department");
    })
    .Map(m =>
    {
        m.Properties(t => new { t.DepartmentID, t.Administrator, t.StartDate, t.Budget });
        m.ToTable("DepartmentDetails");
    });

将多个实体类型映射到数据库中的一个表（表拆分）

以下示例将共享主键的两种实体类型映射到一个表。

modelBuilder.Entity<OfficeAssignment>()
    .HasKey(t => t.InstructorID);

modelBuilder.Entity<Instructor>()
    .HasRequired(t => t.OfficeAssignment)
    .WithRequiredPrincipal(t => t.Instructor);

modelBuilder.Entity<Instructor>().ToTable("Instructor");

modelBuilder.Entity<OfficeAssignment>().ToTable("Instructor");

将实体类型映射到插入/更新/删除存储过程（EF6 及更高版本）

从 EF6 开始，可以映射实体以使用存储过程进行插入、更新和删除操作。 有关更多详细信息，请参阅代码优先 插入/更新/删除 存储过程。

示例中使用的模型

以下 Code First 模型用于本页上的示例。

using System.Data.Entity;
using System.Data.Entity.ModelConfiguration.Conventions;
// add a reference to System.ComponentModel.DataAnnotations DLL
using System.ComponentModel.DataAnnotations;
using System.Collections.Generic;
using System;

public class SchoolEntities : DbContext
{
    public DbSet<Course> Courses { get; set; }
    public DbSet<Department> Departments { get; set; }
    public DbSet<Instructor> Instructors { get; set; }
    public DbSet<OfficeAssignment> OfficeAssignments { get; set; }

    protected override void OnModelCreating(DbModelBuilder modelBuilder)
    {
        // Configure Code First to ignore PluralizingTableName convention
        // If you keep this convention then the generated tables will have pluralized names.
        modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
    }
}

public class Department
{
    public Department()
    {
        this.Courses = new HashSet<Course>();
    }
    // Primary key
    public int DepartmentID { get; set; }
    public string Name { get; set; }
    public decimal Budget { get; set; }
    public System.DateTime StartDate { get; set; }
    public int? Administrator { get; set; }

    // Navigation property
    public virtual ICollection<Course> Courses { get; private set; }
}

public class Course
{
    public Course()
    {
        this.Instructors = new HashSet<Instructor>();
    }
    // Primary key
    public int CourseID { get; set; }

    public string Title { get; set; }
    public int Credits { get; set; }

    // Foreign key
    public int DepartmentID { get; set; }

    // Navigation properties
    public virtual Department Department { get; set; }
    public virtual ICollection<Instructor> Instructors { get; private set; }
}

public partial class OnlineCourse : Course
{
    public string URL { get; set; }
}

public partial class OnsiteCourse : Course
{
    public OnsiteCourse()
    {
        Details = new Details();
    }

    public Details Details { get; set; }
}

public class Details
{
    public System.DateTime Time { get; set; }
    public string Location { get; set; }
    public string Days { get; set; }
}

public class Instructor
{
    public Instructor()
    {
        this.Courses = new List<Course>();
    }

    // Primary key
    public int InstructorID { get; set; }
    public string LastName { get; set; }
    public string FirstName { get; set; }
    public System.DateTime HireDate { get; set; }

    // Navigation properties
    public virtual ICollection<Course> Courses { get; private set; }
}

public class OfficeAssignment
{
    // Specifying InstructorID as a primary
    [Key()]
    public Int32 InstructorID { get; set; }

    public string Location { get; set; }

    // When Entity Framework sees Timestamp attribute
    // it configures ConcurrencyCheck and DatabaseGeneratedPattern=Computed.
    [Timestamp]
    public Byte[] Timestamp { get; set; }

    // Navigation property
    public virtual Instructor Instructor { get; set; }
}