在《C# 数据操作系列 - 5. EF Core 入门》篇中,我们简单的通过两个类演示了一下EF增删改查等功能。细心的小伙伴可能看了生成的DDL SQL 语句,在里面发现了些端倪。没看的小伙伴也不急,这就贴出来。
public class ModelA { public int Id { get; set; } public string Name { get; set; } public List<ModelB> ModelBs { get; } = new List<ModelB>(); } public class ModelB { public int Id { get; set; } public string Name { get; set; } public int ModelAId { get; set; } public ModelA modelA { get; set; } }DDL SQL:
CREATE TABLE "ModelBs" ( "Id" INTEGER NOT NULL CONSTRAINT "PK_ModelBs" PRIMARY KEY AUTOINCREMENT, "Name" TEXT NULL, "ModelAId" INTEGER NOT NULL, CONSTRAINT "FK_ModelBs_ModelAs_ModelAId" FOREIGN KEY ("ModelAId") REFERENCES "ModelAs" ("Id") ON DELETE CASCADE ); -- auto-generated definition create table ModelAs ( Id INTEGER not null constraint PK_ModelAs primary key autoincrement, Name TEXT ); 1. 映射规则通过简单的示例,我们可以看到EF的映射规则是什么。基于约定由于配置的原则,EF把实体类当做是一个单数形式的类型描述,把表认为是实体类的集合,所以表名为类名的复数形式。
对于主键,默认情况下EF会检索实体类有没有名为Id或者类名+Id的属性,如果有EF则认为这个属性是主键,否则会认为该类没有设置主键。EF检索到主键的类型是数字类型的话,会自动添加自增长的约束。
对于其他属性,EF会自动按照同名的形式映射到数据表中。
对于外键,如果在类里添加了引用类型,而这个引用类型也在EF的上下文中,EF会把这种属性称为导航属性。EF一旦在类里检索到了导航属性,就会去寻找对应的外键。EF会认为 属性名+Id或者类名+Id 可能是外键属性,如果找到名称一致且类型与导航属性目标类的主键类型一致,则认为是外键。如果类型不一致,EF则认为该类设置有误。如果没找到符合名称要求的属性,EF会自己添加一个外键属性。
对于一对一,EF要求导航属性双方都应该具有外键配置。
一对多,EF要求多的一方设置外键。同时如果在一方这边设置了集合类型的导航属性,那么EF会自动到目标类里寻找外键属性。
说完了一对一和一对多,那么多对多呢?
如果没有声明的话, EF会生成一个中间表。
2. 修改映射关系EF允许开发人员指定自己的映射规则或者单个类的映射规则。EF 提供了几种方式来修改映射关系。
2.1 数据注解EF允许开发人员通过使用Attribute标记,来约定映射关系。
先引入命名空间:
using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations.Schema;常见的注解如下:
[Table("ModelA")]TableAttribute 表示实体映射的哪张表
[Key]KeyAttribute 用来标记哪个属性是主键
[DatabaseGenerated(DatabaseGeneratedOption.Identity)]用来表示这个字段在第一次插入数据库时,值由数据库提供
[ForeignKey("ModelAId")]表示该导航属性具体值由 名称为 ModelAId 的属性维护,如果没有该属性,EF则记录添加但不对外显示。
[InverseProperty("Author")]用在集合类型的属性上,表示该集合属性是与源类哪一个导航属性相关。
[Column]表示列,用来设置一些列的基本参数,比如类型、名称
[Required]表示该列在插入数据库时不能为空
使用注解进行相关配置相当简单,但是这样不可避免的需要修改模型类而且需要引入额外的命名空间,不太符合某些要求严格的项目,所以微软又提供了另外一套写法。
2.2 Fluent 方式当我们使用这种方式的时候,会面临一个问题:是新建一个配置类呢,还是在 EF上下文的OnModelCreating方法里统一配置呢?
我们先看一下EF上下文的OnModelCreating的声明是什么:
protected internal virtual void OnModelCreating(ModelBuilder modelBuilder);这里有一个ModelBuilder类型,查看它的API发现两个方法:
public virtual Microsoft.EntityFrameworkCore.ModelBuilder ApplyConfiguration<TEntity> (Microsoft.EntityFrameworkCore.IEntityTypeConfiguration<TEntity> configuration) where TEntity : class; public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder<TEntity> Entity<TEntity> () where TEntity : class;继续寻找 IEntityTypeConfiguration,看到这个接口只有一个方法:
void Configure(EntityTypeBuilder<TEntity> builder);两个都指向了 EntityTypeBuilder<TEntity> builder,而这个正是Fluent API配置类的关键。所以通过分析API,我们可以得到这两种写法。
那么,这两种的取舍呢?
在项目比较小,数据类很少的时候,可以直接在OnModelCreating里写。否则,更建议继承一个Configuration接口。