2. 程式人生 > >EF Core 實現多租戶

EF Core 實現多租戶

阿新 • • 發佈：2018-12-21

目錄

SAAS 和多租戶

SaaS(軟體及服務)區別於其他應用程式的主要特徵就是能夠使客戶在使用應用程式時按照使用量付費。他們不需要為軟體購買許可，也不需要安裝、託管和管理它。這方面的操作全部由提供 SaaS 軟體的組織負責。

多租戶是實現 SaaS 的關鍵因素, 它可以讓多個企業或組織使用者共用相同的系統或程式元件, 同時不會破壞這些組織的資料的安全性, 確保各組織間資料的隔離性.

多租戶資料隔離方案

  1. 單資料庫

    如果軟體系統僅部署一個例項，並且所有租戶的資料都是存放在一個數據庫裡面的，那麼可以通過一個 TenantId (租戶 Id) 來進行資料隔離。那麼當我們執行 SELECT 操作的時候就會附加上當前登入使用者租戶 Id 作為過濾條件，那麼查出來的資料也僅僅是當前租戶的資料，而不會查詢到其他租戶的資料。

    這是共享程度最高、隔離級別最低的模式。需要在設計開發時加大對安全的開發量。

    單資料庫

  2. 多資料庫

    為每一個租戶提供一個單獨的資料庫，在使用者登入的時候根據使用者對應的租戶 ID，從一個數據庫連線對映表獲取到當前租戶對應的資料庫連線字串，並且在查詢資料與寫入資料的時候，不同租戶操作的資料庫是不一樣的。

    這種方案的使用者資料隔離級別最高，安全性最好，但維護和購置成本較高.

    多資料庫

也有一種介於兩者之間的方案: 共享資料庫，獨立 Schema. 但實際應用的應該不多.

使用 EF Core 簡單實現多租戶

租戶 Id 的獲取可以採用兩種方法:

  • 根據登入使用者獲取. 作為登入使用者的附加資訊, 比如把租戶 Id 放到Json Web Token裡面或者根據使用者 Id 去資料庫裡取對應的租戶 Id.
  • 根據企業或組織使用者的Host獲取. 部署的時候會給每個企業或組織分配一個單獨的Host, 並在資料庫裡維護著一個租戶 Id 和 Host 的對映表. 查詢的時候根據 Host 去取對應的租戶 Id.

在框架編寫的時候, 我們最好能把對租戶 Id 的處理(查詢時候的過濾和儲存時候的賦值) 放在資料訪問的最底層自動實現. 從而讓業務邏輯的開發人員儘量少的去關注租戶 Id, 而是像開發普通應用一樣去開發多租戶應用.

EF Core 在2.0版本引入了"模型級別查詢篩選器”的新功能, 此功能可以幫助開發人員方便實現軟刪除和多租戶等功能.

單資料庫實現

下面使用 EF Core 簡單實現一個單資料庫多租戶的 Demo. 採用 Host 獲取租戶 Id.

  1. 建立 Tenant 實體類和 TenantsContext, 用於儲存租戶 Id 和 Host 的對映, 並根據 Host 從資料庫裡獲取 Id.

    public class Tenant
{
    public Guid Id { get; set; }
    public string Name { get; set; }
    public string Host { get; set; }
}

public class TenantConfiguration : IEntityTypeConfiguration<Tenant>
{
    public void Configure(EntityTypeBuilder<Tenant> builder)
    {
        builder.HasKey(t => t.Id);
        builder.Property(t => t.Name).HasMaxLength(100).IsRequired();
        builder.Property(t => t.Host).HasMaxLength(100).IsRequired();

        builder.HasData(
            new Tenant { Id = Guid.Parse("B992D195-56CE-49BF-BFDD-4145BA9A0C13"), Name = "Customer A", Host = "localhost:5200" },
            new Tenant { Id = Guid.Parse("F55AE0C8-4573-4A0A-9EF9-32F66A828D0E"), Name = "Customer B", Host = "localhost:5300" });
    }
}
    public class TenantsContext : DbContext
{
    public TenantsContext(DbContextOptions<TenantsContext> options)
        : base(options)
    {
    }

    private DbSet<Tenant> Tenants { get; set; }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.ApplyConfiguration(new TenantConfiguration());

        base.OnModelCreating(modelBuilder);
    }

    public Guid GetTenantId(string host)
    {
        var tenant = Tenants.FirstOrDefault(t => t.Host == host);
        return tenant == null ? Guid.Empty : tenant.Id;
    }
}

  2. 建立 TenantProvider, 用於從 HttpContext 中識別 Host, 並訪問 TenantsContext 獲取 租戶 Id.

    public interface ITenantProvider
{
    Guid GetTenantId();
}

public class TenantProvider : ITenantProvider
{
    private Guid _tenantId;

    public TenantProvider(IHttpContextAccessor accessor, TenantsContext context)
    {
        var host = accessor.HttpContext.Request.Host.Value;
        _tenantId = context.GetTenantId(host);
    }

    public Guid GetTenantId()
    {
        return _tenantId;
    }
}

  3. 建立 Blog 實體類和 BloggingContext. 有幾個注意點

    • BaseEntity 類裡面包含 TenantId, 所以需要共享資料的表都要繼承自這個基類.
    • BloggingContext 的建構函式裡面加入引數 ITenantProvider tenantProvider, 用於獲取租戶 Id.
    • 在 OnModelCreating 方法裡面對所有繼承於 BaseEntity 的實體類配置全域性過濾 builder.Entity<T>().HasQueryFilter(e => e.TenantId == _tenantId).
    • 過載 SaveChangesAsync 等方法, 儲存資料的時候自動賦值 TenantId.
public abstract class BaseEntity
{
    public int Id { get; set; }
    public Guid TenantId { get; set; }
}
public class Blog : BaseEntity
{
    public string Name { get; set; }
    public string Url { get; set; }

    public virtual IList<Post> Posts { get; set; }
}

public class BlogConfiguration : IEntityTypeConfiguration<Blog>
{
    public void Configure(EntityTypeBuilder<Blog> builder)
    {
        builder.HasKey(t => t.Id);
        builder.Property(t => t.Name).HasMaxLength(100).IsRequired();
        builder.Property(t => t.Url).HasMaxLength(100).IsRequired();

        builder.HasData(
            new Blog { Id = 1, Name = "Blog1 by A", Url = "http://sample.com/1", TenantId= Guid.Parse("B992D195-56CE-49BF-BFDD-4145BA9A0C13") },
            new Blog { Id = 2, Name = "Blog2 by A", Url = "http://sample.com/2", TenantId = Guid.Parse("B992D195-56CE-49BF-BFDD-4145BA9A0C13") },
            new Blog { Id = 3, Name = "Blog1 by B", Url = "http://sample.com/3", TenantId = Guid.Parse("F55AE0C8-4573-4A0A-9EF9-32F66A828D0E") });
    }
}
public class BloggingContext : DbContext
{
    private Guid _tenantId;

    public BloggingContext(DbContextOptions<BloggingContext> options, ITenantProvider tenantProvider)
        : base(options)
    {
        _tenantId = tenantProvider.GetTenantId();
    }

    public DbSet<Blog> Blogs { get; set; }
    public DbSet<Post> Posts { get; set; }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.ApplyConfiguration(new BlogConfiguration());
        modelBuilder.ApplyConfiguration(new PostConfiguration());

        foreach (var entityType in modelBuilder.Model.GetEntityTypes())
        {
            if (entityType.ClrType.BaseType == typeof(BaseEntity))
            {
                ConfigureGlobalFiltersMethodInfo
                    .MakeGenericMethod(entityType.ClrType)
                    .Invoke(this, new object[] { modelBuilder });
            }
        }

        base.OnModelCreating(modelBuilder);
    }

    public override async Task<int> SaveChangesAsync(CancellationToken cancellationToken = default(CancellationToken))
    {
        ChangeTracker.DetectChanges();

        var entities = ChangeTracker.Entries().Where(e => e.State == EntityState.Added && e.Entity.GetType().BaseType == typeof(BaseEntity));
        foreach (var item in entities)
        {
            (item.Entity as BaseEntity).TenantId = _tenantId;
        }

        return await base.SaveChangesAsync(cancellationToken);
    }

    #region

    private static MethodInfo ConfigureGlobalFiltersMethodInfo = typeof(BloggingContext).GetMethod(nameof(ConfigureGlobalFilters), BindingFlags.Instance | BindingFlags.NonPublic);

    protected void ConfigureGlobalFilters<T>(ModelBuilder builder) where T : BaseEntity
    {
        builder.Entity<T>().HasQueryFilter(e => e.TenantId == _tenantId);
    }

    #endregion
}

  1. 在 Startup 裡面配置依賴注入

    services.AddDbContext<TenantsContext>(option => option.UseSqlServer(connectionString));
services.AddDbContext<BloggingContext>(option => option.UseSqlServer(connectionString));
services.AddScoped<ITenantProvider, TenantProvider>();
services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();

多資料庫實現

多資料的實現也不復雜, 在 Tenant 實體類裡面加入新的欄位 DatabaseConnectionString 用於存放每個租戶的資料庫連線字串, 在 BloggingContext 的 OnConfiguring 方法裡面根據獲取的 Tenant 配置連線字串.

public class Tenant
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Host { get; set; }
    public string DatabaseConnectionString { get; set; }
}
public class BloggingContext : DbContext
{
    private readonly Tenant _tenant;
 
    public DbSet<Blog> Blogs { get; set; }
    public DbSet<Post> Posts { get; set; }
 
    public BloggingContext(DbContextOptions<BloggingContext> options,
                            ITenantProvider tenantProvider)
        : base(options)
    {
        _tenant = tenantProvider.GetTenant();
    }
 
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseSqlServer(_tenant.DatabaseConnectionString);
 
        base.OnConfiguring(optionsBuilder);
    }
 
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.ApplyConfiguration(new BlogConfiguration());
        modelBuilder.ApplyConfiguration(new PostConfiguration());
 
        base.OnModelCreating(modelBuilder);
    }
}

這只是一個簡單的實現, 多租戶系統需要關注的點還有蠻多, 比如租戶的註冊, 功能訂閱, 計費, 資料備份, 統一管理等...

原始碼

參考

相關推薦

EF Core 實現多租戶

目錄 SAAS 和多租戶 SaaS(軟體及服務)區別於其他應用程式的主要特徵就是能夠使客戶在使用應用程式時按照使用量付費。他們不需要為軟體購買許可，也不需要安裝、託管和管理它。這方面的操作全部由提供 SaaS 軟體的組織負責。 多租戶是實現 SaaS 的關鍵因素, 它可以讓多個企業或組織使用者共用相同的系統

Asp.net core下利用EF core實現從資料實現多租戶（1）

  前言 隨著網際網路的的高速發展，大多數的公司由於一開始使用的傳統的硬體/軟體架構，導致在業務不斷髮展的同時，系統也逐漸地逼近傳統結構的極限。 於是，系統也急需進行結構上的升級換代。 在服務端，系統的I/O是很大的瓶頸。其中資料庫的I/O最容易成為限制系統效率的一環。在優化資料庫I/O這一環中，可

Asp.net core下利用EF core實現從資料實現多租戶（2） : 按表分離

前言 在上一篇文章中，我們介紹瞭如何根據不同的租戶進行資料分離，分離的辦法是一個租戶一個數據庫。 也提到了這種模式還是相對比較重，所以本文會介紹一種更加普遍使用的辦法： 按表分離租戶。   這樣做的好處是什麼： 在目前的to B的系統中，其實往往會有一個Master資料庫，裡面使用的是系統中主要的資

Asp.net core下利用EF core實現從資料實現多租戶（3）: 按Schema分離 附加：EF Migration 操作

前言 前段時間寫了EF core實現多租戶的文章，實現了根據資料庫，資料表進行多租戶資料隔離。 今天開始寫按照Schema分離的文章。 其實還有一種，是通過在資料表內新增一個欄位做多租戶的，但是這種模式我不打算講了。   如果大家看了文章感覺完全銜接不上，可以先看看前面的系列文章： Asp.net

SpringBoot+MongoDB實現多租戶切換

目標：實現不同分組的使用者訪問自己的專用資料庫(資料庫在同一個伺服器).例：A公司使用者，僅可訪問A公司的專用資料庫 要求：MongoDB + SpringBoot Pom依賴： <parent> <groupId>org.s

mycat+mysql實現多租戶配置

前言 網上的許多mycat安裝教程並不能解決我遇到的問題，特此記錄一下 mycat安裝 mycat的安裝很簡單，但是版本很重要，我就在這裡栽了跟頭… 一開始隨便在網上找了一個版本如下： 解壓後安裝步驟如下： 配置環境變數path： D:\mycat1.4\M

SpringBoot+restFul+filter+threadLocal實現多租戶的專案

本片部落格參考了 https://blog.csdn.net/gebitan505/article/details/51614805 threadLocal的目的是:  實現變數的全域性話,在當前的專案當中是實現了使用者名稱的多租戶狀態下的全域性話 fiter:進行toke

Hibernate與Spring 實現多租戶 （Hibernate Multi Tenancy With Spring）

轉載自：http://www.ticnfae.co.uk/blog/2014/07/16/hibernate-multi-tenancy-with-spring/ DATABASE：一個租戶一個 database。       When creating a Multi-

使用EF6簡實現多租戶的應用

什麼是多租戶 網上有好多解釋，有些上升到了架構設計，讓你覺得似乎非常高深莫測，特別是目前流行的ABP架構中就有提到多租戶（IMustHaveTenant），其實說的簡單一點就是再每一張資料庫的表中新增一個TenantId的欄位，用於區分屬於不同的租戶（或是說不同的使用者組）的資料。關鍵是現實的方式必須對開發

EF Core 實現讀寫分離的最佳方案

前言 公司之前使用Ado.net和Dapper進行資料訪問層的操作, 進行讀寫分離也比較簡單, 只要使用對應的資料庫連線字串即可. 而最近要遷移到新系統中,新系統使用.net core和EF Core進行資料訪問. 所以趁著國慶假期拿出一兩天時間研究了一下如何EF Core進行讀寫分離. 思路 根據園子裡的J

Azure Cosmos DB (三) EF Core 實現 CURD Demo

一，引言 　　接著上一篇使用 EF Core 操作 Azure CosmosDB 生成種子資料，今天我們完成通過 EF Core 實現CRUD一系列功能。EF Core 3.0 提供了CosmosDB 資料庫提供程式的第一個可用的版本，今天我們使用 EF Core 3.1在嘗試使用Cosmos DB 來儲存和

ef core中如何實現多對多的表映射關系

uil set ring one int 實現 log ons lB 文檔：https://docs.microsoft.com/en-us/ef/core/modeling/relationships class MyContext : DbContext {

EF多租戶例項：如何快速實現和同時支援多個DbContext

前言 上一篇隨筆我們談到了多租戶模式，通過多租戶模式的演化的例子。大致歸納和總結了幾種模式的表現形式。 並且順帶提到了讀寫分離。 通過好幾次的程式碼調整，使得這個庫更加通用。今天我們聊聊怎麼通過該類庫快速接入多租戶。 類庫地址： https://github.com/woailibain/kiwiho.EFc

EF多租戶例項：快速實現分庫分表

前言 來到這篇隨筆，我們繼續演示如何實現EF多租戶。 今天主要是演示多租戶下的變形，為下圖所示     實施 專案結構 這次我們的示例專案進行了精簡，僅有一個API專案，直接包含所有程式碼。 其中Controller，StoreContext，Entity都完全和以往的示例一模一樣，這裡

【ASP.NET Core快速入門】（十四）MVC開發：UI、 EF + Identity實現

dfa models cti ted lec inpu word pri numeric 前言 之前我們進行了MVC的web頁面的Cookie-based認證實現，接下來的開發我們要基於之前的MvcCookieAuthSample項目做修改。 MvcCookieAuth

利用EF Core的Join進行多表查詢

速度 src return 集合 成功 string ima 一點 定義 背景 話說有這麽一家子，老公養了一條狗，老婆養了一只貓。 數據庫的設計 人表 寵物表 通過表可以知道，寵物通過Owner指向主人的Id。 問題來了，我要和故事開頭一樣，老公-狗，老婆-

.NET Core WebApi中實現多態數據綁定

ddl ada .cn bapi var context mage writer 擁有 什麽是多態數據綁定？ 我們都知道在ASP.NET Core WebApi中數據綁定機制（Data Binding）負責綁定請求參數， 通常情況下大部分的數據綁定都能在默認的數據綁定器（

springboot 配置ehcache快取，通過註解定製多租戶(multiTenantId)生成快取的key，並且實現註解按照tenantId清除快取,tanant之間快取互相不影響

調研背景     本公司有一項功能需求，由於查詢的資料太多會導致訪問時間超優化API介面，但是這不是長久之計，便決定引入快取，但是此 快取能夠實現按照不同租戶的ID號碼在同一個cacheName中去生成能識別租戶的key，而且在使用cacheEvict時候

.ef core 多對對關系的關聯方法

url name 實體 cor table namespace color content totable 最近在使用.net core 重構博客是，在使用ef core連表查詢時，遇到了一些問題。記錄一下。 下面是實體代碼 BlogEntity namespace Bl

SaaS “可配置”和“多租戶”架構的幾種技術實現方式

1、資料儲存方式的選擇 多租戶（Multi-Tenant ），即多個租戶共用一個例項，租戶的資料既有隔離又有共享，說到底是要解決資料儲存的問題。 常用的資料儲存方式有三種。 方案一：獨立資料庫