📌  相关文章
📜  Entity Framework-数据注释

📅  最后修改于: 2020-11-21 07:33:55             🧑  作者: Mango

DataAnnotations用于配置将突出显示最常用的配置的类。许多.NET应用程序也可以理解DataAnnotations，例如ASP.NET MVC，它允许这些应用程序利用相同的注释进行客户端验证。 DataAnnotation属性将覆盖默认的CodeFirst约定。

System.ComponentModel.DataAnnotations包含以下影响列的可空性或列大小的属性。

  • 键
  • 时间戳记
  • 并发检查
  • 需要
  • 最小长度
  • 最长长度
  • 字符串长度

System.ComponentModel.DataAnnotations.Schema命名空间包括以下影响数据库架构的属性。

  • 表
  • 柱
  • 指数
  • 外键
  • 未映射
  • 逆属性

键

实体框架依赖于每个具有用于跟踪实体的键值的实体。 Code First依赖的一种约定是它如何暗示哪个属性是每个Code First类的键。

  • 惯例是寻找一个名为“ Id”的属性，或者将类名和“ Id”组合在一起的属性，例如“ StudentId”。

  • 该属性将映射到数据库中的主键列。

  • 学生，课程和注册课程遵循此约定。

现在，假设Student类使用名称StdntID代替ID。当Code First找不到与该约定匹配的属性时，由于Entity Framework要求您必须具有键属性，因此它将引发异常。您可以使用键注释来指定将哪个属性用作EntityKey。

让我们看一下包含StdntID的Student类的以下代码，但它没有遵循默认的Code First约定。因此，要处理此问题，将添加一个Key属性，该属性将使其成为主键。

public class Student {

   [Key]
   public int StdntID { get; set; }
   public string LastName { get; set; }
   public string FirstMidName { get; set; }
   public DateTime EnrollmentDate { get; set; }
    
   public virtual ICollection Enrollments { get; set; }
}

当您运行应用程序并在SQL Server资源管理器中查看数据库时，您会看到主键现在是“学生”表中的StdntID。

首要的关键

实体框架还支持组合键。复合键也是由多个属性组成的主键。例如，您有一个DrivingLicense类，其主键是LicenseNumber和IssuingCountry的组合。

public class DrivingLicense {

   [Key, Column(Order = 1)]
   public int LicenseNumber { get; set; }
   [Key, Column(Order = 2)]
   public string IssuingCountry { get; set; }
   public DateTime Issued { get; set; }
   public DateTime Expires { get; set; }
}

当您具有复合键时，Entity Framework要求您定义键属性的顺序。您可以使用Column批注指定订单。

列注释

时间戳记

Code First将把Timestamp属性与ConcurrencyCheck属性相同，但也将确保代码首先生成的数据库字段不可为空。

  • 使用rowversion或timestamp字段进行并发检查更为常见。

  • 只要属性的类型是字节数组，就可以使用更具体的TimeStamp注释，而不是使用ConcurrencyCheck注释。

  • 给定的类中只能有一个timestamp属性。

让我们看一个简单的示例，将TimeStamp属性添加到Course类中-

public class Course {

   public int CourseID { get; set; }
   public string Title { get; set; }
   public int Credits { get; set; }
   [Timestamp]
   public byte[] TStamp { get; set; }
    
   public virtual ICollection Enrollments { get; set; }
}

如上例所示，Timestamp属性应用于Course类的Byte []属性。因此，Code First将在Courses表中创建一个时间戳列TStamp 。

并发检查

ConcurrencyCheck批注允许您在用户编辑或删除实体时在数据库中标记一个或多个用于并发检查的属性。如果您使用的是EF Designer，则与将属性的ConcurrencyMode设置为Fixed保持一致。

让我们看一下ConcurrencyCheck如何工作的简单示例，方法是将其添加到Course类的Title属性中。

public class Course {

   public int CourseID { get; set; }
   [ConcurrencyCheck]
   public string Title { get; set; }
   public int Credits { get; set; }
   [Timestamp, DataType("timestamp")]
   public byte[] TimeStamp { get; set; }
    
   public virtual ICollection Enrollments { get; set; }
}

在上述课程类中，ConcurrencyCheck属性应用于现有的Title属性。现在，Code First将在update命令中包括Title列，以检查乐观并发，如以下代码所示。

exec sp_executesql N'UPDATE [dbo].[Courses]
   SET [Title] = @0
   WHERE (([CourseID] = @1) AND ([Title] = @2))
   ',N'@0 nvarchar(max) ,@1 int,@2 nvarchar(max) ',@0=N'Maths',@1=1,@2=N'Calculus'
go

必填注释

Required注释告诉EF特定属性是必需的。让我们看一下下面的Student类，在其中将Required id添加到FirstMidName属性。 Required属性将强制EF确保该属性中包含数据。

public class Student {

   [Key]
   public int StdntID { get; set; }

   [Required]
   public string LastName { get; set; }

   [Required]
   public string FirstMidName { get; set; }
   public DateTime EnrollmentDate { get; set; }
    
   public virtual ICollection Enrollments { get; set; }
}

如上例所示，Required属性应用于FirstMidName和LastName。因此，Code First将在Student表中创建一个NOT NULL FirstMidName和LastName列，如下图所示。

不为空

最长长度

MaxLength属性允许您指定其他属性验证。可以将其应用于域类的字符串或数组类型属性。 EF Code First将按照MaxLength属性中指定的方式设置列的大小。

让我们看一下下面的Course类，其中将MaxLength(24)属性应用于Title属性。

public class Course {

   public int CourseID { get; set; }
   [ConcurrencyCheck]
   [MaxLength(24)]
   public string Title { get; set; }
   public int Credits { get; set; }
    
   public virtual ICollection Enrollments { get; set; }
}

当您运行上述应用程序时，Code First将在CourseId表中创建一个nvarchar(24)列Title，如下图所示。

nvarchar列

当用户设置包含超过24个字符的Title时，EF将抛出EntityValidationError。

最小长度

MinLength属性还允许您指定其他属性验证，就像使用MaxLength一样。 MinLength属性也可以与MaxLength属性一起使用，如以下代码所示。

public class Course {

   public int CourseID { get; set; }
   [ConcurrencyCheck]
   [MaxLength(24) , MinLength(5)]
   public string Title { get; set; }
   public int Credits { get; set; }
    
   public virtual ICollection Enrollments { get; set; }
}

如果您将Title属性的值设置为小于MinLength属性中的指定长度或大于MaxLength属性中的指定长度，则EF会引发EntityValidationError。

字符串长度

StringLength还允许您指定其他属性验证，例如MaxLength。唯一的区别是StringLength属性只能应用于Domain类的字符串类型属性。

public class Course {

   public int CourseID { get; set; }
   [StringLength (24)]
   public string Title { get; set; }
   public int Credits { get; set; }
    
   public virtual ICollection Enrollments { get; set; }
}

实体框架还验证StringLength属性的属性值。如果用户设置的Title包含超过24个字符，则EF将抛出EntityValidationError。

表

默认代码优先约定创建一个类似于类名的表名。如果要让Code First创建数据库，并且还想更改其创建的表的名称。然后-

  • 您可以将Code First与现有数据库一起使用。但是，类的名称与数据库中表的名称并不总是匹配的。

  • 表属性将覆盖此默认约定。

  • EF Code First将为给定的域类在Table属性中创建一个具有指定名称的表。

让我们看下面的示例，在该示例中，该类命名为Student，按照惯例，Code First假定它将映射到名为Student的表。如果不是这种情况，则可以使用Table属性指定表的名称，如以下代码所示。

[Table("StudentsInfo")]
public class Student {

   [Key]
   public int StdntID { get; set; }
   [Required]
   public string LastName { get; set; }
   [Required]
   public string FirstMidName { get; set; }
   public DateTime EnrollmentDate { get; set; }
    
   public virtual ICollection Enrollments { get; set; }
}

现在您可以看到Table属性将表指定为StudentsInfo。生成表后，您将看到表名StudentsInfo，如下图所示。

学生信息

您不仅可以指定表名，还可以使用Table属性为表指定架构，如以下代码所示。

[Table("StudentsInfo", Schema = "Admin")] 
public class Student {

   [Key]
   public int StdntID { get; set; }
   [Required]
   public string LastName { get; set; }
   [Required]
   public string FirstMidName { get; set; }
   public DateTime EnrollmentDate { get; set; }
    
   public virtual ICollection Enrollments { get; set; }
}

您可以在上面的示例中看到，该表是使用admin模式指定的。现在，Code First将在Admin模式中创建StudentsInfo表，如下图所示。

管理员架构

柱

它也与Table属性相同，但是Table属性覆盖表行为，而Column属性覆盖列行为。默认代码优先约定创建一个类似于属性名称的列名称。如果要让Code First创建数据库，并且还想更改表中列的名称。然后-

  • 列属性将覆盖默认约定。

  • EF Code First将在给定属性的Column属性中创建一个具有指定名称的列。

让我们看下面的示例，在该示例中，该属性名为FirstMidName，按照惯例，Code First假定此属性将映射到名为FirstMidName的列。

如果不是这种情况，则可以使用Column属性指定列的名称，如以下代码所示。

public class Student {

   public int ID { get; set; }
   public string LastName { get; set; }
   [Column("FirstName")]
   public string FirstMidName { get; set; }
   public DateTime EnrollmentDate { get; set; }
    
   public virtual ICollection Enrollments { get; set; }
}

您可以看到Column属性将列指定为FirstName。生成表后，您将看到列名FirstName，如下图所示。

名字

指数

Index属性是在Entity Framework 6.1中引入的。如果使用的是较早版本，则此部分中的信息不适用。

  • 您可以使用IndexAttribute在一个或多个列上创建索引。

  • 将属性添加到一个或多个属性将使EF在创建数据库时在数据库中创建相应的索引。

  • 在大多数情况下，索引使数据检索更快，更有效。但是，用索引重载表或视图可能会不愉快地影响其他操作(如插入或更新)的性能。

  • 索引是Entity Framework中的新功能，您可以在其中通过减少从数据库查询数据所需的时间来提高Code First应用程序的性能。

  • 您可以使用Index属性将索引添加到数据库中，并覆盖默认的“唯一”和“群集”设置，以获得最适合您的方案的索引。

  • 默认情况下，索引将命名为IX_ <属性名称>

让我们看一下下面的代码，其中在Course类中为Credits添加了Index属性。

public class Course {
   public int CourseID { get; set; }
   public string Title { get; set; }
   [Index]
   public int Credits { get; set; }
    
   public virtual ICollection Enrollments { get; set; }
}

您可以看到Index属性已应用到Credits属性。生成表后，您将在“索引”中看到IX_Credits。

九学分

默认情况下，索引是非唯一的，但是您可以使用IsUnique命名参数来指定索引应该是唯一的。下面的示例引入了一个唯一索引，如以下代码所示。

public class Course {
   public int CourseID { get; set; }
   [Index(IsUnique = true)]
    
   public string Title { get; set; }
   [Index]
    
   public int Credits { get; set; }
   public virtual ICollection Enrollments { get; set; }
}

外键

Code First约定将处理模型中最常见的关系，但是在某些情况下需要帮助。例如，通过更改Student类中键属性的名称，创建了一个与Enrollment类的关系问题。

public class Enrollment {
   public int EnrollmentID { get; set; }
   public int CourseID { get; set; }
   public int StudentID { get; set; }
   public Grade? Grade { get; set; }
    
   public virtual Course Course { get; set; }
   public virtual Student Student { get; set; }
}

public class Student {
   [Key]
   public int StdntID { get; set; }
   public string LastName { get; set; }
   public string FirstMidName { get; set; }
   public DateTime EnrollmentDate { get; set; }
    
   public virtual ICollection Enrollments { get; set; }
}

在生成数据库时，Code First会在Enrollment类中看到StudentID属性，并按照惯例将其与类名加“ ID”匹配作为惯例，将其识别为Student类的外键。但是，在Student类中没有StudentID属性，但StdntID属性是Student类。

解决方案是在“注册”中创建一个导航属性，并使用ForeignKey DataAnnotation来帮助Code First了解如何在两个类之间建立关系，如以下代码所示。

public class Enrollment {
   public int EnrollmentID { get; set; }
   public int CourseID { get; set; }
   public int StudentID { get; set; }
    
   public Grade? Grade { get; set; }
   public virtual Course Course { get; set; }
   [ForeignKey("StudentID")]
    
   public virtual Student Student { get; set; }
}

现在您可以看到ForeignKey属性已应用于导航属性。

外键属性

未映射

默认情况下，Code First的约定在数据库中表示具有受支持数据类型的每个属性，其中包括getter和setter。但是，在您的应用程序中并非总是如此。 NotMapped属性将覆盖此默认约定。例如，您可能在Student类中有一个属性，例如FatherName，但是不需要存储它。您可以将NotMapped属性应用于不想在数据库中创建列的FatherName属性，如以下代码所示。

public class Student {
   [Key]
   public int StdntID { get; set; }
   public string LastName { get; set; }
   public string FirstMidName { get; set; }
    
   public DateTime EnrollmentDate { get; set; }
   [NotMapped]

   public int FatherName { get; set; }
   public virtual ICollection Enrollments { get; set; }
}

您可以看到NotMapped属性已应用于FatherName属性。生成表时，您会看到不会在数据库中创建“父亲姓名”列，但该列存在于“学生”类中。

未映射属性

Code First将不会为没有getter或setter的属性创建列，如以下Student类的Address和Age属性的示例所示。

逆属性

当类之间具有多个关系时，将使用InverseProperty。在“注册”课程中，您可能需要跟踪谁注册了当前课程和上一课程。让我们为Enrollment类添加两个导航属性。

public class Enrollment {
   public int EnrollmentID { get; set; }
   public int CourseID { get; set; }
   public int StudentID { get; set; }
   public Grade? Grade { get; set; }
    
   public virtual Course CurrCourse { get; set; }
   public virtual Course PrevCourse { get; set; }
   public virtual Student Student { get; set; }
}

同样，您还需要添加这些属性引用的Course类。 Course类具有返回到Enrollment类的导航属性，其中包含所有当前和以前的注册。

public class Course {

   public int CourseID { get; set; }
   public string Title { get; set; }
   [Index]

   public int Credits { get; set; }
   public virtual ICollection CurrEnrollments { get; set; }
   public virtual ICollection PrevEnrollments { get; set; }
}

如果外键属性未包含在上述类中所示的特定类中，则“代码优先”将创建{Class Name} _ {Primary Key}外键列。生成数据库后，您将看到以下外键。

外键

如您所见，Code First不能单独匹配两个类中的属性。 “注册”的数据库表应为CurrCourse提供一个外键，为PrevCourse提供一个外键，但是Code First将创建四个外键属性，即

  • CurrCourse _CourseID
  • PrevCourse _CourseID
  • Course_CourseID，以及
  • Course_CourseID1

若要解决这些问题，可以使用InverseProperty批注指定属性的对齐方式。

public class Course {

   public int CourseID { get; set; }
   public string Title { get; set; }
   [Index]

   public int Credits { get; set; }
   [InverseProperty("CurrCourse")]

   public virtual ICollection CurrEnrollments { get; set; }
   [InverseProperty("PrevCourse")]

   public virtual ICollection PrevEnrollments { get; set; }
}

如您所见，通过指定所属的Enrollment类的引用属性，将InverseProperty属性应用到上述Course类中。现在，Code First将生成一个数据库，并在“注册”表中仅创建两个外键列，如下图所示。

外键列

我们建议您逐步执行上述示例，以更好地理解。