目录
1.准备条件
开发软件:VisualStudio2022,EFCore6.0
.net Core版本:.Net6.0
数据库:mysql8.0
数据库管理软件:Navicat
2.EFCore的使用流程
通过前面的描述我们来总结下,使用EFCore(CodeFirst)的基本流程:
- 创建 DbContext 实例 根据上下文跟踪实体实例。
- 创建 实体模型,在DbContext 实例类中添加DbSet<实体>属性。
- 根据业务需求进行增删改查, 调用 SaveChanges 或 SaveChangesAsync,将更改应用到数据库
3.DBContext中的配置
前面已经说过,除非你的数据库已经存在,否则不推荐使用反向工程来通过数据库创建模型,一般推荐使用CodeFirst模式,即代码先行的原则。
在DBContext类中,最重要,也是我们最常用的两个方法就是:
"OnConfiguring"和 “OnModelCreating” 如下:
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
if (!optionsBuilder.IsConfigured)
{
optionsBuilder.UseMySql("server=172.10.14.144;database=EFCoreLearn;user=root;password=123456", Microsoft.EntityFrameworkCore.ServerVersion.Parse("8.0.28-mysql"));
}
}
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.UseCollation("utf8_general_ci")
.HasCharSet("utf8");
modelBuilder.Entity<Student>(entity =>
{
entity.Property(e => e.Class).HasMaxLength(50);
entity.Property(e => e.Name).HasMaxLength(50);
});
OnModelCreatingPartial(modelBuilder);
}
3.1 OnConfiguring
在创建自己的DbContext子类时,重写此方法可以自己进行数据库的配置,以及其他选项的配置。其中主要有以下常用的配置:
- 配置连接字符串
- 配置输出的Logger
- 配置过滤和拦截操作
- 禁用和启用并发
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
if (!optionsBuilder.IsConfigured)
{
optionsBuilder.UseMySql("server=172.10.14.144;database=EFCoreLearn;user=root;password=123456", Microsoft.EntityFrameworkCore.ServerVersion.Parse("8.0.28-mysql"));
optionsBuilder.LogTo(Console.WriteLine);//日志输出到控制台
optionsBuilder.AddInterceptors(new SoftDeleteInterception()); //添加拦截器软删除
optionsBuilder.EnableThreadSafetyChecks(false);//关闭并安全检测
}
}
}
过滤拦截配置,是在数据库连接的时候,执行命令的时候,或者保存的时候执行的一些特所的操作,一般要实现继承以下几个类实现自己的定义操作:
抽型类
- DbConnectionInterceptor —数据库连接的时候进行一些操作
- DbTransactionInterceptor —数据库执行时候的时候进行一些操作
- DbCommandInterceptor —数据库执行命令的时候进行一些操作
- SaveChangesInterceptor —数据库保存的时候进行一些操作
以下为相同含义的接口 - IDbCommandInterceptor
- IDbConnectionInterceptor
- IDbTransactionInterceptor
- ISaveChangesInterceptor
3.2 OnModelCreating
重写此方法,可以对实体类也可以说是数据表进行模型配置。
模型配置主要分为两种方法:
- FluentAPI
- 数据注解
在OnModelCreating里使用的是fluentAPI
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.UseCollation("utf8_general_ci")
.HasCharSet("utf8");
modelBuilder.Entity<Student>(entity =>
{
entity.Property(e => e.Class).HasMaxLength(50);
entity.Property(e => e.Name).HasMaxLength(50);
});
}
4.实体配置之FluentAPI
采用FluentAPI配置实体类,或者说对实体进行设置。有两种方式,第一种方式是通过上面介绍的在OnModelCreating里进行配置。除此之外,如果数据库有很多表,对应的实体也很多,那么都写在OnModelCreating方法里将会造成代码很多,不方便阅读。
所以,还有第二种方法进行配置,那就是创建实现了IEntityTypeconfiguration接口的实体类。然后再在OnModelCreating方法里添加如下方法:
modelBuilder.ApplyConfigurationsFromAssembly(this.GetType().Assembly);
下面新建一个新的控制台程序,按照前面的步骤,安装Nuget包,新建一个EFLearnDbcontext类,然后新建一个实体类Student
public class Student
{
public long Id { get; set; }
public string Name { get; set; }
public string Class { get; set; }
public int Age { get; set; }
public string Sex { get; set; }
}
新建一个学生配置配置类:
public class StudentConfig : IEntityTypeConfiguration<Student>
{
public void Configure(EntityTypeBuilder<Student> builder)
{
builder.HasKey(x => x.Id); //设置主键
builder.Property(x => x.Id).ValueGeneratedOnAdd();//设置Id自增
//设置姓名最大长度为50,字符为unicode,不能为空
builder.Property(x=>x.Name).HasMaxLength(50).IsUnicode().IsRequired();
//设置班级最大长度为50,字符为unicode,不能为空
builder.Property(x=>x.Class).HasMaxLength(50).IsUnicode().IsRequired();
//设置性别最大长度为5 字符为Unicode,不能为空
builder.Property(x=>x.Sex).HasMaxLength(5).IsUnicode().IsRequired();
}
}
在EFLearnDbContext中的OnModelCreating里添加下面的代码
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.ApplyConfigurationsFromAssembly(this.GetType().Assembly);
}
最后进行迁移。可以看到新建的数据库如下:
可以看到代码生成的数据库表和我们自己在代码配置的是一致的。
当然如果不建立单独的配置类,可以在OnModelCreating方法里添加如下代码,也可以实现一样的功能。
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
#region Student配置
modelBuilder.Entity<Student>().HasKey(x=>x.Id); //设置主键
modelBuilder.Entity<Student>().Property(x => x.Id).ValueGeneratedOnAdd();//设置Id自增
//设置姓名最大长度为50,字符为unicode,不能为空
modelBuilder.Entity<Student>().Property(x => x.Name).HasMaxLength(50).IsUnicode().IsRequired();
//设置班级最大长度为50,字符为unicode,不能为空
modelBuilder.Entity<Student>().Property(x => x.Class).HasMaxLength(50).IsUnicode().IsRequired();
//设置性别最大长度为5 字符为Unicode,不能为空
modelBuilder.Entity<Student>().Property(x => x.Sex).HasMaxLength(5).IsUnicode().IsRequired();
//modelBuilder.ApplyConfigurationsFromAssembly(this.GetType().Assembly);
#endregion
}
5.实体配置之数据注解
除了上述方法还有一种更简单的方法用来配置实体类,就是在类上直接配置。
public class Student
{
[Key]
public long Id { get; set; }
[MaxLength(50)]
[Unicode]
[Required]
public string Name { get; set; }
[MaxLength(50)]
[Unicode]
[Required]
public string Class { get; set; }
public int Age { get; set; }
[MaxLength(50)]
[Unicode]
[Required]
public string Sex { get; set; }
}
6.对比总结
上述方法中的两种约定配置,可以混用,但是不推荐。
数据注解的方式 优点:简单方便;缺点:耦合性太高;
FluentAPI 优点:解耦; 缺点: 编写复杂
Entity Framework Core Fluent API配置了模型的以下方面:
表和列的配置
EFCore默认采用和类一样的名称创建表名字,按照类的属性名称创建表中列的名称,如果需要不同的名称,可以采用下面的方法。
- 表名称
//注解方法
[Table("Student")]
public class NewStudent //NewStudent 对应着 Student表
//FluentAPI方法
modelBuilder.Entity<NewStudent>().ToTable("Student");
- 列名称
//数据注解
[Column("Gender")]
public bool IsFemale { get; set; }
//FluentAPI
modelBuilder.Entity<NewStudent>().Property(s => s.IsFemale).HasColumnName("Gender");
- 列注释 可以对数据库列设置任意文本注释
//注解方法
[Comment("学生学号")]
public string Id{ get; set; }
//FluentAPI
modelBuilder.Entity<Student>().Property(b => b.Id)
.HasComment("学生学号");
- 列顺序
默认情况下,在使用迁移创建表时,EF Core 首先为主键列排序,然后为实体类型和从属类型的属性排序,最后为基类型中的属性排序。 但是,你可以指定不同的列顺序
//注解方法
[Column(Order = 0)]
public int Id { get; set; }
[Column(Order = 1)]
public int Name{ get; set; }
//FluentAPI
modelBuilder.Entity<Employee>(x =>
{
x.Property(b => b.Id)
.HasColumnOrder(0);
x.Property(b => b.Name)
.HasColumnOrder(1);
});
- 列类型
HasColumnType("varchar(200)") /[Column(TypeName = "varchar(200)")]
约束性配置
- 最大长度 字符串或者数组类型最大的长度
[MaxLength(500)]/HasMaxLength(500);
- 精度和小数位数
[Precision(14, 2)]/HasPrecision(14, 2)
- Unicode 在某些关系数据库中,存在不同的类型来表示 Unicode 和非 Unicode 文本数据
[Unicode(false)]/IsUnicode(false)
- 必需和可选属性
配置字段是否为可空null,如果隐式的使用了C#的可空类型,可以不用配置。
在.NET 类型不能包含 null 的属性将配置为必需属性。 例如,将具有 .NET 值类型的所有属性 (int,decimal,bool、) 等等) 配置为必需,并且所有具有可为 null 的 .NET 值类型 (int?decimal?等bool?属性都配置为可选。
下面的方式是显性配置
[Required]/IsRequired()
- 忽略
[NotMapped]/.Ignore() //标记模型某个属性可以使该属性不必映射到数据库。
键配置
在EFCore约定中没有显示的指定键,那么默认名为 类名+Id结尾 的属性将被配置为实体的主键。
[Key]/HasKey(c => c.Id)
- 组合键 多个属性配置为实体的键 - 这称为组合键。 组合键只能使用 Fluent API 进行配置
modelBuilder.Entity<Car>().HasKey(c => new { c.State, c.LicensePlate });
自增和默认设置
自增
[DatabaseGenerated(DatabaseGeneratedOption.Identity)]/ValueGeneratedOnAdd();
默认值
HasDefaultValue(3);/.HasDefaultValueSql("getdate()");
关系型
关系型大部分只能用FluentAPI,关系型是描述实体类型也就是表之间的关系
.HasOne(b => b.BlogImage).WithOne(i => i.Blog);//一对一
.HasOne(p => p.Blog).WithMany(b => b.Posts); //一对多
.HasMany(p => p.Tags).WithMany(p => p.Posts);//多对多
索引配置
[Index(nameof(Url))]/HasIndex(b => b.Url);//
[Index(nameof(FirstName), nameof(LastName))]/ .HasIndex(p => new { p.FirstName, p.LastName });//复合索引
[Index(nameof(Url), IsUnique = true)]/.HasIndex(b => b.Url).IsUnique();//唯一索引