当惯例规则不符合设计需求时,我们可以使用数据注解配置打造更合适的数据库模型。本文根据示例项目对常用的数据注解属性做一个简要的举例说明。
EFCodeFirst使用的约定大于配置的的编程模式, 这种模式利用默认约定根据我们的领域模型建立概念模型。然我们可以用配置领域来覆盖默认约定。覆盖默认约定主要有两种手段:
1、数据注解属性。
2、FluentAPI。
Key | 数据库中对应为主键 |
TimeStamp | 数据库中对应类型为timestamp类型,主要用于解决高并发问题。注:一个类只能用一次,且修饰的属性必须为byte[]类型 |
ConcurrencyCheck | 数据库中对应列为进行乐观并发检测,主要用于检测高并发问题 |
Required | 属性不能为空,数据库中对应列不能空 |
MinLength/MaxLength | 属性和数据库中最大和最小String长度 |
Schema | 配置实体对应的数据库架构名 |
Table | 配置实体类对应的表名 |
Column | 用于配置实体类中的属性,配置属性对应的数据库列名,顺序和数据类型 |
ForeignKey | 用于属性,指定属性为一个外键 |
NotMapped | 用于实体或者属性,不在数据库中生成映射 |
DataBaseGernerated | 用于属性,设置数据库对应列值的生成,如identity,computed或者none |
新建一个空的控制台应用程序,名叫DADemo,如下图所示:
选择“空CodeFirst模型”建立所需的ADO.NET实体数据模型,如下图所示:
增加Product.cs文件,代码如下图所示:
namespace DADemo
{public class Product{public int Id { get; set; }public string Name { get; set; }public int Price { get; set; }public string Category { get; set; }}
}
在KTStoreModel.cs文件中增加如下代码以支持对应的Product数据存取。
public virtual DbSet<Product> Product { get; set; }
在App.config中修改自动生成的连接字符串为指定字符串。
修改Product.cs中代码为如下图所示:
namespace DADemo
{[Table("KProduct",Shema="MyProduct")]//数据库名称为MyProduct.KProductpublic class Product{[Key]//默认是将Id或者ClassNameId作为主键。通过[key]可以自定义主键,如果是数字类型,则自增public int PId { get; set; }[Required]//属性不能为空[Column("ProductName")][MaxLength(50,ErrorMessage ="字段长度不得大于50"),MinLength(2)]//当程序中此字段保存时长度超过50时,程序会报错public string Name { get; set; }[Column("ListPrice", Order=1,TypeName = "Money")]//映射到数据库中的ListPrice列,并且对应类型是Money,列的顺序是1,order从0开始public int Price { get; set; }[NotMapped]//数据库中没有对应的映射列public decimal SPrice { get; set; }[Index("CategoryIndex",IsUnique = true)]//索引名称为CategoryIndex的唯一索引,直接使用[Index]时索引名词IX_Category.[ForeignKey("CateId")]//指定外键属性public string Category { get; set; }[Required]//属性不能为空[DatabaseGenerated(DatabaseGeneratedOption.Computed)]public DateTime Created { get; set; }[Timestamp]//在update操作时,包含在where子句中public byte[] RowVersion{get;set;}}
}
复合主键
EF6中可以通过Key和Column实现复合主键,如下图所示:
public class Student
{[Key][Column(Order=1)]public int StudentKey { get; set; }[Key][Column(Order=2)]public int AdmissionNum { get; set; }public string StudentName { get; set; }
}
注意:EF Core中不支持通过【key】属性来设置复合主键,可以通过FluentAPI的 hasKey() 方法来实现。
ForeignKey
Foreign注解用以强制指定外键复写惯例原则,当我们需要自行指定作为外键的属性时,可以通过ForeignKey的设置来达到目的。
[Table("Order")]
public partail class Order
{//主键public int OrderId {get;set;}public DateTime OrderDate {get;set;}//导航属性public virtual ICollection<OrderDetail> OrderDetails {get;set;}
}[Table("OrderDetail")]
public partial class OrderDetail
{//主键public int Id {get;set;}public string ProductName {get;set;}public int Quantity{get;set;}public int Price{get;set;}//导航属性public virtual Order MOrder {get;set;}
}
在实际的应用开发中过程中,通常会明确指定外键属性,因此 键属性必须呼符合惯例、数据注解或Fluent API规则。在惯例的原则下,CodeFirst根据导航属性与键名称的组合决定作为外键的属性名称,有以下3中规则:
1、 <导航属性名称><主体主键属性名称>
2、<主体类名称><主键属性名称>
3、<主体主键属性名称>
根据第一个规则,OrderDetail外键的属性是MOrderOrderId。
根据第二个规则,OrderDetail外键的属性是OrderOrderId。
根据第三个规则,OrderDetail外键的属性是OrderId。
如果不想用EF自动创建的外键,而是想把一个属性设置成外键,有以下几种方式:
1、[ForeignKey(导航属性名)] 依赖实体(Student依赖Standard,所以Student是依赖实体)中在我们想设置为外键的属性上指定导航属性。如下图所示:
[Table("OrderDetail")]
public partial class OrderDetail
{//主键public int Id {get;set;}public string ProductName {get;set;}public int Quantity{get;set;}public int Price{get;set;}[ForeignKey("Morder")]public int XOrder//导航属性public virtual Order MOrder {get;set;}
}
2、[ForeignKey(属性名)] 依赖实体中在导航属性上指定属性名。如下图所示:
[Table("OrderDetail")]
public partial class OrderDetail
{//主键public int Id {get;set;}public string ProductName {get;set;}public int Quantity{get;set;}public int Price{get;set;}public int XOrderId;//导航属性[ForeignKey("XOrderId")]public virtual Order MOrder {get;set;}
}
ConcurrencyCheck
首先说明一下悲观并发和乐观并发:
1、悲观并发:比如有两个用户A,B同时登录并修改文档,如果A先修改则系统会把该文件锁住。只有等A修改完并完全退出,B才能继续修改。
2、乐观并发:同上面的例子,A,B两个用户同时登录,A先进入修改B也紧接着进入了。A修改文档的同时B也在修改。如果A在保存之后,B再保存,此时系统检测到数据库文档与B刚进入时候不一样,B保存时会抛出异常,B修改失败。
乐观并发的基本出发点是:当保存数据的时候抱着一种乐观的态度,不期望发生并发冲突,即使万一发生并发冲突,也能捕捉到冲突异常,然后根据策略解决冲突,而解决冲突的方式一般分为Client wins(以后操作者为赢) 和 Store wins(以先存储的数据为赢)。
ConcurrencyCheck属性可以用在领域类的一个或多个属性中,领域类的属性使用它修饰后,数据库中对应的列会启用乐观并发检测。 示例代码如下图所示:
public class Student
{public int StudentId { get; set; }[ConcurrencyCheck]public string StudentName { get; set; }
}