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

時間 2020-02-16

標籤 asp.net asp core 利用實現數據租戶欄目 ASP 简体版

原文原文鏈接

前言

隨着互聯網的的高速發展，大多數的公司因爲一開始使用的傳統的硬件/軟件架構，致使在業務不斷髮展的同時，系統也逐漸地逼近傳統結構的極限。git

因而，系統也急需進行結構上的升級換代。github

在服務端，系統的I/O是很大的瓶頸。其中數據庫的I/O最容易成爲限制系統效率的一環。在優化數據庫I/O這一環中，能夠從優化系統調用數據庫效率、數據庫自身效率等多方面入手。sql

通常狀況下，經過升級數據庫服務器的硬件是最容易達到的。可是服務器資源不可能無限擴大，因而從調用數據庫的效率方面入手是目前主流的優化方向。數據庫

因而讀寫分離、分庫分表成爲了軟件系統的重要一環。而且須要在傳統的系統架構下，是須要作強入侵性的修改。api

什麼是多租戶：

多租戶的英文是Multiple Tenancy，不少人把多租戶和Saas劃上等號，其實這仍是有區別的。咱們今天不討論Sass這種如此普遍的議題。安全

如今不少的系統都是to B的，它們面向的是組織、公司和商業機構等。每一個機構會有獨立的組織架構，獨立的訂單結構，獨立的服務等級和收費。服務器

這就形成了各個機構間的數據是自然獨立的，特別是部分的公司對數據的獨立和安全性會有較高要求，每每數據是須要獨立存儲的。架構

因爲多租戶數據的自然獨立，形成了系統能夠根據機構的不一樣進行分庫分表。因此這裏討論的多租戶，僅限於數據層面的！app

寫這篇文章緣由

其實因爲一個羣的朋友問到了相關的問題，因爲當時我並無dotnet環境，因此簡單地寫了幾句代碼，我自己是不知道代碼是否正確的。asp.net

在我有空的時候，試了一下原來是可實施的。我貼上當時隨手寫的核心代碼，其中connenctionResolver是須要本身建立的。

這代碼是能用的，若是對於asp.net core很熟悉的人，把這段代碼放入到ConfigureServices方法內便可。

可是我仍是強烈建議你們跟着個人介紹逐步實施。

1 services.AddDbContext<MyContext>((serviceProvider, options)=>
2 {
3     var connenctionResolver = serviceProvider.GetService<IConnectionResolver>();
4     options.UseSqlServer(connenctionResolver.ConnectionString);
5 });

實施

項目介紹

這個Demo，主要經過根據http request header來獲取不一樣的租戶的標識，從而達到區分租戶最終實現數據的隔離。

項目依賴：

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

2. Mysql. 使用 Pomelo.EntityFrameworkCore.MySql 包

3. EF core，Microsoft.EntityFrameworkCore, 版本3.1.1。這裏必需要用3.1的，由於ef core3.0是面向.net standard 2.1.

項目中必須對象是什麼：

1. DbContext和對應數據庫對象

2. ConnenctionResolver，用於獲取鏈接字符串

3. TenantInfo，用於表示租戶信息

4. TenantInfoMiddleware，用於在asp.net core管道根據http的內容從而解析出TenantInfo

5. Controller，用於實施對應的

實施步驟

1. 建立TenanInfo 和 TenantInfoMiddleware. TenanInfo 做爲租戶的信息，經過IOC建立，而且在TenantInfoMiddleware經過解析http request header，修改TenantInfo

1 using System;
2 
3 namespace kiwiho.Course.MultipleTenancy.EFcore.Api.Infrastructure
4 {
5     public class TenantInfo
6     {
7         public string Name { get; set; }
8     }
9 }

 1 using System;
 2 using System.Threading.Tasks;
 3 using Microsoft.AspNetCore.Http;
 4 using Microsoft.Extensions.DependencyInjection;
 5 
 6 namespace kiwiho.Course.MultipleTenancy.EFcore.Api.Infrastructure
 7 {
 8     public class TenantInfoMiddleware
 9     {
10         private readonly RequestDelegate _next;
11 
12         public TenantInfoMiddleware(RequestDelegate next)
13         {
14             _next = next;
15         }
16 
17         public async Task InvokeAsync(HttpContext context)
18         {
19             var tenantInfo = context.RequestServices.GetRequiredService<TenantInfo>();
20             var tenantName = context.Request.Headers["Tenant"];
21 
22             if (string.IsNullOrEmpty(tenantName))
23                 tenantName = "default";
24 
25             tenantInfo.Name = tenantName;
26 
27             // Call the next delegate/middleware in the pipeline
28             await _next(context);
29         }
30     }
31 }

TenantInfoMiddleware

2. 建立HttpHeaderSqlConnectionResolver而且實現ISqlConnectionResolver接口。這裏要作的事情很簡單，直接同TenantInfo取值，而且在配置文件查找對應的connectionString。

其實這個實現類在正常的業務場景是須要包含邏輯的，可是在Demo裏爲了簡明扼要，就使用最簡單的方式實現了。

 1 using System;
 2 using Microsoft.Extensions.Configuration;
 3 
 4 namespace kiwiho.Course.MultipleTenancy.EFcore.Api.Infrastructure
 5 {
 6     public interface ISqlConnectionResolver
 7     {
 8         string GetConnection();
 9 
10     }
11 
12     public class HttpHeaderSqlConnectionResolver : ISqlConnectionResolver
13     {
14         private readonly TenantInfo tenantInfo;
15         private readonly IConfiguration configuration;
16 
17         public HttpHeaderSqlConnectionResolver(TenantInfo tenantInfo, IConfiguration configuration)
18         {
19             this.tenantInfo = tenantInfo;
20             this.configuration = configuration;
21         }
22         public string GetConnection()
23         {
24             var connectionString = configuration.GetConnectionString(this.tenantInfo.Name);
25             if(string.IsNullOrEmpty(connectionString)){
26                 throw new NullReferenceException("can not find the connection");
27             }
28             return connectionString;
29         }
30     }
31 }

ConnectionResolver

3. 建立類MultipleTenancyExtension，裏面包含最重要的配置數據庫鏈接字符串的方法。其中裏面的DbContext並無使用泛型，是爲了更加簡明點

 1 using kiwiho.Course.MultipleTenancy.EFcore.Api.DAL;
 2 using Microsoft.Extensions.Configuration;
 3 using Microsoft.Extensions.DependencyInjection;
 4 using Microsoft.EntityFrameworkCore;
 5 
 6 namespace kiwiho.Course.MultipleTenancy.EFcore.Api.Infrastructure
 7 {
 8     public static class MultipleTenancyExtension
 9     {
10         public static IServiceCollection AddConnectionByDatabase(this IServiceCollection services)
11         {
12             services.AddDbContext<StoreDbContext>((serviceProvider, options)=>
13             {
14                 var resolver = serviceProvider.GetRequiredService<ISqlConnectionResolver>(); 
15                 
16                 options.UseMySql(resolver.GetConnection());
17             });
18 
19             return services;
20         }
21     }
22 }

MultipleTenancyExtension

4. 在Startup類中配置依賴注入和把TenantInfoMiddleware加入到管道中。

1 public void ConfigureServices(IServiceCollection services)
2         {
3             services.AddScoped<TenantInfo>();
4             services.AddScoped<ISqlConnectionResolver, HttpHeaderSqlConnectionResolver>();
5             services.AddConnectionByDatabase();
6             services.AddControllers();
7         }

ConfigureServices

在Configure內，在UseRouting前把TenantInfoMiddleware加入到管道

1 app.UseMiddleware<TenantInfoMiddleware>();

5. 配置好DbContext和對應的數據庫對象

 1 using Microsoft.EntityFrameworkCore;
 2 
 3 namespace kiwiho.Course.MultipleTenancy.EFcore.Api.DAL
 4 {
 5     public class StoreDbContext : DbContext
 6     {
 7         public DbSet<Product> Products { get; set; }
 8         public StoreDbContext(DbContextOptions options) : base(options)
 9         {
10         }
11     }
12 
13 }

StoreDbContext

 1 using System.ComponentModel.DataAnnotations;
 2 
 3 namespace kiwiho.Course.MultipleTenancy.EFcore.Api.DAL
 4 {
 5     public class Product
 6     {
 7         [Key]
 8         public int Id { get; set; } 
 9 
10         [StringLength(50), Required]
11         public string Name { get; set; }
12 
13         [StringLength(50)]
14         public string Category { get; set; }
15 
16         public double? Price { get; set; }
17     }
18 }

Product

6. 建立ProductController, 而且在裏面添加3個方法，分別是建立，查詢全部，根據id查詢。在構造函數經過EnsureCreated以達到在數據庫不存在是自動建立數據庫。

 1 using System;
 2 using System.Collections.Generic;
 3 using System.Threading.Tasks;
 4 using kiwiho.Course.MultipleTenancy.EFcore.Api.DAL;
 5 using Microsoft.AspNetCore.Mvc;
 6 using Microsoft.EntityFrameworkCore;
 7 
 8 namespace kiwiho.Course.MultipleTenancy.EFcore.Api.Controllers
 9 {
10     [ApiController]
11     [Route("api/Products")]
12     public class ProductController : ControllerBase
13     {
14         private readonly StoreDbContext storeDbContext;
15 
16         public ProductController(StoreDbContext storeDbContext){
17             this.storeDbContext = storeDbContext;
18             this.storeDbContext.Database.EnsureCreated();
19         }
20 
21         [HttpPost("")]
22         public async Task<ActionResult<Product>> Create(Product product){
23             var rct = await this.storeDbContext.Products.AddAsync(product);
24 
25             await this.storeDbContext.SaveChangesAsync();
26 
27             return rct?.Entity;
28 
29         }
30 
31         [HttpGet("{id}")]
32         public async Task<ActionResult<Product>> Get([FromRoute] int id){
33 
34             var rct = await this.storeDbContext.Products.FindAsync(id);
35 
36             return rct;
37             
38         }
39 
40         [HttpGet("")]
41         public async Task<ActionResult<List<Product>>> Search(){
42             var rct = await this.storeDbContext.Products.ToListAsync();
43             return rct;
44         }
45     }
46 }