Code First 约定

借助 Code First,可通过使用 C# 或Visual Basic .NET 类来描述模型。模型的基本形状可通过约定来检测。约定是规则集,用于在使用 Code First 时基于类定义自动配置概念模型。约定是在 System.Data.Entity.ModelConfiguration.Conventions 命名空间中定义的。

可通过使用数据注释或Fluent API 进一步配置模型。优先级是通过 Fluent API 进行配置,然后是通过数据注释,再次是通过约定。

API 文档中提供了 Code First 约定的详细列表。本主题概述 Code First 使用的约定。

类型发现

当使用 CodeFirst 开发时,通常是从编写用来定义概念(域)模型的 .NET类开始。除了定义类之外,还需要让 DbContext 知道模型中要包含哪些类。为此,需要定义一个上下文类,此类派生自 DbContext 并公开需要成为模型一部分的类型的 DbSet 属性。Code First 将包含这些类型,还将包含任何引用类型,即使这些引用类型是在不同的程序集中定义的也是如此。

如果类型存在于继承层次结构中,则为基类定义 DbSet 属性就足够了,如果派生类型位于与基类相同的程序集中,则自动包含这些派生类型。

在下面的示例中,仅对SchoolEntities 类定义一个DbSet 属性 (Departments)。CodeFirst 使用此属性来发现并包含任何引用类型。

public class  SchoolEntities: DbContext
{
  public DbSet<Department>Departments { get; set;}
}

public class  Department
{

  // Primary key
  public int DepartmentID { get;set; }
  public string Name { get; set; } 

  // Navigationproperty
  public virtual ICollection<Course> Courses { get;set; }
}

 

public class  Course
{

  // Primary key
  public int CourseID { get; set; } 
  public string Title { get; set; }
  public int Credits { get; set; } 

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

  // Navigationproperties
  public virtual DepartmentDepartment {  get; set;}
} 

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

public partial  class OnsiteCourse :  Course
{
  public string Location { get;set; }
  public string Days { get; set; }
  public System.DateTime Time { get; set; }
}

如果要从模型排除类型,请使用 NotMapped 特性或DbModelBuilder.Ignore

主键约定

如果类的属性名为“ID”(不区分大小写)或类名的后面跟有“ID”,则 Code First 会推断该属性是主键。如果主键属性的类型为数值或 GUID,则将其配置为标识列。

public class  Department
{
  // Primary key
  public int DepartmentID { get;set; }
}

关系约定

实体框架中的导航属性提供了一种在两个实体类型之间导航关系的方法。针对对象参与到其中的每个关系,各对象均可以具有导航属性。使用导航属性,可以在两个方向上导航和管理关系,返回引用对象(如果多重性为一或者零或一)或集合(如果多重性为多)。Code First 根据针对类型定义的导航属性来推断关系。

除导航属性外,建议还要包括表示依赖对象的类型的外键属性。任何数据类型与主体主键属性相同、遵循以下一种格式的属性都表示关系的外键:“<导航属性名称><主体主键属性>”、“<主体类名><主键属性名称>”或“<主体主键属性名称>”。如果找到多个匹配项,则优先级符合上面列出的顺序。外键检测不区分大小写。在检测外键属性时,Code First 基于外键的可空性推断关系的多重性。如果属性可以为 Null,则将关系注册为可选关系;否则,将关系注册为必需关系。

如果依赖实体上的外键不能为 Null,则 CodeFirst 对关系设置级联删除。如果依赖实体上的外键可以为 Null,则Code First 不对关系设置级联删除,并且在删除主体时,会将该外键设置为 Null。通过使用 Fluent API,可以覆盖由约定检测的多重性和级联删除行为。

public class  Department
{
  // Primary key
  public int DepartmentID { get;set; }
  public string Name { get; set; } 

  // Navigationproperty
  public virtual ICollection<Course> Courses { get;set; }
}

public class  Course
{
  // Primary key
  public int CourseID { get; set; } 

  public string Title { get; set; }

  public int Credits { get; set; } 

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

  // Navigationproperties
  public virtual DepartmentDepartment {  get; set;}
}

在下面的示例中,导航属性和外键用于定义 Department 类与Course 类之间的关系。

注意:如果相同类型间有多个关系(例如,假设定义 Person 和Book 类,其中,Person 包含ReviewedBooks 和AuthoredBooks 导航属性,而Book 类包含 Author 和Reviewer 导航属性),则需要使用数据注释或 Fluent API 手动配置关系。

复杂类型约定

当 CodeFirst 发现无法推断主键以及未通过数据注释或 Fluent API 注册主键的类时,类型会自动注册为复杂类型。复杂类型检测还要求类型不具有引用实体类型的属性,并且未被其他类型的集合属性引用。对于以下类定义,Code First 推断Details 是复杂类型,因为它没有主键。

public partial  class OnsiteCourse :  Course
{
  public OnsiteCourse()
  {
    Details = newDetails();
  }
  public Details Details { get;set; }

}

 

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

  public string Location { get;set; }

  public string Days { get; set; }
}