Asp.net core下利用EF core实现从数据实现多租户（3）: 按Schema分离附加：EF Migration 操作

2023-07-19 11:57:52

前言

前段时间写了EF core实现多租户的文章，实现了根据数据库，数据表进行多租户数据隔离。

今天开始写按照Schema分离的文章。

其实还有一种，是通过在数据表内添加一个字段做多租户的，但是这种模式我不打算讲了。

如果大家看了文章感觉完全衔接不上，可以先看看前面的系列文章：

Asp.net core下利用EF core实现从数据实现多租户（1）

Asp.net core下利用EF core实现从数据实现多租户（2） : 按表分离

EF core (code first) 通过自定义 Migration History 实现多租户使用同一数据库时更新数据库结构

关于EF core自动迁移：

可能有朋友会觉得EF core不使用自动迁移就偏离了EF core的设计初衷。其实我觉得技术是实施的手段，而不是束缚项目的绊脚石。

1. 首先EF core并不是只有code first模式，

2. 其次EF core对db first模式支持很好，对于一些经历几年发展的项目会更加友好，因为对旧数据库进行O/R不是1，2周可以完成的，

3. 再次在以往的EF migration经验中，即使项目完全按照code first模式发展，但实际上更新数据库的并不是通过的Web项目，而是通过一个控制台，里面包含了Migration文件、数据迁移、结构校验数据校验。

这个控制台，一般通过CI/CD执行或手动执行。这是由于数据量、系统结构（例如多租户等）决定的。

所以，EF core的自动迁移不是这个系列文章的主线主分支

如果想参考自动迁移的实施步骤，欢迎查看我的另一篇文章，是根据本文背景实现的自动迁移实施步骤：

EF core (code first) 通过自动迁移实现多租户数据分离：按Schema分离数据

实施

项目介绍

本项目是用系列文章的主分支代码进行修改的。目前项目主要支持使用MySql，通过分库，分表实现多租户。

本文需要实现分Schema，MySql不能实现，所以引入了MSSqlServer。

项目依赖

1. .net core app 3.1。在机器上安装好.net core SDK, 版本3.1

2. Mysql. 使用 Pomelo.EntityFrameworkCore.MySql 包，版本3.1.1

3. MS Sql Server. 使用 Microsoft.EntityFrameworkCore.SqlServer 包，版本3.1.1 （本文新增的依赖）

3. EF core，Microsoft.EntityFrameworkCore, 版本3.1.1。这里必须要用3.1的，因为ef core3.0是面向.net standard 2.1.

实施步骤

1. 由于我们引入了MsSql，所以要对 MultipleTenancyExtension 进行修改，对立面的所有方法都要添加db类型进行传参。

修改 AddDatabase 方法，立面需要对sql server和MySql进行判断

 internal static IServiceCollection AddDatabase<TDbContext>(this IServiceCollection services,

                 ConnectionResolverOption option)

             where TDbContext : DbContext, ITenantDbContext

 {

     services.AddSingleton(option);

     services.AddScoped<TenantInfo>();

     services.AddScoped<ISqlConnectionResolver, TenantSqlConnectionResolver>();

     services.AddDbContext<TDbContext>((serviceProvider, options) =>

     {

         var dbContextManager = serviceProvider.GetService<IDbContextManager>();

         var resolver = serviceProvider.GetRequiredService<ISqlConnectionResolver>();

         DbContextOptionsBuilder dbOptionBuilder = null;

         switch (option.DBType)

         {

             case DatabaseIntegration.SqlServer:

                 dbOptionBuilder = options.UseSqlServer(resolver.GetConnection());

                 break;

             case DatabaseIntegration.Mysql:

                 dbOptionBuilder = options.UseMySql(resolver.GetConnection());

                 break;

             default:

                 throw new System.NotSupportedException("db type not supported");

         }

         if (option.Type == ConnectionResolverType.ByTabel || option.Type == ConnectionResolverType.BySchema)

         {

             dbOptionBuilder.ReplaceService<IModelCacheKeyFactory, TenantModelCacheKeyFactory<TDbContext>>();

         }

     });

     return services;

 }

修改 AddDatabase 方法

添加2个 AddTenantDatabasePerSchema 方法，实现根据Schema的分离

 public static IServiceCollection AddTenantDatabasePerSchema<TDbContext>(this IServiceCollection services,

         string connectionStringName, string key = "default")

     where TDbContext : DbContext, ITenantDbContext

 {

     var option = new ConnectionResolverOption()

     {

         Key = key,

         Type = ConnectionResolverType.BySchema,

         ConnectinStringName = connectionStringName,

         DBType = DatabaseIntegration.SqlServer

     };

     return services.AddTenantDatabasePerSchema<TDbContext>(option);

 }

 public static IServiceCollection AddTenantDatabasePerSchema<TDbContext>(this IServiceCollection services,

         ConnectionResolverOption option)

     where TDbContext : DbContext, ITenantDbContext

 {

     if (option == null)

     {

         option = new ConnectionResolverOption()

         {

             Key = "default",

             Type = ConnectionResolverType.BySchema,

             ConnectinStringName = "default",

             DBType = DatabaseIntegration.SqlServer

         };

     }

     return services.AddTenantDatabasePerTable<TDbContext>(option);

 }

添加 AddTenantDatabasePerSchema 方法

2. 添加 DatabaseIntegration 枚举，用于标记db的类型

 public enum DatabaseIntegration

 {

     None = ,

     Mysql = ,

     SqlServer =

 }

3. 修改 TenantSqlConnectionResolver 类立面的GetConection 方法，在switch中添加添加一个case。就是代码中高亮部分

 public string GetConnection()

 {

     string connectionString = null;

     switch (this.option.Type)

     {

         case ConnectionResolverType.ByDatabase:

             connectionString = configuration.GetConnectionString(this.tenantInfo.Name);

             break;

         case ConnectionResolverType.ByTabel:

         case ConnectionResolverType.BySchema:

             connectionString = configuration.GetConnectionString(this.option.ConnectinStringName);

             break;

     }

     if (string.IsNullOrEmpty(connectionString))

     {

         throw new NullReferenceException("can not find the connection");

     }

     return connectionString;

 }

4. 修改 StoreDbContext 里的 OnModelCreating 方法，把之前按照Table分离数据的代码注释，重新添加按Schema分离数据的代码。

这里需要注意的是，在项目目前的结构，同一个DbContext，同时只能支持按Table或Schema其中的一种。

其实实际项目中，也的确没有必要需要对一个DbContext同时支持Table或Schema的支持，因为本质上这2种方式都是同时保存在一个数据库。

不过这是能实现的，本文暂不做实现。

 protected override void OnModelCreating(ModelBuilder modelBuilder)

 {

     // seperate by table

     // modelBuilder.Entity<Product>().ToTable(this.tenantInfo.Name + "_Products");

     // seperate by Schema

     modelBuilder.Entity<Product>().ToTable(nameof(this.Products), "dbo."+this.tenantInfo.Name);

 }

5. 修改 Startup 类里面的 ConfigureServices 方法，把之前按照Table分离数据的注入代码注释，重新添加新的代码。

 public void ConfigureServices(IServiceCollection services)

 {

     // services.AddConnectionByDatabase<StoreDbContext>();

     // services.AddTenantDatabasePerTable<StoreDbContext>("default");

     services.AddTenantDatabasePerSchema<StoreDbContext>("mssql");

     services.AddControllers();

 }