abp一代數據遷解析

abp版本5.9

概述

數據遷移無非就是兩件事情，一、建立數據庫，並根據實體建立對應的表；二、添加一些初始數據

abp的數據遷移也是完成這兩件事，比較特殊的是它是多租戶saas系統，並且支持不一樣的租戶有獨立的數據庫。因此abp中的遷移要先遷移戶主Host，再遷移租戶Tenant的數據庫

它的遷移定義了一個架子，這個架子定義了abp數據庫遷移的幾個步驟，在這些步驟挖了幾個坑，留給咱們來自定義。

爲了咱們使用更方便，它還實現了一些簡單的默認數據的初始化

因此咱們須要先搞懂abp數據庫遷移的基本原理，真正使用時咱們只須要去填那幾個坑就能夠了。

核心步驟

1. 建立並初始化AbpBootstrapper，有點相似Main函數的功效，只不過它是abp系統的起點。它建立依賴注入容器，並註冊各abp模塊，並處理它們的依賴關係和執行順序
2. 經過依賴注入獲取MultiTenantMigrateExecuter並執行Run方法，內部邏輯以下：
   1. 經過依賴注入獲取AbpZeroDbMigrator，
   2. 拿到戶主(Host)的鏈接字符串
   3. 執行AbpZeroDbMigrator.CreateOrMigrateForHost 並傳遞一個委託。主要是建立戶主和相應的用戶角色權限等信息。咱們能夠在這裏定義建立更多租戶的邏輯
      1. 建立戶主(Host)數據庫和表結構
      2. 執行委託建立初始數據，其中包括戶主（host）的用戶角色權限等
   4. 獲取上一步驟建立好的更多租戶，遍歷它們逐一作數據庫遷移。使用AbpZeroDbMigrator.CreateOrMigrateForTenant(tenant)，AbpZeroDbMigrator具體實現由咱們提供，但它有抽象類，因此若是須要咱們能夠重寫幾個方法

通常狀況紅色字體標註部分是咱們比較關心的，主要是在遷移時添加更多租戶；爲每一個租戶添加默認數據；

模板項目下載後，有個XXX.Migrator項目，它就是abp數據庫遷移程序，是個控制檯。只是使用的話看官方文檔就能夠了。下面分別說說裏面的幾個核心類

AbpBootstrapper

這個我沒去細看，可是根據經驗應該能猜到它是ABP系統的起點，初始化時會去建立全局的依賴注入容器，從入口模塊開始，根據模塊間的依賴最終加載所須要的全部模塊，並根據依賴順序執行模塊中相應的方法。這裏主要說遷移，因此不深刻了，參考官方文檔就能夠了 abp啓動配置 模塊系統  。

默認狀況下，建立AbpBootstrapper時是從XXXMigratorModule模塊開始加載的，而它依賴[DependsOn(typeof(XXXEntityFrameworkModule))]，然後者又依賴XXXCoreModule，固然這條依賴線可能會更長，具體看你的項目了。

MultiTenantMigrateExecuter

AbpBootstrapper建立並初始化後，依賴注入框架就可使用了，且各模塊也初始化好了。遷移時會從容器中取出一個MultiTenantMigrateExecuter，把它理解爲多租戶遷移執行器，它是在MultiTenantMigrateExecuter模塊初始化時註冊的。它負責上面步驟的2.1 ——2.4

它主要是用來定義遷移的大步驟，雖然咱們能夠來修改這裏的代碼，可是一般沒啥必要。核心步驟就是

1. 從容器中取得AbpZeroDbMigrator
2. 執行AbpZeroDbMigrator.CreateOrMigrateForHost 初始化戶主的數據庫並添加默認數據
3. 執行AbpZeroDbMigrator.CreateOrMigrateForTenant(tenant);爲每個租戶建立數據庫和初始數據

先無論AbpZeroDbMigrator是哪註冊的，

在步驟2中執行CreateOrMigrateForHost 時丟入了一個委託SeedHelper.SeedHostDb，它默認狀況下初始化Host數據庫，並添加戶主和默認的用戶、角色、權限等數據。因此若是咱們只是先在遷移時添加更多租戶，能夠來修改SeedHelper.SeedHostDb靜態方法。

步驟3默認狀況下啥都沒幹，可是在這個大步驟中執行了它，因此若是咱們想爲每一個租戶添加一些初始數據，咱們應該提供AbpZeroDbMigrator.CreateOrMigrateForTenant(tenant);方法，具體如何作呢？往下看

AbpZeroDbMigrator

MultiTenantMigrateExecuter定義了遷移的幾個大步驟，初始化Host數據庫並添加默認數據；初始化租戶數據庫並添加默認數據；這兩個任務的具體邏輯是交給AbpZeroDbMigrator來完成的

AbpZeroDbMigrator是咱們提供的，定義在XXX.EntityFrameworkCore項目中，它實現IAbpZeroDbMigrator接口。它在模塊的初始化方法中註冊打動依賴注入容器的。

爲了咱們使用更簡單，abp爲咱們提供一個抽象類AbpZeroDbMigrator<TDbContext> ，它按簡單方式實現了：一、租戶數據庫的建立和初始數據的添加；二、租戶數據庫的建立和初始數據的添加；數據庫的建立的直接調用DbContext.DataBase.Migrate()，這是EF提供的功能，初始數據的添加則是讓調用方來提供，就是個委託，在建立數據庫後會回調這個委託。

所以下載的abp項目模板中XXX.EntityFrameworkCore中定義的XXXDbMigrator繼承了AbpZeroDbMigrator<TDbContext>，但卻沒有實現，由於父類都作好了。

到此，數據庫的建立最終是efcore的Migrate方法完成的，Host戶主的初始數據的添加的委託是直接由SeedHelper.SeedHostDb來提供的。租戶的初始數據的添加咱們能夠在本身的XXXDbMigrator中重寫CreateOrMigrateForTenant方法來實現，水在這個方法內咱們能夠經過參數拿到當前的租戶，委託中的參數爲咱們提供了當前租戶的dbContext，所以咱們不用關心這個dbcontext是每一個租戶一個，仍是各租戶使用的是同一個數據庫。

總結

要在數據庫初始化時添加更多租戶，在XXX.EntityFrameworkCore/Seed/SeedHelper中改

要爲每一個租戶添加一些初始數據是，在XXX.EntityFrameworkCore/AbpZeroDbMigrator中重寫CreateOrMigrateForTenant(AbpTenantBase tenant)，而後調用父類的CreateOrMigrateForTenant(AbpTenantBase tenant, Action<TDbContext> seedAction)，提供本身的委託來添加初始數據