abp一代資料遷解析

變形精怪發表於2020-07-07

abp版本5.9

概述

資料遷移無非就是兩件事情，1、建立資料庫，並根據實體建立對應的表；2、新增一些初始資料

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> ，它按簡單方式實現了：1、租戶資料庫的建立和初始資料的新增；2、租戶資料庫的建立和初始資料的新增；資料庫的建立的直接呼叫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)，提供自己的委託來新增初始資料

相關文章