最近在學習使用 abp 來做一些小程序。abp 是一個功能豐富的 .NET 開發框架，完全開源，遵循 DDD（領域驅動）設計模式，支持微服務開發，集成了 Identity、角色權限、本地化、動態代理、后臺任務、分布式消息、審計日志、多租戶支持等多個組件和特性，并提供了 Blazor 和 Angular 的前臺頁面。基于此框架可以遵循最佳實踐，省去自己開發腳手架的時間，提升開發效率。但因為 abp 封裝了非常多的功能，有時候需要花時間研究其配置，才能更好地發揮效能。

abp 的一個優勢是模塊化，可以在框架基礎上開發出一個個的 module，以方便重用。國內 .NET 社區里已經開發出了非常多的模塊，官方也提供了集成了很多模塊的商業版。對我來說，使用模塊解決的一個問題是，abp 升級非常頻繁，如果將我的業務系統做成模塊，能夠更好的與框架本身進行隔離，這樣以后框架升級的時候就無需擔心對業務系統有破壞性的更改。本文介紹了如何開發一個模塊，并使用單獨的數據庫及實現遷移。

創建 abp 項目

官方文檔已經提供了非常詳細的新建項目向導。參考：https://docs.abp.io/en/abp/latest/Getting-Started-Create-Solution?UI=Blazor&DB=EF&Tiered=Yes

CLI 命令參考：https://docs.abp.io/en/abp/latest/CLI

我們使用 abp CLI 創建一個新項目。我使用 Blazor 來開發前端頁面，正好學一下。

abp?new?MainApp?-u?blazor

然后按照官方文檔操作即可：https://docs.abp.io/en/abp/latest/Getting-Started-Running-Solution?UI=Blazor&DB=EF&Tiered=Yes

主要步驟是：

• 修改數據庫連接字符串

• 運行 .DbMigrator 項目初始化數據庫并填充初始數據。

• 運行 .HttpApi.Host ?項目

如果操作正確，我們應該能夠看到 Swagger 文檔了。

如果同時啟動 .HttpApi.Host 和 .Blazor 項目，前端頁面也應該可以正常展示。基本的用戶登錄、角色權限都有了。

創建一個新模塊

剛開始我是用 CLI 創建了一個新模塊，然后手動把兩個項目的 solution 文件集成到一塊，麻煩而且易出錯。后來發現原來 CLI 已經提供了將新模塊添加到現有解決方案的命令，可參考：https://docs.abp.io/en/abp/latest/CLI#options-3

可以使用以下的命令：

abp?add-module?MyModule?--new?--add-to-solution-file

注意運行該命令的時候要在 MainApp 的目錄下。這樣 CLI 會在當前目錄下創建一個 modules 目錄來存放新模塊的解決方案，同時把所有項目添加到 MainApp 的解決方案中，還會修改一些文件，這樣我們就不用手動集成模塊了。

添加新 Model

接下來繼續按照官方文檔來添加新的 Model：https://docs.abp.io/en/abp/latest/Tutorials/Part-1

具體內容這里就不展開了，可根據實際需要添加幾個 Model。

步驟大概是：

• 添加 Model

• 更新模塊 MyModule.EntityFrameworkCore 項目中的 MyModuleDbContext.cs 文件，添加相應的 DbSet

• 在 MyModuleDbContextModelCreatingExtensions.cs 中添加模型映射

為模塊準備數據庫遷移

接下來就是本文的重點，如何為模塊添加一個單獨的數據庫并實現數據庫遷移。

首先在 MainApp.EntityFrameworkCore 項目中添加目錄 EntityFrameworkCore\MyModule。在這個目錄中創建一個名為 MyModuleMigrationsDbContext.cs 的文件。內容如下：

public?class?MyModuleMigrationsDbContext?:?AbpDbContext<MyModuleMigrationsDbContext>{public?MyModuleMigrationsDbContext(DbContextOptions<MyModuleMigrationsDbContext>?options)?:?base(options){}protected?override?void?OnModelCreating(ModelBuilder?modelBuilder){base.OnModelCreating(modelBuilder);modelBuilder.ConfigureMyModule();}}

然后添加一個名為 MyModuleMigrationsDbContextFactory.cs 的文件：

public?class?MyModuleMigrationsDbContextFactory?:?IDesignTimeDbContextFactory<MyModuleMigrationsDbContext>{public?MyModuleMigrationsDbContext?CreateDbContext(string[]?args){var?configuration?=?BuildConfiguration();var?builder?=?new?DbContextOptionsBuilder<MyModuleMigrationsDbContext>().UseSqlServer(configuration.GetConnectionString("MyModule"));return?new?MyModuleMigrationsDbContext(builder.Options);}private?static?IConfigurationRoot?BuildConfiguration(){var?builder?=?new?ConfigurationBuilder().SetBasePath(Path.Combine(Directory.GetCurrentDirectory(),?"../MainApp.DbMigrator/")).AddJsonFile("appsettings.json",?optional:?false);return?builder.Build();}}

這兩個文件與 MainApp 的 DbContext 內容是類似的，大家可以比較一下。因為模塊也要從 appsettings.json 中讀取數據庫配置，因此我們需要修改 appsettings.json 中的數據庫鏈接字符串，注意需要修改兩個位置：一個是 MainApp.DbMigrator 項目中的，另一個是 MainApp.HttpApi.Host 項目中的。仿照 MainApp 的連接字符串添加一個名為 MyModule 的即可。這樣模塊就可以有一個單獨的數據庫了。

運行模塊數據庫遷移

創建了新的 Model 后，我們要對數據進行遷移，以應用這些更改。

將 terminal 導航到 MainApp.EntityFrameworkCore 目錄，運行以下命令：

dotnet?ef?migrations?add?migrationName?--context?MyModuleMigrationsDbContext?--output-dir?Migrations/MyModule

注意要指定要遷移的 DbContext，也就是 MyModuleMigrationsDbContext。同時我們還將遷移文件放在 Migrations/MyModule 目錄下，這樣不會與 MainApp 的遷移文件混淆。

如果一切正常，我們就可以在指定目錄下看到生成的遷移文件了。

運行以下命令以應用數據庫遷移：

dotnet?ef?database?update?--context?MyModuleMigrationsDbContext

這樣模塊的數據庫遷移就完成了。

其他設置

接下來按照官方文檔繼續添加相應的 AppService 及其接口等。這樣我們的模塊已經與 MainApp 是隔離的了，包括 Blazor 頁面也是在一個單獨的項目里。

如果運行 .HttpApi.Host 沒有看到模塊的 API，可以檢查下 MainApp.HttpApi.Host 項目中的 MainAppHttpApiHostModule.cs 文件，看是否配置正確：

private?void?ConfigureConventionalControllers(){Configure<AbpAspNetCoreMvcOptions>(options?=>{options.ConventionalControllers.Create(typeof(MainAppApplicationModule).Assembly);//?Add?the?below?lineoptions.ConventionalControllers.Create(typeof(MyModuleApplicationModule).Assembly);});}

再次運行 .HttpApi.Host 和 .Blazor 項目，可以看到前端頁面已經添加了一個新模塊的鏈接，只是內容頁是空的。接下來我們就可以在 MyModule 解決方案里的 Blazor 項目中開發前端頁面了。

在添加 Model 后我還遇到過一個錯誤，如下圖所示：

Autofact.Core.DependencyResolutionException: 'An exception was thrown while activating Volo.Abp.IdentityServer.Grants.PersistedGrantStore ....'

乍一看還以為是 IdentityServer 的問題，其實不是。展開看 inner exception 就會發現這個是我們添加的 Dto 的 mapping 導致的。因為 Entity 是有 Id 的，但 CreateUpdateProductDto 沒有Id，所以 mapping 出錯了。如果遇到這種情況，可以將 Id 省略掉：

CreateMap<CreateUpdateProductDto,?Product>().Ignore(x?=>?x.Id);

學習了幾天感覺這個框架還是挺方便的，功能非常強大，但學習起來還是有一定難度的。框架各部分之間的依賴非常多，如果不仔細研究，很容易處處碰壁。好在官方文檔寫的還是相對比較詳細的，只是部分文檔還有空缺。希望官方以后補足吧。是否使用框架開發是一個兩難的問題，太依賴框架可能會失去對細節的把控，處處受制于框架的實現；不使用框架就得自己重復造輪子。只能見仁見智了。

萬水千山總是情，點個關注行不行

天若有情天亦老，加個粉絲好不好

總結

以上是生活随笔為你收集整理的如何使用 abp 创建 module 并应用单独的数据库迁移的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。