Code First约定-数据注释

通过实体框架Code First，可以使用您自己的域类表示 EF 执行查询、更改跟踪和更新函数所依赖的模型。Code First 利用称为“约定先于配置”的编程模式。这就是说，Code First 将假定您的类遵从 EF 所使用的约定。在这种情况下，EF 将能够找出自己工作所需的详细信息。但是，如果您的类不遵守这些约定，则可以向类中添加配置，以向 EF 提供它需要的信息。

Code First 为您提供了两种方法来向类中添加这些配置。一种方法是使用名为 DataAnnotations 的简单特性，另一种方法是使用 Code First 的Fluent API，该 API 向您提供了在代码中以命令方式描述配置的方法。

本文重点介绍如何使用DataAnnotations（在System.ComponentModel.DataAnnotations 命名空间中）对类进行配置，着重讲述常用的配置。很多 .NET 应用程序（如 ASP.NET MVC）都能够理解DataAnnotations，它允许这些应用程序对客户端验证使用相同的注释。

我将通过Blog 和 Post 这两个简单的类来说明 Code First DataAnnotations。

publicclass Blog

{

public int Id { get; set; }

public string Title { get; set; }

public string BloggerName { get;set; }

public virtual ICollection<Post> Posts { get;set; }

}

publicclass Post

{

public int Id { get; set; }

public string Title { get; set; }

public DateTime DateCreated { get;set; }

public string Content { get;set; }

public int BlogId { get; set; }

public ICollection<Comment>Comments { get; set;}

}

Blog 和 Post 类本身就遵守 Code First 约定，无需调整即可让EF 与之共同使用。但您也可以使用注释向 EF 提供有关类以及类所映射到的数据库的更多信息。

键

实体框架依赖于每个具有键值的实体，它使用键值来跟踪实体。Code First 依赖的一个约定是它在每一个 Code First 类中以何种方式表示哪一个属性是键。该约定是查找名为“Id”或类名与“Id”组合在一起（如“BlogId”）的属性。该属性将映射到数据库中的主键列。

Blog 和 Post 类都遵守此约定。但如果它们不遵守呢？如果 Blog 使用名称 PrimaryTrackingKey，甚至使用 foo 呢？如果Code First 找不到符合此约定的属性，它将引发异常，因为实体框架要求必须要有一个键属性。您可以使用键注释来指定要将哪一个属性用作 EntityKey。

publicclass Blog

{

[Key]

public int PrimaryTrackingKey { get;set; }

public string Title { get; set; }

public string BloggerName { get;set; }

public virtual ICollection<Post> Posts { get;set; }

}

如果您在使用Code First 的数据库生成功能，则Blog 表将具有名为 PrimaryTrackingKey 的主键列，该列默认情况下还定义为 Identity。

必需

Required 注释告诉 EF 某一个特定属性是必需的。

在 Title 属性中添加 Required 将强制 EF（和 MVC）确保该属性中包含数据。

[Required]

public string Title { get;set; }

Required 特性将使被映射的属性不可为空来影响生成的数据库。请注意，Title 字段已经更改为“not null”。

MaxLength 和MinLength

使用MaxLength 和MinLength 特性，您可以就像对Required 那样指定其他属性验证。

下面是具有长度要求的BloggerName。该示例也说明如何组合特性。

[MaxLength(10), MinLength(5)]

public string BloggerName { get;set; }

MaxLength 注释将通过把属性长度设置为 10 来影响数据库。MinLength属性不会对数据库产生影响。

NotMapped

Code First 约定指示具有受支持数据类型的每个属性都要在数据库中有表示。但在您的应用程序中并不总是如此。例如，您可以在 Blog 类中使用一个属性来基于 Title 和BloggerName 字段创建代码。该属性可以动态创建，无需存储。您可以使用 NotMapped 注释来标记不映射到数据库的所有属性，如下面的 BlogCode 属性。

[NotMapped]

publicstring BlogCode

{

get

{

returnTitle.Substring(0, 1) + ":" +BloggerName.Substring(0, 1);

}

ComplexType

跨一组类描述域实体，然后将这些类分层以描述一个完整实体的情况并不少见。例如，您可以向模型中添加一个名为 BlogDetails 的类。

publicclass BlogDetails

{

public DateTime? DateCreated { get;set; }

[MaxLength(250)]

public string Description { get;set; }

}

请注意，BlogDetails 没有任何键属性类型。在域驱动的设计中，BlogDetails 称为值对象。实体框架将值对象称为复杂类型。复杂类型不能自行跟踪。

但是 BlogDetails 作为 Blog 类中的一个属性，将作为 Blog 对象的一部分被跟踪。为了让 Code First 认识到这一点，您必须将 BlogDetails 类标记为 ComplexType。

[ComplexType]

publicclass BlogDetails

{

public DateTime? DateCreated { get;set; }

[MaxLength(250)]

public string Description { get;set; }

}

现在，您可以在Blog 类中添加一个属性来表示该博客的 BlogDetails。

public BlogDetails BlogDetail { get; set; }

在数据库中，Blog表将包含该博客的所有属性，包括在其 BlogDetail 属性中所含的属性。默认情况下，每个属性都将添加复杂类型名称前缀 BlogDetail。

另外，有趣的是，虽然DateCreated 属性在类中定义为不可为空的 DateTime，但相关数据库字段是可为空的。如果想影响数据库架构，则必须使用 Required 注释。

ConcurrencyCheck

ConcurrencyCheck 注释可用于标记要在用户编辑或删除实体时用于在数据库中进行并发检查的一个或多个属性。如果之前使用 EF 设计器，则这等同于将属性的 ConcurrencyMode 设置为 Fixed。

现在让我们将ConcurrencyCheck 添加到BloggerName 属性，看看它如何工作。

[ConcurrencyCheck, MaxLength(10),MinLength(5)]

public string BloggerName { get;set; }

调用SaveChanges 时，因为BloggerName 字段上具有ConcurrencyCheck 注释，所以在更新中将使用该属性的初始值。该命令将尝试通过同时依据键值和 BloggerName 的初始值进行筛选来查找正确的行。下面是发送到数据库的 UPDATE 命令的关键部分，在其中您可以看到该命令将更新 PrimaryTrackingKey 为 1 且BloggerName 为“Julie”（这是从数据库中检索到该博客时的初始值）的行。

where (([PrimaryTrackingKey]= @4) and([BloggerName] = @5))

@4=1,@5=N'Julie'

如果在此期间有人更改了该博客的博主姓名，则此更新将失败，并引发 DbUpdateConcurrencyException 并且需要处理该异常。

TimeStamp

使用rowversion 或timestamp 字段来进行并发检查更为常见。但是比起使用 ConcurrencyCheck 注释，只要属性类型为字节数组，则不如使用更为具体的 TimeStamp 注释。Code First 将Timestamp 属性与ConcurrencyCheck 属性同等对待，但它还将确保 Code First 生成的数据库字段是不可为空的。在一个指定类中，只能有一个 timestamp 属性。

将以下属性添加到Blog 类：

[Timestamp]

publicByte[] TimeStamp { get;set; }

这样，CodeFirst 将在数据库表中创建一个不可为空的 Timestamp 列。

表和列

如果您让Code First 创建数据库，则可能希望更改它创建的表和列的名称。也可以将 Code First 用于现有数据库。但是域中的类和属性的名称并不总是与数据库中表和列的名称相匹配。

我的类名为Blog，按照约定，Code First 将假定此类映射到名为 Blogs 的表。如果不是这样，您可以用 Table 特性指定该表的名称。举例来说，下面的注释指定表名称为 InternalBlogs，同时指定了schema，默认的schema就是dbo。

[Table("InternalBlogs",Schema="dbo")]

public class Blog

Column 注释更适于用来指定被映射列的特性。您可以规定名称、数据类型甚至列出现在表中的顺序。下面是 Column 特性的示例。

[Column("BlogDescription",TypeName = "ntext")]

public String Description { get; set; }

下面是重新生成后的表。表名称已更改为 InternalBlogs，复杂类型的 Description 列现在是BlogDescription。因为该名称在注释中指定，Code First 不会使用以复杂类型名称作为列名开头的约定。

DatabaseGenerated

一个重要的数据库功能是可以使用计算属性。如果您将 Code First 类映射到包含计算列的表，则您可能不想让实体框架尝试更新这些列。但是在插入或更新数据后，您的确需要 EF 从数据库中返回这些值。您可以使用 DatabaseGenerated 注释与 Computed 枚举一起在您的类中标注这些属性。其他枚举为 None 和Identity。

[DatabaseGenerated(DatabaseGeneratedOption.Computed)]

public DateTime DateCreated { get; set; }

当 Code First生成数据库时，您可以对 byte 或timestamp 列使用此标记，否则您只应该在指向现有数据库时使用，因为 Code First 将不能确定计算列的公式。

您阅读过以上内容，知道默认情况下，整数键属性将成为数据库中的标识键。这与将 DatabaseGenerated 设置为 DatabaseGenerationOption.Identity 是一样的。如果不希望它成为标识键，则可以将该值设置为 DatabaseGenerationOption.None。

关系特性：InverseProperty和ForeignKey

Code First 约定将在您的模型中处理最常用的关系，但是在某些情况下它需要帮助。

在 Blog 类中更改键属性的名称造成它与 Post 的关系出现问题。

生成数据库时，CodeFirst 会在 Post 类中看到 BlogId 属性并识别出该属性，按照约定，它与类名加“Id”匹配，并作为 Blog 类的外键。但是在此Blog 类中没有 BlogId 属性。解决方法是，在 Post 中创建一个导航属性，并使用 Foreign DataAnnotation 来帮助 CodeFirst 了解如何在两个类之间创建关系（那就是使用 Post.BlogId 属性）以及如何在数据库中指定约束。

publicclass Post

{

public int Id { get; set; }

public string Title { get; set; }

public DateTime DateCreated { get;set; }

public string Content { get;set; }

public int BlogId { get; set; }

[ForeignKey("BlogId")]

public Blog Blog { get; set; }

}

数据库中的约束显示InternalBlogs.PrimaryTrackingKey 与Posts.BlogId 之间的关系。

类之间存在多个关系时，将使用 InverseProperty。

在 Post 类中，您可能需要跟踪是谁撰写了博客文章以及谁编辑了它。下面是 Post 类的两个新的导航属性。

public Person CreatedBy { get;set; }

public Person UpdatedBy { get;set; }

您还需要在这些属性引用的 Person 类中添加内容。Person类具有返回到 Post 的导航属性，一个属性指向该用户撰写的所有文章，一个属性指向该用户更新的所有文章。

publicclass Person

{

public int Id { get; set; }

public string Name { get; set; }

public List<Post>PostsWritten { get; set;}

public List<Post>PostsUpdated { get; set;}

}

Code First 不能自行使这两个类中的属性匹配。Posts 的数据库表应该有一个表示 CreatedBy 人员的外键，有一个表示 UpdatedBy 人员的外键，但是 Code First 将创建四个外键属性：Person_Id、Person_Id1、CreatedBy_Id 和UpdatedBy_Id。(针对每个导航属性创建一个外键)

要解决这些问题，您可以使用 InverseProperty 注释来指定这些属性的匹配。

[InverseProperty("CreatedBy")]

publicList<Post>PostsWritten { get; set;}

[InverseProperty("UpdatedBy")]

publicList<Post>PostsUpdated { get; set;}

因为Person 中的PostsWritten 属性知道这指的是Post 类型，所以它将与 Post.CreatedBy 建立关系。同样，PostsUpdated 也将与 Post.UpdatedBy 建立关系。Code First 不会创建额外的外键。

总结

DataAnnotations 不仅可用于在 Code First 类中描述客户端和服务器端验证，还让您能够加强甚至更正 Code First 将基于其约定对您的类所作的假设。使用 DataAnnotations，您不仅能够推动数据库架构生成，还能将 Code First 类映射到预先存在的数据库。

虽然它们都非常灵活，但请记住，DataAnnotations 只提供您经常需要对 Code First 类进行的配置更改。要为一些边缘情况配置类，则应该采用另一种替代配置机制，那就是 Code First 的Fluent API。