ABP 適用性改造 - 精簡 ABP CLI 生成的專案結構

Overview

不管是公司或者個人都會有不同的開發習慣，通過建立專案模板，既可以使開發人員聚焦于業務功能的開發，也可以在一定程度上統一不同開發人員之間的開發風格，在使用 ABP 框架的程序中，對于 ABP 生成的默認專案模板，類別庫多，附加功能多，是目前在部門內部推行 ABP 程序中遇到的問題，因此，本篇文章將針對 ABP 默認生成的模板專案進行精簡，構建出一個簡化版的 ABP 專案模板

模板原始碼地址：https://github.com/danvic712/ingos-abp-api-template

Step by Step

在精簡專案結構之前肯定需要一個由 ABP CLI 生成的默認專案模板供我們進行參考，創建 ABP 專案主要有如下的兩種方式進行

第一種，通過使用 ABP CLI 這么一個 dotnet tool 來創建一個基礎專案，只需要將 ABP CLI 全域安裝到電腦上，就可以通過腳手架來生成所需專案

-- 全域安裝 ABP CLI
dotnet tool install -g Volo.Abp.Cli

-- 全域更新 ABP CLI
dotnet tool update -g Volo.Abp.Cli

當安裝完成之后，輸入 abp help 就可以查看該腳手架提供的功能，例如這里我們需要通過 abp new 命令來創建專案，同時基于不同的需求，在創建專案時附加不同的引數即可

第二種，則是直接通過官網(https://abp.io/get-started)進行下載，本篇文章中所使用到的專案模板就是使用該方法，直接在官網上下載的模板基礎上進行調整的

在官網創建專案時需要輸入專案的相關資訊，因為這里需要改造的是 Web API 專案，所以 UI 框架選擇了 Angular，同時，因為默認的 ABP 模板會把 IdentityServer 和 API 專案混在一起，所以這里我會把這兩塊的功能進行拆分，確定專案型別無誤之后，點擊現在創建按鈕，等待瀏覽器提示有檔案需要下載即可

2.1、運行模板專案

解壓下載完成的安裝包，如果你和我創建的專案選項相同的話，這里會包含兩個檔案夾，因為僅針對后端專案進行調整，這里只關注 aspnet-core 檔案夾中的內容即可，在改造之前，我們先依據官方檔案中的使用說明來進行操作，確保模板是可以正常運行起來之后再進行后續的調整，

2.1.1、調整資料庫連接字串

在 ABP 生成的模板專案中，整個專案的組態檔 appsettings.json 檔案存在于三個地方，.DbMigrator、.HttpApi.Host、.IdentityServer，先不去關注這三個專案的具體作用，首先將這三處組態檔中的資料庫連接字串修改為實際使用的配置資訊

"ConnectionStrings": {
    "Default": "Server=localhost;Port=3306;Database=IngosAbpTemplate;Uid=root;Pwd=myPassword;"
},

2.1.2、執行資料庫遷移

在調整完資料庫連接配置之后，就可以執行資料庫的遷移操作，從而實作初始化專案模板中內置的一些資料表結構 or 初始化資料

這里，將 .DbMigrator 設定為啟動專案，直接運行，等待程式的運行完成即可，此時，打開你所使用的 DBMS 工具，可以看到模板專案中定義的表已經遷移到了我們指定的資料庫中

可以看到，整個模板專案中包含了很多的東西，絕大多數的功能都不會是我們平常在開發業務功能時經常能夠使用到的

2.1.3、運行程式

當資料庫遷移成功之后就可以正式運行了，在這個模板程式中存在著兩個 Web 應用，.HttpApi.Host、.IdentityServer，分別對應于 API 介面的宿主以及 IdentityServer 的宿主，因為后續會移除掉 IdentityServer 相關的功能，所以這里就只運行 .HttpApi.Host 這一個站點了

將 .HttpApi.Host 設定為啟動程式，這里并不會進行除錯，所以直接通過 Ctrl + F5 運行，專案會自動打開 swagger 頁面

2.2、精簡專案功能

當程式可以運行起來之后，就可以針對模板專案進行精簡及改造，這里主要包含兩塊的內容，精簡模板的功能以及簡化專案的結構

2.2.1、精簡模板功能

首先這里會移除掉 .IdentityServer 這個 Web 專案以及目前使用不到的 test 檔案夾，從上面運行的 swagger 頁面中就可以看到，初始化的模板中包含了一些業務功能開發中可能用不到的功能，而這些功能則是包含在專案所參考的 ABP 類別庫中的，因此，對于模板功能的精簡則是將參考的一些用不到的 Volo.Abp.* 類別庫進行去除，僅保留我們所需的部分

這里我移除了下列的程式集參考，重新編譯解決方案，不出意外會報很多的錯誤，因為具體的排錯程序會涉及到很多，不太好用文字進行描述，所以這里就跳過了

• Volo.Abp.Account.*

• Volo.Abp.Identity.*

• Volo.Abp.IdentityServer.*

• Volo.Abp.PermissionManagement.*

• Volo.Abp.TenantManagement.*

• Volo.Abp.FeatureManagement.*

• Volo.Abp.SettingManagement.*

• Volo.Abp.AspNetCore.Mvc.UI.MultiTenancy

這里對于模板專案中的功能基本上都移除了，只保留了 audit 日志、后臺任務、郵件通知、物件映射、EF Core 這類的基礎服務

總結來說，對于移除功能后導致的編譯報錯，只需要將相關的類檔案、參考直接洗掉就好，而對于功能移除之后產生的代碼問題，就需要具體分析了，這類的問題基本上是初始化資料（DataSeed）的功能，我這邊采取的是直接移除相關的功能

至此，當你進行到這一步時，也就可以順勢將 .DbMigrator 這個專門用于資料庫遷移的控制臺應用進行移除了，而對于遷移的這個功能，在下面的內容中我也將補充到別的類別庫上

哦對了，在移除上面的功能之后，你還需要在如下的類別庫中添加對應的 ABP 程式集參考，從而確保程式可以編譯通過

• .Application 參考 Volo.Abp.Ddd.Application
• .Domain.Shared 參考 Volo.Abp.Validation
• .HttpApi 參考 Volo.Abp.AspNetCore.Mvc
• .HttpApi.Client 參考 Volo.Abp.Http.Client

如果不出意外的話，你的應用已經能夠編譯成功，并且可以再次運行了，從 swagger 也就可以看出，整個模板去掉了絕大多數的功能，當然，如果你覺得這個程序比較麻煩的話，也可以直接使用文章開頭所列到的 github 的專案，然后在上面基于你的需求進行調整即可

2.3、簡化專案結構

讓我們再回到最原始的后端模板專案中，整個后端解決方案的專案全域結構如下所示

因為移除了單元測驗的相關類別庫，從專案依賴關系圖中就可以看到，整個解決方案中，包含了三個最頂層的專案，.IdentityServer、.HttpApi.Host、.DbMigrator，其它類別庫之間通過相互參考，構建出專案的分層基礎

當然，在上面進行模板功能的精簡時，已經將 .IdentityServer、.DbMigrator 這一塊進行了整體的移除

2.3.1、合并 EntityFramework Core 相關功能類別庫

因為這里選擇了 EntityFramework Core（以下簡稱 EF Core）作為專案的 ORM，如果使用 Code First 模式的話，不可避免的會使用到 migrations 這樣一個遷移的操作，在原始的模板中，存在著如下的三個類別庫與之存在關聯

• .DbMigrator：控制臺程式，主要是為了進行資料庫的遷移作業（migration）
• .EntityFrameworkCore：集成 EF Core 到專案中，定義 DbContext 和領域中的資料訪問倉儲（Repository），在整個專案中提供資料持久化以及資料訪問
• .EntityFrameworkCore.DbMigrations：執行 EF Core 的遷移

可以看到，ABP 作為一個模塊化的框架，對于每個類別庫的使用用途定義的非常清楚，但是，在實際的開發中，對于正式環境資料庫的操作基本上都是交由 DBA 來執行的，EF Core 的 migration 更多的是在開發時進行使用，同時，如果真的這樣劃分的話，至少我遇到的絕大多數開發人員都是會叫的

介于上面已經將 .DbMigrator 進行了移除，因此，這里將對于 EF Core 的相關操作全部合并到 .EntityFrameworkCore 這個類別庫中

為了方便起見，我們先把 .EntityFrameworkCore.DbMigrations 中的檔案全部拷貝一份到 .EntityFrameworkCore 這個類別庫中，然后直接在解決方案中移除掉原有的類別庫后再進行調整

PS：這里的 Migrations 檔案夾以及 .EntityFrameworkCore.DbMigrations 的模塊類就可以直接洗掉了，畢竟上面我們精簡了模板的功能后，絕大多數的表也不復存在了 ，后面在類別庫合并后也會重新執行資料庫遷移的操作

因為現在會在 .EntityFrameworkCore 上執行 migration 的操作，所以這里需要添加上 EF Core 官方的 Design 組件包

Install-Package Microsoft.EntityFrameworkCore.Design

對于從 .DbMigrations 這個類別庫，其實是存在參考關系的，當整體洗掉之后，我們需要在 .HttpApi.Host 上添加對于 .EntityFrameworkCore 這個類別庫的參考，同時，對于拷貝過來的檔案，其實是存在功能重復的問題，所以這里我們需要對這些檔案進行合并歸納

首先，則是需要對于 DbContext 這個資料庫背景關系物件進行合并，從下圖中可以看到，兩個 DbContext 主要在配置物體映射關系的地方有所差異，因此這里直接將 MigrationsDbContext 這個類中關于 ABP 內置框架的物體映射配置拷貝過去即可，然后就可以直接洗掉了

對于每個 ABP 類別庫來說，都會存在一個入口的模塊類，這里對比后就可以發現，直接將 EntityFrameworkCoreDbMigrationsModule 這個模塊類洗掉即可，然后你需要將 .HttpApi.Host 專案中參考的這個模塊型別改為 EntityFrameworkCoreModule

此時，編譯解決方案，報錯的問題主要是因為參考了已經洗掉的 DbContext，這里直接替換成現在使用的即可

這里還有一項需要注意，從上圖中的第 27 行可以看到，這里獲取的是 .DbMigrator 這個控制臺應用中的組態檔，所以這里也需要同步修改成獲取 .HttpApi.Host 專案中的組態檔

自此，涉及到 EF Core 相關功能的類別庫就合并完成了，定位到 .EntityFrameworkCore 這個類別庫，在控制臺中就可以通過 migrations 命令來執行資料庫的遷移作業，因為已經執行過一次了，所以直接將原來的庫洗掉即可

-- 1、創建遷移檔案
dotnet ef migrations add Initialize

-- 2、應用到資料庫中
dotnet ef database update

PS：這里使用的是 EF Core tools 這么一個 dotnet tool，如果控制臺提示你找不到命令的話，你需要先安裝該工具到你的電腦上

dotnet tool install --global dotnet-ef

等待遷移作業的完成，資料庫也重新生成了對應的表，此時再次運行專案，系統運行無誤后即可進行后續的操作

2.3.2、合并 API 宿主相關功能

一般來說，我們會在 ASP.NET Core 專案中來定義 Controller，并以此作為整個介面專案的宿主程式，在 ABP 中，涉及到 API 介面的包含了如下的三個類別庫

• .HttpApi：定義 API 介面的 controller
• .HttpApi.Client：用于設定其它 C# 程式呼叫該 API 的 HTTP 代理
• .HttpApi.Host：API 介面的宿主程式

這里的 .HttpApi.Client 的類別庫我們使用不到，所以直接洗掉即可，對于剩下的兩個類別庫將進行合并，統一至 .HttpApi.Host 這個 ASP.NET Core 專案中

對于這兩個類別庫的合并很簡單，直接將 .HttpApi 專案中的類檔案直接拷貝到 .HttpApi.Host 中即可，然后將模塊類中的配置進行移動，最后直接洗掉 .HttpApi 類別庫，并將相關參考洗掉即可

至此，整個模板專案的簡化也就結束了，在保留 ABP 的設計思想下，基于開發現狀，構建了一個相對單一的模板專案，調整后的專案參考關系圖如下所示

2.4、搭建專案腳手架

當整個調整完成之后，后續再創建一個新的專案時不可能再執行一次這樣的操作，因此這里會創建一個 nuget 包進行發布，這樣后面就可以直接通過 dotnet cli 命令來直接創建專案來使用

對于搭建專案模板的程序這里就不詳細描述了，如果有需要的同學，可以參考博客園中的這一篇文章（打造自己的.NET Core專案模板），在這個程序中我們需要新建兩個檔案 template.json 以及 Ingos.Abp.Templates.csproj ，調整后的專案檔案夾結構如下所示

這里列出來了我目前使用的配置，你可以進行參考，如果你需要添加別的引數的話，可以參考官網檔案（dotnet new 自定義模板）

{
  "$schema": "http://json.schemastore.org/template",
  "author": "Danvic Wang",
  "classifications": [ "Web/WebAPI" ],
  "name": "Ingos Web API with ABP Framework",
  "identity": "Ingos.Abp.Templates",
  "shortName": "ingos-abp",
  "tags": {
    "language": "C#",
    "type": "project"
  },
  "sourceName": "IngosAbpTemplate",
  "preferNameDirectory": true
}

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <PackageType>Template</PackageType>
    <PackageVersion>1.0.1</PackageVersion>
    <PackageId>Ingos.Abp.Templates</PackageId>
    <Title>Ingos.Abp.Templates</Title>
    <Authors>Danvic Wang</Authors>
    <Description>Ingos Web API with ABP Framework</Description>
    <PackageTags>dotnet-new;templates;abp;domain-driven-design</PackageTags>

    <TargetFramework>net5.0</TargetFramework>

    <IncludeContentInPack>true</IncludeContentInPack>
    <IncludeBuildOutput>false</IncludeBuildOutput>
    <ContentTargetFolders>content</ContentTargetFolders>
    <NoWarn>$(NoWarn);NU5128</NoWarn>
    <PackageLicenseExpression>MIT</PackageLicenseExpression>
    <Copyright>Copyright (c) 2021 Danvic Wang</Copyright>
    <PackageIcon>logo.png</PackageIcon>
    <Product>Ingos.Abp.Templates</Product>
    <Company>Danvic Wang</Company>
    <RepositoryUrl>https://github.com/danvic712/ingos-abp-api-template</RepositoryUrl>
    <PackageProjectUrl>https://github.com/danvic712/ingos-abp-api-template</PackageProjectUrl>
    <RepositoryType>git</RepositoryType>
  </PropertyGroup>

  <ItemGroup>
    <Content Include="templates\**\*" Exclude="templates\.vs\**;templates\**\Logs\**;templates\**\bin\**;templates\**\obj\**;" />
    <Compile Remove="**\*" />
  </ItemGroup>

  <ItemGroup>
    <None Include="resource\images\logo.png">
      <Pack>True</Pack>
      <PackagePath></PackagePath>
    </None>
  </ItemGroup>
</Project>

當配置定義完成之后，定位到 Ingos.Abp.Templates.csproj 所在的路徑，執行 dotnet pack -o . 命令即可生成一個包含版本號的 .nupkg 檔案，之后就可以將該檔案上傳到公有 or 私有的 nuget 倉庫中供別人進行下載使用

以我這里創建的專案為例，因為我已經上傳到 nuget 官方倉庫上了，因此，你可以使用如下的命令進行安裝

dotnet new -i Ingos.Abp.Templates

安裝完成后就可以通過 dotnet 命令進行專案的創建，在最新版的 VS 中，你也可以直接通過 IDE 來使用該模板進行專案的創建，相對來說也就更方便了，至此整個模板的精簡的操作也就結束了，希望可以對你有所幫助

標籤：.NET Core

上一篇：Dotnet洋蔥架構實踐

下一篇：JWT理論知識