abp版本5.9
概述
資料遷移無非就是兩件事情,1、創建資料庫,并根據物體創建對應的表;2、添加一些初始資料
abp的資料遷移也是完成這兩件事,比較特殊的是它是多租戶saas系統,而且支持不同的租戶有獨立的資料庫,所以abp中的遷移要先遷移戶主Host,再遷移租戶Tenant的資料庫
它的遷移定義了一個架子,這個架子定義了abp資料庫遷移的幾個步驟,在這些步驟挖了幾個坑,留給我們來自定義,
為了我們使用更方便,它還實作了一些簡單的默認資料的初始化
所以我們需要先搞懂abp資料庫遷移的基本原理,真正使用時我們只需要去填那幾個坑就可以了,
核心步驟
- 創建并初始化AbpBootstrapper,有點類似Main函式的功效,只不過它是abp系統的起點,它創建依賴注入容器,并注冊各abp模塊,并處理它們的依賴關系和執行順序
- 通過依賴注入獲取MultiTenantMigrateExecuter并執行Run方法,內部邏輯如下:
- 通過依賴注入獲取AbpZeroDbMigrator,
- 拿到戶主(Host)的連接字串
- 執行AbpZeroDbMigrator.CreateOrMigrateForHost 并傳遞一個委托,主要是創建戶主和相應的用戶角色權限等資訊,我們可以在這里定義創建更多租戶的邏輯
- 創建戶主(Host)資料庫和表結構
- 執行委托創建初始資料,其中包括戶主(host)的用戶角色權限等
- 獲取上一步驟創建好的更多租戶,遍歷它們逐一做資料庫遷移,使用AbpZeroDbMigrator.CreateOrMigrateForTenant(tenant),AbpZeroDbMigrator具體實作由我們提供,但它有抽象類,所以如果需要我們可以重寫幾個方法
一般情況紅色字體標注部分是我們比較關心的,主要是在遷移時添加更多租戶;為每個租戶添加默認資料;
模板專案下載后,有個XXX.Migrator專案,它就是abp資料庫遷移程式,是個控制臺,只是使用的話看官方檔案就可以了,下面分別說說里面的幾個核心類
AbpBootstrapper
這個我沒去細看,但是根據經驗應該能猜到它是ABP系統的起點,初始化時會去創建全域的依賴注入容器,從入口模塊開始,根據模塊間的依賴最終加載所需要的所有模塊,并根據依賴順序執行模塊中相應的方法,這里主要說遷移,所以不深入了,參考官方檔案就可以了 abp啟動配置 模塊系統 ,
默認情況下,創建AbpBootstrapper時是從XXXMigratorModule模塊開始加載的,而它依賴[DependsOn(typeof(XXXEntityFrameworkModule))],而后者又依賴XXXCoreModule,當然這條依賴線可能會更長,具體看你的專案了,
MultiTenantMigrateExecuter
AbpBootstrapper創建并初始化后,依賴注入框架就可以使用了,且各模塊也初始化好了,遷移時會從容器中取出一個MultiTenantMigrateExecuter,把它理解為多租戶遷移執行器,它是在MultiTenantMigrateExecuter模塊初始化時注冊的,它負責上面步驟的2.1 ——2.4
它主要是用來定義遷移的大步驟,雖然我們可以來修改這里的代碼,但是通常沒啥必要,核心步驟就是
- 從容器中取得AbpZeroDbMigrator
- 執行AbpZeroDbMigrator.CreateOrMigrateForHost 初始化戶主的資料庫并添加默認資料
- 執行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),提供自己的委托來添加初始資料
轉載請註明出處,本文鏈接:https://www.uj5u.com/net/3516.html
標籤:.NET Core

