EF Core 在实际开发中，如何分层？

前言：什么是分层？

• 分层就是将 EF Core 放在单独的项目中，其它项目如 Asp.net core webapi 项目引用它
  
• 这样的好处是解耦和项目职责的清晰划分，并且可以重用 EF Core 项目
  
• 但是也会数据库迁移变得复杂起来
  

Step by step 步骤

• 创建一个 .NET 类库项目，项目名字为 BooksEFCore
  
• 引用以下 Nuget 包
  

  Microsoft.EntityFrameworkCore.Relational
  Microsoft.EntityFrameworkCore.SqlServer
  Microsoft.EntityFrameworkCore.Tools
  

  
  
• 创建实体类 Book
  1. // 把Book类声明为一个记录类，而不是普通的类，主要是为了让编译器自动生成ToString方法，简化对象的输出
  2. public record Book
  3. {
  4.         public Guid Id { get; set; }
  5.         public string Name { get; set; }
  6.         public double Price { get; set; }
  7. }

  复制代码
• 配置实体类
  1. using Microsoft.EntityFrameworkCore;
  2. using Microsoft.EntityFrameworkCore.Metadata.Builders;
  4. class BookConfig : IEntityTypeConfiguration<Book>
  5. {
  6.         public void Configure(EntityTypeBuilder<Book> builder)
  7.         {
  8.                 builder.ToTable("T_Books2");
  9.         }
  10. }       

  复制代码
• 创建上下文类【注意，这里有跟单体 EF Core 项目不一样的地方，看注释】
  1. using Microsoft.EntityFrameworkCore;
  3. public class MyDbContext:DbContext
  4. {
  5.         public DbSet<Book> Books { get; set; }
  7.         //注意：
  8.         //在运行时通过读取配置来确定要连接的数据库
  9.         //不再重写 OnConfiguring 方法和在其中调用 UseSqlServer 等方法来设置要使用的数据库
  10.         //为 MyDbContext 类增加了 DbContextOptions<MyDbContext> 类型参数的构造方法
  11.         //DbContextOptions 是一个数据库连接配置对象，在 ASP.NET Core 项目中提供对 DbContextOptions 的配置
  12.         public MyDbContext(DbContextOptions<MyDbContext> options) : base(options)
  13.         {
  15.         }
  17.        
  18.         protected override void OnModelCreating(ModelBuilder modelBuilder)
  19.         {
  20.                 base.OnModelCreating(modelBuilder);
  21.                 modelBuilder.ApplyConfigurationsFromAssembly(this.GetType().Assembly);
  22.         }
  23. }       

  复制代码
• 创建一个 Asp.net core webapi 项目，命名为 "EFCore测试用WebAPI项目1"
  
• 引用 EF Core 类项目 BooksEFCore
  
• 打开 appsettings.json 文件并添加数据库连接字符串配置
  1. {
  2.   "Logging": {
  3.         "LogLevel": {
  4.           "Default": "Information",
  5.           "Microsoft.AspNetCore": "Warning"
  6.         }
  7.   },
  8.   "AllowedHosts": "*",
  9.   "ConnectionStrings": {
  10.         "Default": "Server=(localdb)\\mssqllocaldb;Database=TestDB;Trusted_Connection=True;MultipleActiveResultSets=true"
  11.   }
  12. }       

  复制代码
• 打开 Program.cs 文件，注册数据库上下文服务
  1. using Microsoft.EntityFrameworkCore;
  3. var builder = WebApplication.CreateBuilder(args);
  5. // Add services to the container.
  7. builder.Services.AddControllers();
  8. // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
  9. builder.Services.AddEndpointsApiExplorer();
  10. builder.Services.AddSwaggerGen();
  12. // 注册数据库上下文服务
  13. // 使用AddDbContext方法来通过依赖注入的方式让MyDbContext采用指定的连接字符串连接数据库。
  14. // 由于AddDbContext方法是泛型的，因此可以为同一个项目中的多个不同的上下文设定连接不同的数据库。
  15. builder.Services.AddDbContext<MyDbContext>(opt =>
  16. {
  17.         string connStr = builder.Configuration.GetConnectionString("Default")!;
  18.         opt.UseSqlServer(connStr);
  19. });
  21. var app = builder.Build();
  23. // Configure the HTTP request pipeline.
  24. if (app.Environment.IsDevelopment())
  25. {
  26.         app.UseSwagger();
  27.         app.UseSwaggerUI();
  28. }
  30. app.UseHttpsRedirection();
  32. app.UseAuthorization();
  34. app.MapControllers();
  36. app.Run();       

  复制代码
• 创建 TestController 控制器，编写数据库读写的测试代码
  1. using Microsoft.AspNetCore.Mvc;
  3. [ApiController]
  4. [Route("[controller]/[action]")]
  5. public class TestController : ControllerBase
  6. {
  7.         private readonly MyDbContext dbCtx;
  9.         /// <summary>
  10.         /// 用依赖注入的形式来创建上下文
  11.         /// </summary>
  12.         /// <param name="dbCtx"></param>
  13.         public TestController(MyDbContext dbCtx)
  14.         {
  15.                 this.dbCtx = dbCtx;
  16.         }
  18.         [HttpPost]
  19.         public async Task<long> Save()
  20.         {
  21.                 dbCtx.Add(new Book { Id = Guid.NewGuid(), Name = "零基础趣学C语言", Price = 59 });
  22.                 await dbCtx.SaveChangesAsync();
  23.                 return dbCtx.Books.LongCount();
  24.         }
  25. }

  复制代码
• 生成实体类的迁移脚本
  
  
  
  • 回到 EF Core 类项目 BooksEFCore
    
  • 新建一个实现 IDesignTimeDbContextFactory 接口的类 MyDesignTimeDbContextFactory
    1. using Microsoft.EntityFrameworkCore;
    2. using Microsoft.EntityFrameworkCore.Design;
    4. //在多项目的环境下执行 EF Core 的数据库迁移有很多特殊的要求
    5. //容易出错，因为数据库连接在其它项目中
    6. //可以通过 IDesignTimeDbContextFactory 接口来解决这个问题
    7. //当项目中存在一个 IDesignTimeDbContextFactory 接口的实现类的时候，
    8. //数据库迁移工具就会调用这个实现类的 CreateDbContext 方法来获取上下文对象，
    9. //然后迁移工具会使用这个上下文对象来连接数据库
    10. //此代码只用于开发环境
    11. //生产环境可以去掉此代码
    12. class MyDesignTimeDbContextFactory : IDesignTimeDbContextFactory<MyDbContext>
    13. {
    14.         public MyDbContext CreateDbContext(string[] args)
    15.         {
    16.                 DbContextOptionsBuilder<MyDbContext> builder = new();
    17.                 string connStr = "Server=(localdb)\\mssqllocaldb;Database=TestDB;Trusted_Connection=True;MultipleActiveResultSets=true";
    18.                 //也可以从环境变量或者其它配置文件中读取，如下：
    19.                 //string connStr = Environment.GetEnvironmentVariable("ConnectionStrings:BooksEFCore");
    20.                 builder.UseSqlServer(connStr);
    21.                 return new MyDbContext(builder.Options);
    22.         }
    23. }

    复制代码
  • 设置 BooksEFCore 为启动项目
    
  • 打开 菜单-工具-Nuget包管理-程序包管理器控制台，并选中 BooksEFCore
    
  • 执行 Add-Migration Init 命令生成数据库迁移脚本
    
  • 然后执行 Update-database 命令即可完成数据库的创建
    
  
  

扩展

• 在进行项目开发时，推荐采用 "小上下文" 策略
  
• "小上下文" 策略特点是：
  
  
  
  • 把关系紧密的实体类放到同一个上下文类中，把关系不紧密的实体类放到不同的上下文类中
    
  • 也就是项目中存在多个上下文类，每个上下文类中只有少数几个实体类
    
  • 有点 DDD 的味道
    
  
  
• "小上下文" 策略的好处：
  
  
  
  • 一个上下文实例初始化的时候，实体类的配置等过程将非常快，其不会成为性能瓶颈
    
  • 如果启用了数据库连接池，数据库连接的创建也不会成为性能瓶颈。
    
  
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！