ASP.NET Core 3.1系列（16）——EFCore之Code First

已于 2022-12-05 09:50:19 修改
阅读量3.6k 收藏 14
点赞数 2
分类专栏： ASP.NET Core C# 文章标签： asp.net 数据库 microsoft
于 2022-12-01 14:14:01 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/HerryDong/article/details/128115133
版权
C# 同时被 2 个专栏收录
72 篇文章 18 订阅
订阅专栏
ASP.NET Core
32 篇文章 43 订阅
订阅专栏

1、前言

前一篇博客介绍了EFCore中的DB First开发模式，该模式可以根据数据库生成实体类和数据库上下文，因此适用于数据库已经存在的场景。而与之相对应的，Code First主要是根据自定义的实体类和数据库上下文反向构建数据库，因此也可以看做是DB First的逆过程，下面开始介绍。

2、定义实体类和数据库上下文

新建一个Web API项目，使用NuGet引入如下组件：

Microsoft.EntityFrameworkCore
Microsoft.EntityFrameworkCore.SqlServer
Microsoft.EntityFrameworkCore.Design
Microsoft.EntityFrameworkCore.Tools

新建实体类Author、数据库上下文DaoDbContext，如下图所示：

在这里插入图片描述
DaoDbContext的代码如下所示：

using App.Models;
using Microsoft.EntityFrameworkCore;

namespace App.Context
{
    public class DaoDbContext : DbContext
    {
        public DaoDbContext()
        {

        }

        public DaoDbContext(DbContextOptions<DaoDbContext> options) : base(options)
        {

        }

        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        {
            optionsBuilder.UseSqlServer("Data Source=DSF-PC;Initial Catalog=Dao;User ID=sa;Password=123456;");
        }

        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            modelBuilder.Entity<Author>();
            base.OnModelCreating(modelBuilder);
        }

        public virtual DbSet<Author> Author { get; set; }
    }
}

Author先不用添加代码：

namespace App.Models
{
    public class Author
    {

    }
}

3、基于Data Annotations的Code First

3.1、定义主键——[Key]

Code First模式通过实体类生成数据表，而数据表必然含有一个主键，在Code First中可以使用[Key]来标识实体类中的主键字段，代码如下：

using System.ComponentModel.DataAnnotations;

namespace App.Models
{
    public class Author
    {
        /// <summary>
        /// 主键
        /// </summary>
        [Key]
        public int Id { get; set; }
    }
}

在NuGet控制台中输入如下命令：

Add-Migration m1

然后更新数据库：

Update-Database

打开数据库查看新生成的Author数据表，可以看到主键字段Id已经生成，如下图所示：

在这里插入图片描述

3.2、定义文本长度——[StringLength]、[MinLength]、[MaxLength]

在数据库中，部分字段的类型可能是varchar或nvarchar，此时可以通过[StringLength]、[MinLength]、[MaxLength]对其长度进行标识。在Author中新增Name和Address字段，代码如下：

using System.ComponentModel.DataAnnotations;

namespace App.Models
{
    public class Author
    {
        /// <summary>
        /// 主键
        /// </summary>
        [Key]
        public int Id { get; set; }

        /// <summary>
        /// 姓名
        /// </summary>
        [MinLength(2)]
        [MaxLength(20)]
        public string Name { get; set; }

        /// <summary>
        /// 地址
        /// </summary>
        [StringLength(40)]
        public string Address { get; set; }
    }
}

在NuGet控制台中输入如下命令：

Add-Migration m2

然后更新数据库：

Update-Database

打开数据库查看新生成的Author数据表，可以看到Name和Address字段已经生成，其中Name字段最大长度为20，Address字段最大长度为40，如下图所示：

在这里插入图片描述

3.3、字段不能为NULL——[Required]

在数据表中，主键不能为NULL。如果希望其他字段也不能为NULL，则可以使用[Required]进行标识，下面对Author进行修改，规定Name字段不能为空，代码如下：

using System.ComponentModel.DataAnnotations;

namespace App.Models
{
    public class Author
    {
        /// <summary>
        /// 主键
        /// </summary>
        [Key]
        public int Id { get; set; }

        /// <summary>
        /// 姓名
        /// </summary>
        [Required]
        [MinLength(2)]
        [MaxLength(20)]
        public string Name { get; set; }

        /// <summary>
        /// 地址
        /// </summary>
        [MinLength(5)]
        [MaxLength(40)]
        public string Address { get; set; }
    }
}

在NuGet控制台中输入如下命令：

Add-Migration m3

然后更新数据库：

Update-Database

打开数据库查看新生成的Author数据表，可以看到Name被定义为不能为NULL，如下图所示：

在这里插入图片描述

3.4、忽略映射字段——[NotMapped]

在某些情况下，实体类中的部分字段并不需要在数据库中生成对应的字段，此时就可以使用[NotMapped]进行标识。下面对Author进行修改，添加一个Info字段，代码如下：

using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;

namespace App.Models
{
    public class Author
    {
        /// <summary>
        /// 主键
        /// </summary>
        [Key]
        public int Id { get; set; }

        /// <summary>
        /// 姓名
        /// </summary>
        [Required]
        [MinLength(2)]
        [MaxLength(20)]
        public string Name { get; set; }

        /// <summary>
        /// 地址
        /// </summary>
        [MinLength(5)]
        [MaxLength(40)]
        public string Address { get; set; }

        /// <summary>
        /// 信息
        /// </summary>
        [NotMapped]
        public string Info { get => $"姓名：{Name}，地址：{Address}"; }
    }
}

在NuGet控制台中输入如下命令：

Add-Migration m4

然后更新数据库：

Update-Database

打开数据库查看新生成的Author数据表，可以看到实体类中的Info字段并没有创建对应的字段，如下图所示：

在这里插入图片描述

3.5、定义列名——[Column]

在某些情况下，我们希望手动设置某个字段在数据表中对应的列名，此时就可以使用[Column]进行标识，下面对Author进行修改，给每个字段加上前缀Author_，代码如下：

using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;

namespace App.Models
{
    public class Author
    {
        /// <summary>
        /// 主键
        /// </summary>
        [Key]
        public int Id { get; set; }

        /// <summary>
        /// 姓名
        /// </summary>
        [Required]
        [MinLength(2)]
        [MaxLength(20)]
        [Column("Author_Name")]
        public string Name { get; set; }

        /// <summary>
        /// 地址
        /// </summary>
        [MinLength(5)]
        [MaxLength(40)]
        [Column("Author_Address")]
        public string Address { get; set; }

        /// <summary>
        /// 信息
        /// </summary>
        [NotMapped]
        public string Info { get => $"姓名：{Name}，地址：{Address}"; }
    }
}

在NuGet控制台中输入如下命令：

Add-Migration m5

然后更新数据库：

Update-Database

打开数据库查看新生成的Author数据表，可以看到数据表中的字段已经加上了Author_前缀，如下图所示：

在这里插入图片描述

3.6、定义表名——[Table]

如果希望手动设置数据表名称，则可以使用[Table]进行标识，下面对Author进行修改，将表名设置为T_AuthorInfo，代码如下：

using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;

namespace App.Models
{
    [Table("T_AuthorInfo")]
    public class Author
    {
        /// <summary>
        /// 主键
        /// </summary>
        [Key]
        public int Id { get; set; }

        /// <summary>
        /// 姓名
        /// </summary>
        [Required]
        [MinLength(2)]
        [MaxLength(20)]
        [Column("Author_Name")]
        public string Name { get; set; }

        /// <summary>
        /// 地址
        /// </summary>
        [MinLength(5)]
        [MaxLength(40)]
        [Column("Author_Address")]
        public string Address { get; set; }

        /// <summary>
        /// 信息
        /// </summary>
        [NotMapped]
        public string Info { get => $"姓名：{Name}，地址：{Address}"; }
    }
}

在NuGet控制台中输入如下命令：

Add-Migration m6

然后更新数据库：

Update-Database

打开数据库查看新生成的Author数据表，可以看到数据表的名称已经修改为T_AuthorInfo，如下图所示：

在这里插入图片描述

3.7、定义外键——[ForeignKey]

如果存在一对多的情况，则可以使用[ForeignKey]对外键进行标识。新建一个实体类Book，该类包含一个外键AuthorId，代码如下：

using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;

namespace App.Models
{
    public class Book
    {
        /// <summary>
        /// 主键
        /// </summary>
        [Key]
        public int Id { get; set; }

        /// <summary>
        /// 书名
        /// </summary>
        [StringLength(30)]
        public string BookName { get; set; }

        /// <summary>
        /// 外键
        /// </summary>
        public int? AuthorId { get; set; }

        /// <summary>
        /// 导航属性
        /// </summary>
        [ForeignKey("AuthorId")]
        public virtual Author Author { get; set; }
    }
}

由于Author与Book是一对多的关系，因此Author中需要定义一个Book集合，代码如下：

using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;

namespace App.Models
{
    public class Author
    {
        public Author()
        {
            Book = new HashSet<Book>();
        }

        /// <summary>
        /// 主键
        /// </summary>
        [Key]
        public int Id { get; set; }

        /// <summary>
        /// 姓名
        /// </summary>
        [Required]
        [MinLength(2)]
        [MaxLength(20)]
        public string Name { get; set; }

        /// <summary>
        /// 地址
        /// </summary>
        [MinLength(5)]
        [MaxLength(40)]
        public string Address { get; set; }

        /// <summary>
        /// 信息
        /// </summary>
        [NotMapped]
        public string Info { get => $"姓名：{Name}，地址：{Address}"; }

        /// <summary>
        /// 导航属性
        /// </summary>
        public virtual ICollection<Book> Book { get; set; }
    }
}

最后更新一下DaoDbContext，代码如下：

using App.Models;
using Microsoft.EntityFrameworkCore;

namespace App.Context
{
    public class DaoDbContext : DbContext
    {
        public DaoDbContext()
        {

        }

        public DaoDbContext(DbContextOptions<DaoDbContext> options) : base(options)
        {

        }

        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        {
            optionsBuilder.UseSqlServer("Data Source=10.8.59.253;Initial Catalog=Dao;uid=sa;pwd=gis1a6b7c!Z;");
        }

        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            modelBuilder.Entity<Author>();
            modelBuilder.Entity<Book>();
            base.OnModelCreating(modelBuilder);
        }

        public virtual DbSet<Author> Author { get; set; }
        public virtual DbSet<Book> Book { get; set; }
    }
}

在NuGet控制台中输入如下命令：

Add-Migration m7

然后更新数据库：

Update-Database

打开数据库，可以看到数据表Book已经生成，同时外键AuthorId也已经成功创建，如下图所示：

在这里插入图片描述
到此为止，我们已经熟悉了基本的Code First操作。其实Data Annotations中还包含很多其他的属性标识，如[Range]、[Comment]、[RegularExpression]等，有兴趣的同志可自行深入研究。

4、基于Fluent API的Code First

上面介绍了基于Data Annotations的Code First，该模式主要是通过给实体类打标签定义数据表。在EF Core中，还有一种使用Fluent API定义数据表的方法，下面开始介绍其使用方法，项目结构如下图所示：

在这里插入图片描述

定义Author和Book，代码如下：

using System.Collections.Generic;

namespace App.Model
{
    public class Author
    {
        public Author()
        {
            Book = new HashSet<Book>();
        }

        /// <summary>
        /// 主键
        /// </summary>
        public int Id { get; set; }

        /// <summary>
        /// 姓名
        /// </summary>
        public string Name { get; set; }

        /// <summary>
        /// 地址
        /// </summary>
        public string Address { get; set; }

        /// <summary>
        /// 导航属性
        /// </summary>
        public virtual ICollection<Book> Book { get; set; }
    }
}

namespace App.Model
{
    public class Book
    {
        /// <summary>
        /// 主键
        /// </summary>
        public int Id { get; set; }

        /// <summary>
        /// 书名
        /// </summary>
        public string BookName { get; set; }

        /// <summary>
        /// 外键
        /// </summary>
        public int? AuthorId { get; set; }

        /// <summary>
        /// 导航属性
        /// </summary>
        public virtual Author Author { get; set; }
    }
}

AuthorConfiguration和BookConfiguration需要继承IEntityTypeConfiguration<>接口，代码如下：

using App.Model;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Builders;

namespace App.Config
{
    public class AuthorConfiguration : IEntityTypeConfiguration<Author>
    {
        public void Configure(EntityTypeBuilder<Author> builder)
        {
            // 定义主键
            builder.ToTable("Author").HasKey(p => p.Id);
            // 定义字段Name
            builder.Property(p => p.Name).IsRequired().HasMaxLength(20);
            // 定义字段Address
            builder.Property(p => p.Address).HasMaxLength(40);
        }
    }
}

using App.Model;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Builders;

namespace App.Config
{
    public class BookConfiguration : IEntityTypeConfiguration<Book>
    {
        public void Configure(EntityTypeBuilder<Book> builder)
        {
            // 定义主键
            builder.ToTable("Book").HasKey(p => p.Id);
            // 定义字段BookName
            builder.Property(p => p.BookName).IsRequired().HasMaxLength(20);
            // 定义外键AuthorId
            builder.HasOne(p => p.Author)
                   .WithMany(p => p.Book)
                   .HasForeignKey(p => p.AuthorId)
                   .OnDelete(DeleteBehavior.Cascade)
                   .HasConstraintName("FK_Book_Author");
        }
    }
}

最后添加DaoDbContext部分，代码如下：

using App.Config;
using App.Model;
using Microsoft.EntityFrameworkCore;

namespace App.Context
{
    public class DaoDbContext : DbContext
    {
        public DaoDbContext()
        {

        }

        public DaoDbContext(DbContextOptions<DaoDbContext> options) : base(options)
        {

        }

        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        {
            optionsBuilder.UseSqlServer("Data Source=DSF-PC;Initial Catalog=Dao;User ID=sa;Password=123456;");
        }

        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            modelBuilder.ApplyConfiguration(new AuthorConfiguration());
            modelBuilder.ApplyConfiguration(new BookConfiguration());
            base.OnModelCreating(modelBuilder);
        }

        public virtual DbSet<Author> Author { get; set; }
        public virtual DbSet<Book> Book { get; set; }
    }
}

在NuGet控制台中输入如下命令：

Add-Migration mig

然后更新数据库：

Update-Database

打开数据库，可以看到数据表Author和Book已经生成，同时外键AuthorId也已经成功创建，如下图所示：

在这里插入图片描述

5、结语

本文主要介绍了EF Core中的Code First模式，在实际开发过程中更推荐使用Fluent API的方式，因为该方法耦合性较低且更加灵活。

HerryDong
关注
专栏目录
.net core 3.1下 WebApi项目的Api功能授权管控
网尘的技术专栏
02-28 4713
系统终于升级到.net core 3.1了，经历了改造的痛苦，也感受到了.net core的阵痛节律，阵痛之后，就是无尽的爽，现在可以好好体验属于3.1的快乐，最近开发api，需要根据不同的用户对Api权限进行限定，数据源来自数据库。 1、登录token 1.1、JWT token机制 系统登录采用流行的JWT token机制控制，其优点是授权简单，颁发一个加密的token，这个token在...
ASP.NET CORE Code First EF c#
03-20
ASP.NET CORE Code First EF c# 语言 代码案例 数据库sql Server
EF Core学习Code First
weixin_34037515的博客
06-16 143
下面通过实例来学习EF Core Code First，也就是通过EF Core迁移来完成从模型生成数据库。 本实例使用EntityFrameworkCore SQLite 数据库进行介绍，大家也可以无缝切换到其他数据库。 目前 EF Core 支持的数据库： Microsoft SQL Server SQLite Postgres (Npgsql) SQL Server Compact Edi...
使用Code First（EF Core.Sqlite）
故里2130
06-14 2300
使用EF Core建立Code First,完成数据库迁移。使用sqlite数据库1.建立一个.net core web api项目2.安装Microsoft.EntityFrameworkCore.Sqlite3. 建立一个实体 4.建立DataContext继承DbContext，初始化构造函数，继承base，再把User类写入 5.配置数据库 注意：这里必须写 FileName=./demo.db 否则后面生成的时候报错6.安装Microsoft.EntityFrameworkCore
.Net Core 使用EF Core codefirst模式
段丛磊
02-05 2272
.Net Core 使用EF Core codefirst模式 什么是codefirst模式 EF Core有两种数据库设计模式，DBfirst 数据库优先、Codefirst 代码优先。 1、我们一般设计是先添加数据库表信息，然后将数据库的信息更新到项目实体中。这种做法就是我们的DBfirst模式。 2、使用codefirst模式，我们就可以先创建表实体，添加字段限制，完事之后执行3...
NET Core 使用 EF Code First
晓剑
08-03 1万+
项目使用多层，把数据库访问层，单独放到DAL层里      一：新建好项目与类库, 并添加好EF依赖              然后在dll层添加好ef的依赖，可以使用Nuget包下载，我们这里使用在DAL.csproj里边配置依赖       自动下载  Microsoft.EntityFrameworkCore.SqlServer
ASP.NET Core 3.1中文教程.rar
07-28
ASP.NET Core 3.1是微软推出的一款开源、跨平台的Web应用开发框架，它结合了.NET Core的高性能和灵活性，以及ASP.NET的功能性。这个中文教程可能是为了帮助开发者更深入地理解和掌握ASP.NET Core 3.1的核心概念、...
asp.net core3.1 实战开发（授权，鉴权封装详解）
热门推荐
一点一滴
01-10 2万+
使用方式 #region 设置自己的schema的handler services.AddAuthenticationCore(options => options.AddScheme<MyHandler>("myScheme", "demo myScheme")); #endregion #region...
（三）使用.NET Core3.1和EF Core构建RESTful API
ananlele_的专栏
07-21 1887
在本文中，我将演示如何使用ASP.NET Core 3.1构建RESTful Web API，使用Entity Framework Core与现有数据库连接，创建JWT令牌提供对API访问的保护权限。如果您不熟悉.NET Core，可以先阅读我的.NET Core 3.1简介。 这篇文章的各节如下： 什么是RESTful API？ 什么是JWT令牌？ 添加控制器和脚手架构建RESTful API 使用Postman测试API接口 使用Cors解决前端调用API跨域的问题 创建一个JWT令牌保.
.Net-Core-Training:.Net Core 3.1探索自学练习
03-17
《.Net Core 3.1探索自学练习》 在当今的软件开发领域，.NET Core以其跨平台、高性能和开源的特性受到了广泛的关注。.NET Core 3.1是.NET Core的一个重要版本，它提供了丰富的功能和改进，适用于各种应用程序的开发...
EF框架——代码优先（CodeFirst）
12-18
Code First模式我们称之为“代码优先”模式，是从EF4.1开始新建加入的功能。使用Code First模式进行EF开发时开发人员只需要编写对应的数据类（其实就是领域模型的实现过程），然后自动生成数据库。
EF的其中一种开发方式Code First
11-16
EF有三种开发方式，Code First就是其中一种，简单易学。
.net core codefirst Demo
12-03
一个简单的.net core codefirst Demo直接运行，适合需要这方面的小白
EFCore CodeFirst模式
LONGAHE的博客
06-20 330
EFCore CodeFirst模式 操作SqlServerNuget包实体类打开程序包管理器如何写入数据 Nuget包 实体类 打开程序包管理器 输入命令 ADD-Migration InitailCreate 通过EFCore CodeFirst模式创建数据库表 注意 dbset 注入的model 必须包含主键ID 可用过 特性Key设置 不设置默认 model 属性名为ID 的 为主键 Update-Database 通过EFCore CodeFirst模式 创建数据库 写入数据表 注意连接
EF Core CodeFirst
qq_43542583的博客
03-08 257
1、 user 实体类 public class User { public int ID { get; set; } public string Name { get; set; } public string Pwd { get; set; } public string Email { get; set; } ...
【EF Core】两种使用模式（Code First、Database First）
最新发布
在这里你大概率会有所收获，欢迎指错||纠正||建议||水评+点赞&&评论&&关注&&转发
06-24 2231
Entity Framework Core (EF Core) 是 Microsoft 提供的一个对象关系映射器 (ORM)，它允许开发者使用 .NET 对象来处理数据库。EF Core 提供了几种使用模式，帮助开发者根据项目需求高效地管理数据库和对象之间的关系。以下是 EF Core 的主要使用模式：
EFCore code first 总结
绿浪的成长
12-30 280
add migrations 条件 定义模型 /// <summary> /// 商品模型 /// </summary> public class Product { [Key] public int Id { set; get; } /// <summary> /// 商品编码 /// </summary> public s
EF core Code First 简单的使用方法
abxdd2015的博客
08-14 285
好吧，我又回来了，其实一直都想写一篇关于EF core 的文章去记录自己在开发时候遇到的问题。 为什么要使用EF框架呢，因为原始的ADO.NET需要编写大量的数据访问代码，所以使用EF会更方便。但是今天只讲Code First，Code First非常好用。但是表都需要自己写代码去建立，不能可视化建立，提醒大家还是需要习惯不可视化操作为好。 首先是怎么使用EF ...
EF Core的Code First 基础
weixin_30672295的博客
07-31 172
一.创建实体类与映射类 　　通过NuGet引用Microsoft.EntityFrameworkCore 　　1.创建实体类 　　Code First可以通过为实体类字段添加相应特性，来创建对应的字段类型等，举例如下。 [Table]：表名称 [Key]：表主键 [Column("F_ENCODE", TypeName = "varchar(200)")]：表字段名称和类...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值