【EFCore】利用Entityframework Core创建数据库模型

利用Entityframework Core创建数据库模型

本文中Entityframework Core版本为v3.1.6

简介

Entity Framework (EF) Core 是微软轻量化、可扩展、开源和跨平台版的常用 Entity Framework 数据访问技术。
EF Core 可用作对象关系映射程序 (O/RM)，以便于.NET开发人员能够使用 .NET 对象来处理数据库，这样就不必经常编写大部分数据访问代码了。

在.NET整个技术栈方向上，EFCore有着举足轻重的地位，它是使用率第一的数据库访问框架，虽然在某些性能速度上不如Dapper、FreeSql等框架，但是在普适性方面是最好的。EFCore支持LINQ和拓展方法的数据库操作，在代码可读性、便捷性都有很大优势。

预先准备

本文的环境是 .NET Core3.1，Entityframwork Core 3.1.x，MS SQL SERVER2019。我们首先创建一个控制台应用，利用dotnet cli、Powershell或VS中的Nuage包管理控制器在项目目录输入以下指令安装必备的包：

这里使用的是 dotnet cli：

dotnet add package Microsoft.EntityFrameworkCore
dotnet add package Microsoft.EntityFrameworkCore.Tools
dotnet add package Microsoft.EntityFrameworkCore.SqlServer
dotnet add package Microsoft.EntityFrameworkCore.Relational
dotnet add package Microsoft.EntityFrameworkCore.Design

数据库上下文

什么是数据库上下文？我在初学EFCore之时也有这种困惑。在EFCore中，DbContext的实现类、子类就是一个数据库上下文。数据库上下文主要是作为承前启后的左右存在，它保存着一切支撑数据库与程序访问的内容。例如以下（节选自知乎用户@付鹏的部分内容）：

....
林冲大叫一声“啊也！”
....

问:这句话林冲的“啊也”表达了林冲怎样的心里？

答:啊你妈个头啊！

看，一篇文章，给你摘录一段，没前没后，你读不懂，因为有语境，就是语言环境存在，一段话说了什么，要通过上下文(文章的上下文)来推断。

事实上EFCore也是这样的，我们在使用EFCore的时候其实是不太关注框架在为我们做了什么。事实上，EFCore中已经保存了各种数据集模型、连接属性等等。

在实际运用中，我们通常这样去实现这样一个数据库上下文：

class TestContext : DbContext
{
    public DbSet Tests { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        base.OnConfiguring(optionsBuilder);
    }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);
    }
}

一般来说写到这个程度也就可以了，我们利用一个类去继承DbContext类，这个类就是我们的数据库上下文了。在这个类中，我们可以配置数据库的相关内容,同时也可以重写部分函数逻辑。

我们可以看到有一个DbSet类型的属性，这就是我们常说的模型实体，在这里他也是一个数据集合。

而OnConfiguring方法就是数据库上下文的配置函数了，里面可以配置数据库的连接、拦截器等等各种东西。OnModelCreating主要用于描述各个实体类之间的关系和实体内部的设置。

我们操作数据库实际上都是在通过数据库上下文进行操作。

模型构建

在EFCore中，无论你采用何种方式构建数据库，我们都应该利用类对模型进行构建，已达到O/RM的效果。这里我们先提出一个简单的问题：

现在有一个简单的学生选课系统的数据库需要构建，已知涉及到了

• 教师数据
• 学生数据
• 课程数据
• 选课数据

请利用EFCore知识进行构建。

这个问题只是在此处提一嘴，因为后面我们的开发都是基于这个假定的数据库模型进行操作构建。

FluentApi与Attribute

首先我们介绍FluentApi和Attribute，这里不会涉及太多的代码，代码方面都在后面的文章中进行阐述。这两个东西主要用于标注实体的特性，例如实体映射的表名、列名等。

FlunetApi通过配置领域类来覆盖默认的约定。在EFCore中，我们通过DbModelBuilder类来使用FluentApi，它的功能比数据注释属性更强大，并且在二者冲突或相同时，EFCore会优先选择FluentApi中所定义的内容。通常我们使用FluentApi都是在OnModelCreating使用，利用DbModelBuilder中的方法和lambda表达式，实现配置整个模型类。举个简单的例子：

protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
    // 指定模型
    modelBuilder.Entity()
        .ToTable("xxx");
    modelBuilder.Entity()
        .HasKey(p=>p.Id);
}

也就是我们通过modelBuilder来指定领域模型类进行设定，这种方式相对来说我比较的推荐，因为它能有效减少问题和方便我们进行维护。

Attribute是通过特性标签的方法来进行设置相关配置，特性标签的文章见：.NET Core CSharp 中级篇2-8 特性标签。通过特性标签去注解领域模型的好处就在于没有额外的配置代码在其他的文件中，有点类似于数据库模型完整对应整个的领域模型类。不过使用Attribute进行操作的时候，对于外键之类的东西，处理起来会非常麻烦，因此不推荐完全使用Attribute的方式对模型进行操作注解。示例如下：

[Table("xxx")]
public class TestModel
{
    [Column("TestId"),Key]
    public int Id {get;set;}
}

至此，文章已经对数据模型的两种配置方式进行了一个非常简单的讲解，接下来，我们将会利用这两种配置方式构建一个简单的数据库。

实体类型

在上下文中包含一种类型的DbSet，这意味着它包含在 EF Core 的模型中;我们通常将此类类型称为实体。EFCore 可以从/向数据库中读取和写入实体实例，如果使用的是关系数据库，EFCore可以通过迁移为实体创建表。也就是说，模型和数据库表是可以画等价关系的。

实体常见的操作是指定表名（或视图）、指定键、指定列和不匹配。对应的FluentApi函数和Attribute如下：

// 指定表名 name为表名，Schema为架构名
[Table(name:"",Schema ="")]
modelBuilder.Entity().ToTable("",schema:"")//或ToView
// 指定主键、外键
[Key]、[ForeignKey]
modelBuilder.Entity().HasKey()//或HasForeignKey、HasNoKey

// 指定列
[Column("")]
modelBuilder.Entity().ToProperty()

// 不匹配(不检索)
[NotMapped]
modelBuilder.Entity().Ingore()//排除属性
modelBuilder.Ignore();

对于定义实体，我们有三种方式可以进行定义：

通过DbSet声明

在数据库上下文中声明的非私有DbSet属性会被EFCore识别成实体模型，DbSet就是数据库映射到程序中的数据集合，对此集合的一切操作都会被视为对数据库的操作。

定义DbSet如下，利用泛型指定实体模型：

public class Context : DbContext
{
    public virtual DbSet TestModels { get; set;}
}

当DbSet所设置的模型下没有使用FluentApi或Attribute时，DbSet的属性名则会对应数据库中实体表的名称。

通过导航属性

导航属性就是一种类之间的关系属性，EFCore在构建我们的数据库模型的时候，并不是单单只盯着被显式声明的内容，EFCore会像递归一样一层一层的进行遍历查找，将有关系的内容统统认证为实体模型。

例如：

public class A
{
    public virtual B B { get; set;}
}
public class B
{
    public virtual A A { get; set;}
}
public class Context : DbContext
{
    public virtual DbSet A { get; set;}
}

像以上这种情况，很明显A，B之间有着一一对应的关系，因此EFCore会将A和B都作为模型实体进行加载，而并不会因为B未声明而不加载。

通过OnModelCreating声明

我们也可以通过重写OnModelCreating声明一个模型类，例如

protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
    // 指定模型
    modelBuilder.Entity();
}

综上所述，EFCore对模型的查找是只要有所提及，无论是显示的利用DbSet或是利用导航属性，亦或是在OnModelCreating中有所提及，都会被作为模型类进行操作。不过在这里，除非是你非常不需要显示声明，否则，建议使用DbSet进行显示声明，避免对开发带来不必要的麻烦。

不过有时候我们不希望我们模型和数据库对应，因为有些模型只是为了辅助存在或作为一个子属性存在，在数据库中并不存在这个表，那么我们可以使用 [NotMapped] 标记，这样该类就不会被EFCore所识别为模型。

示例代码

前文中我们提到了一个学生选课系统的概念模型，这里我们进行一个原始的建库操作。这里会交叉使用FluentApi和Attribute的方式进行书写以方便读者理解。

首先我们建立简单的领域模型

public enum Gender
{
    Male,
    Female
}

[Table("Test_Student")]
public class Student
{
    public int Id { get; set;}
    public string Name { get; set; }
    public Gender Gender { get; set; }
    public string Remark { get; set; }
    public string StudentId{ get; set; }
}

[Table("Test_Teacher")]
public class Teacher
{
    public int Id {get;set;}
    public string Name { get;set; }
    public Gender Gender { get; set; }
    public string Remark { get; set; }
}

public class Course
{
    public int Id {get;set;}
    public string Name {get;set;}
    public string CourseId{ get; set; }
}
public class Context : DbContext
{
    public virtual DbSet Students { get; set;}
    public virtual DbSet Teachers { get; set;}
    public virtual DbSet Courses { get; set;}
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity().ToTable("Test_Student");
    }
}

这样我们就大概做好了一个简单的数据库框架，不过这个数据模型是不符合我们实际设计的模型的，这里只作为讲解作用，并不作为实际项目的设计。

属性类型和转换

光有表设置显然是不够的，我们还需要对表中的字段和属性进行设置。表中的字段，如果是非引用类型，都会被识别成数据库中的列，引用类型在表中通常会作为导航属性存在。按照约定，具有getter和setter的所有公共属性都将包括在模型中映射到表中的列。接下来仍然会分为FluentApi和Attribute进行编写。

在数据库中，我们对一个列的常见操作通常就是操作列名、列类型、排序规则、可空等。这里进行一个归纳和整理

属性类型示例

这里先用数据注解Attribute的方式进行操作，限于篇幅，在此仅对一个类进行操作，读者可根据自己需求对其他类进行编写。

[Table("Test_Student")]
public class Student
{
    public int Id { get; set;}
    //属性不能为空
    [Required]
    // 列名，排序顺序，列类型
    [Column(name:"Name",Order =1,TypeName ="varchar(25)")]
    //等效于[Column(name:"",Order =1,TypeName ="varchar(25)"),Required]
    //属性后接等号就是默认值的设置方法
    public string Name { get; set; } = "abcd";
    public Gender Gender { get; set; }
    // 也可以通过设置maxLength属性进行限制长度
    [Column("Remark"),MaxLength(150)]
    public string Remark { get; set; }
    public string StudentId{ get; set; }
}

设置可空类型则是在类型后加？号，但是通过数据标注的方式进行设置的方法作者查阅了文档和资料并没有发现，只有FluentApi可以设置。应该是微软直接默认就是空，因此无需指定设置。

这里是FluentApi的方式

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity().ToTable("Test_Student");
        modelBuilder.Entity().Property(p => p.Name)
            //非空
            .IsRequired()
            //列名
            .HasColumnName("Name")
            //列类型
            .HasColumnType("varchar(25)")
            //默认值
            .HasDefaultValue("");
        modelBuilder.Entity().Property(p => p.Remark)
            //可空
            .IsRequired()
            //列名
            .HasColumnName("Remark")
            //可使用.IsFixedLength()设置为定长
            //列最大长度
            .HasMaxLength(150);
    }

值映射转换

值转换提供了在写入数据库前的一次数据处理，试想一下，假如你不希望将加密过程放在业务层，或者说你习惯用枚举去存储一些值，但是在数据库中实际需要使用枚举名而不是枚举值，那么我们就需要进行值映射转换。

值转换只在FluentApi中提供，我们可以在OnModelCreating中进行定义，例如：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity().Property(p => p.Gender)
        .HasConversion(
            p => p.ToString(),
            p => (Gender)Enum.Parse(typeof(Gender), p));
}

在这里，第一个lambda表达式表示你的模型出，第二个则是数据库映射回你的模型类所需的处理。你也可以使用ValueConverter类来定义，例如：

var converter = new ValueConverter(
    p => p.ToString(),
    p => (Gender)Enum.Parse(typeof(Gender), p));

将此对象传入HasConversion方法亦可。

键与索引

键是数据库最精华的部分了，键又被成为码，是关系模型的重要概念，它是数据库的逻辑部分，并不是数据库的物理结构。通常情况下，键（非外键）时不可以被重复的。

主键和备用（候选）键

主键用于唯一标识一条数据，在我们的数据库教程中讲到，主键可以是一个值，也可以是组合值。

候选键有两个要求：始终能够确保在关系中能唯一标识元组；在属性集中找不出真子集能够满足条件。其中第一个条件就是超键的标准，所以我们可以把候选键理解为不能再“缩小”的超键。

这里我们依旧使用两种方式进行编写。

索引

索引可以理解为书籍的目录，这将会是数据库的查询更加快速，默认情况之下，索引并不唯一。索引不能使用数据批注创建索引，可以使用FluentApi按如下方式为配置指定索引：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder
        .Entity()
        .HasIndex(p=>p.StudentId)
}

当然，如果有需要，你也可以对多个列进行索引定义，并且可以指定索引的名称，同时可以将索引修改成唯一值：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder
        .Entity()
        .HasIndex(p=>new {p.Name,p.StudentId})
        .HasName("Test")
        .IsUnique();
}

索引也有一些较为高级的用法，例如索引过滤器以及索引包含列。

过滤器可以对索引进行筛选，只针对部分数据建立索引，从而减少对硬盘空间的需求，如下所示：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder
        .Entity()
        .HasIndex(p=>p.StudentId)
        .HasFilter("[StudentId] IS NOT NULL");
}

包含列是某些关系数据库允许配置一组列，这些列包含在索引中，但不是其的一部分。 当查询中的所有列都作为键列或非键列包含在索引中时，这可以显著提高查询性能，因为表本身无需访问。例如：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder
        .Entity()
        .HasIndex(p=>p.StudentId)
        .IncludeProperties(p=>new {p.Name});
}

对于上面的内容，你使用StudentId的时候可以便捷的使用整个索引，但是当你仅需要访问Name时，便不会加载索引，这样对整体的性能有显著的提高。

从属实体（值实体）与无键实体

从属实体

从属实体就是一个属性集合，但是它并不作为一个完整的实体存在，它是所有者的一部分。例如你的家庭住址信息，它并不适合在你的个人信息表中存在，如果将其放置在你的个人信息表中，会使得你的表过于冗余。如果没有实体，从属实体是毫无意义的。并且通常而言从属实体并不唯一且从属实体的状态并不一定实时随实体改变，举个例子，点外卖的时候，你的个人信息和你的收货地址的关系就是一个实体和从属实体的关系，你下单时的地址和你修改了收获地址时没有关系的，并且对于地址而言，倘若脱离了个人信息时毫无意义的。

使用从属实体可以用数据标签（EF Core>2.1）和FluentApi的方式，这里引用官方文档的例子：

[Owned]
public class StreetAddress
{
    public string Street { get; set; }
    public string City { get; set; }
}
public class Order
{
    public int Id { get; set; }
    public StreetAddress ShippingAddress { get; set; }
}
//或者
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity().OwnsOne(p => p.ShippingAddress);
    //倘若ShippingAddress是私有属性，则可以使用以下
    modelBuilder.Entity().OwnsOne(typeof(StreetAddress), "ShippingAddress");
}

无键实体

无键实体就很简单了，就是没有主键的实体，但是和从属实体是有区别的，假如有一个表是记录各个班级人数的表，那么它其实就不是那么需要主键。定义如下：

[Keyless]
public class ClassCount
{
    public string Name { get; set; }
    public int Count { get; set; }
}
// 或
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity()
        .HasNoKey();
}

无键实体也不一定对应一张实体表，也有可能是一个视图等这种没有主键的数据。它们不同于常规实体类型，因为它们：

• 不能定义键
• 永远不会对DbContext中的更改进行跟踪，因此不会在数据库中插入、更新或删除这些更改，你需要手动调用对应方法进行操作。
• 绝不会按约定发现。
• 仅支持导航映射功能的子集，具体如下：
  • 它们永远不能充当关系的主体端
  • 它们可能没有到拥有的实体的导航
  • 它们只能包含指向常规实体的引用导航属性
  • 实体不能包含无键实体类型的导航属性

隐藏(Shadow)属性与自动生成属性

隐藏(Shadow)属性

隐藏属性就是在数据库生成时，你在类中未定义却在表中出现的一些属性。例如你定义了外键导航属性却并未定义外键属性，那么EF会生成一个自动的属性去做外键关系。同时还有主键，EF默认一切实体都有主键，即使你不定义主键，EFCore也会生成一个自增的Id作为表的主键。

有时候隐藏属性也可以是你未映射到类中的列，或者你也可以用以下方法设定隐藏属性:

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder
        .Entity()
        .Property("LastUpdated");
}

访问隐藏属性则通过EF的拓展方法进行访问，如下：

context.Entry(student).Property("LastUpdated").CurrentValue = DateTime.Now;
//或在Linq
var blogs = context.Student
    .OrderBy(b => EF.Property(b, "LastUpdated"));

自动生成属性

自动生成属性就是分为两种，在添加数据时自动生成值或在数据是更新值。

在添加、更新时生成值可以使用数据注释和FluentApi定义，具体如下：

public class Student
{
    //自增
    [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
    //[DatabaseGenerated(DatabaseGeneratedOption.Computed)] 在更新时生成
    public int Id { get; set;}
}
// 或
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity()
        .Property(b => b.Id)
        .ValueGeneratedOnAdd();
}

我们还可以设置计算列，有些列需要在更新或添加时通过表中的数据进行计算，那么我们可以使用fluentApi进行实现：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity()
        .Property(p => p.DisplayName)
        .HasComputedColumnSql("[LastName] + ', ' + [FirstName]");
}

我们也可以配置一些默认值，直接对类中属性进行操作也没有问题，但是也可以使用FluentApi的方法：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity()
        .Property(b => b.EditTime)
        .HasDefaultValueSql("getdate()");
}

关系型数据

关系型数据库是目前数据库的主流，同时，在绝大多数数据库的设计上，都会涉及到表之间的关系。

一对一

一对一关系就是A表中的一条数据和B表中的一条数据是一一对应关系，例如一个人的身份证和他的社保就是一种一一对应给的关系。在EF中进行配置的时候，我们需要在A，B表中定义相关的导航属性，并且设置好相关的外键，在配置的时候需要设置好外键所在的类，例如：

public class A
{
    public int BId { get; set; }
    public B B{ get; set; }
}
public class B
{
    public A A{ get; set; }
}
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity()
        .HasOne(p => p.B)
        .WithOne(p => p.A)
        .HasForeignKey(p=>p.BId};
}

如果你不指定外键，EFCore会默认生成一条外键的隐藏属性。

一对多

一对多关系就类似于学生和班级，一个学生只有一个班级，但是一个班级有许多学生，配置方法和一对一类似，但是值得注意的是，外键始终在“一”的那个表中。

public class A
{
    public int BId { get; set; }
    public B B{ get; set; }
}
public class B
{
    //也可以使用IList，IEnumerable作为多的关系
    public ICollection As{ get; set; }
}
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity()
        .HasOne(p => p.B)
        .WithMany(p => p.A)
        .HasForeignKey(p=>p.BId};
}

多对多

多对多的关系就不展开赘述，简要提一句，多对多关系是无法通过EF配置的，我们需要引入一个中间表，将关系转化成和中间表的一对多关系就可以曲线救国实现多对多关系。

数据库迁移

数据库的迁移就是将你的类数据迁移至数据库转换为表数据，这里你需要安装dotnet-ef或Nuget包"Microsoft.EntityframeworkCore.Tools、Microsoft.EntityframeworkCore.Design"，并且配置好DbContext。使用包管理控制台或普通控制台。

Nuget包管理控制台:

Add-Migrations [name]
Update-Database

普通控制台使用dotnet-ef

dotnet ef migration add [name]
dotnet ef database update

如果你的类配置完全正确，那么你所连接的数据库将会自动的生成你的表数据。

分散配置关系型数据库

有时候我们的表的配置会非常多，并且数据库所需要配置的表又非常多的时候，我们最好使用一个单独的类进行配置各个表，使得代码可读性、维护性更高，我们需要创建一个类去继承EF的配置接口，例如：

public class TestMap : IEntityTypeConfiguration
{
    public void Configure(EntityTypeBuilder builder)
    {
    }
}

这样你就可以在不同的类中进行数据库的配置了。

更多内容请关注我的BiliBili地址以及我的博客。

Github

BiliBili主页

WarrenRyan's Blog

博客园