Part3-4&5 EF CORE-FluentAPI&Data Annotation(杨中科)

一、概览

二、约定(默认)配置(仅列出最常用几项)

  • 表名采用DbContext中的对应的DbSet的属性名。例如下图,创建一个Movie的表。


    image.png
  • 数据表列的名字采用实体类属性的名字,列的数据类型采用和实体类属性类型最兼容的类型。如下图1:


    图1
  • 数据表列的可空性取决于对应实体类属性的可空性
  • 名字为Id或“实体类型+Id”的属性默认为主键,如果主键是short int long类型,默认采用自增字段;如果主键为Guid类型,默认采用默认的Guid生成机制生成的主键。

三、FluentAPI使用方法

  • 列的数据类型、表名,可以自行写配置文件覆盖默认(约定)配置,这种方式又称为FluentAPI:把配置文件写到单独的配置类中,优点是可以解耦,缺点是相对复杂
    image.png
  • 如何写配置文件:
    1、针对每个具体实体类写一个实现IEntityTypeConfiguration<>抽象接口的Configure类的配置类,命名是实体类名+Config,具体配置内容(调用FluentAPI,FluentAPI常规用法详见下方六、FluentAPI)放在Configure方法中,例如针对Book类写一个配置类
      public class BookConfig : IEntityTypeConfiguration<Book>
      {
          public void Configure(EntityTypeBuilder<Book> builder)
          {
              builder.ToTable("T_Books"); //实体对应T_Books这张表,创建表用T_Books作为表名 覆盖DbSet的属性值
              builder.Property(b=>b.Title).HasMaxLength(50).IsRequired(); //限定数据类型 覆盖实体类的数据类型
          }
      }
    
    2、在继承了DbContext类的OnModelCreating方法中中加载所有的配置。
    3、public DbSet<Book> Books { get; set; },每个实体类都要定义DbSet<>类型的属性
      public class MyDdContext:DbContext
      {
          public DbSet<Book> Books { get; set; }
          protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
          {
              base.OnConfiguring(optionsBuilder);
              optionsBuilder.UseSqlServer("Data Source=DESKTOP-E3D2J8F\\SQLEXPRESS;" +
                  "Initial Catalog=ImportExcelMVCTest;User ID=sa;Password=123456;TrustServerCertificate=true");
          }
          //从指定的程序集里面加载所有config
          protected override void OnModelCreating(ModelBuilder modelBuilder)
          {
              base.OnModelCreating(modelBuilder);
              //从当前程序集加载所有的IEntityTypeConfiguration
              modelBuilder.ApplyConfigurationsFromAssembly(this.GetType().Assembly);
          }
      }
    

四、Data Annotation

  • 将配置以特性(Annotation)的形式标注在实体类中。
  • Annotation方法也会更加简单,但是耦合性高,与FluentAPI相反。
  • 可以映射到前端做数据校验,官方MVC入门Demo-添加校验使用了此功能用于表单提交数据的数据校验。
  [Table("T_Books")] //设置实体类Book的表名
  public class Book
  {
      [Required]
      [MaxLength(22)]
      public long Id { get; set; } //主键
      public string? Title { get; set; } //标题
      public DateTime PubTime { get; set; } //发布日期
      public double Price { get; set; } //单价
  }

五、Data Annotation与FluentAPI使用建议

  • 二者可以混合使用,二者功能几乎重叠,但是从长远看建议只使用FluentAPI形式
  • 二者的用法微软EF Core官方文档已经将其做了对比说明,根据项目需要进行学习可以做到无缝衔接。
    image.png

六、FluentAPI(仅部分,更多可详见官方文档

总结:

  • EF Core高级特性谨慎使用(例如:Ignore、Shadow、Table Splitting),容易提高系统复杂性,避免与业务逻辑混合在一起。
  • 尽量在效率和复杂性之间找到一个平衡点,而并非一味的追求高效率而提高复杂性,或者一味的追求简单而降低效率。
  • Dapper简单、生产效率低,EF Core复杂、生产效率高,基于第二条的原则要让EF Core的使用Dapper化

七、FluentAPI语法糖

  • 方法重载,多种调用方式
    以下两种方法作用一致,建议使用第一种,因为如果出现属性名(Title)写错在编译层面就会直接报错
    builder.Property(b => b.Title).HasDefaultValue("Hello"); //第一种
    builder.Property("Title").HasDefaultValue("Hello"); //第二种
    
  • 链式编程风格
    builder.Property(b => b.Title).HasDefaultValue("Hello").HasColumnName("_title").HasMaxLength(20);
    
  • 错误的链式编程风格
    以下代码会报错
    HasIndex()返回值是IndexBuilder<TEntity>,而Ignore()方法是EntityTypeBuilder<>类的方方法。
    builder.ToTable("T_Books").HasIndex(b => b.Title).Ignore(b => b.PubTime);
    
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,919评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,567评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,316评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,294评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,318评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,245评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,120评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,964评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,376评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,592评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,764评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,460评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,070评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,697评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,846评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,819评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,665评论 2 354

推荐阅读更多精彩内容