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 來使用該模板進行項目的創建，相對來說也就更方便了，至此整個模板的精簡的操作也就結束了，希望可以對你有所幫助

ABP 適用性改造 - 精簡 ABP CLI 生成的項目結構

Overview

Step by Step

2.1、運行模板項目

2.1.1、調整數據庫連接字符串

2.1.2、執行數據庫遷移

2.1.3、運行程序

2.2、精簡項目功能

2.2.1、精簡模板功能

2.3、簡化項目結構

2.3.1、合併 EntityFramework Core 相關功能類庫

2.3.2、合併 API 宿主相關功能

2.4、搭建項目腳手架

在 Docker Desktop 中啓用 K8s 服務

ABP 適用性改造 - 添加 API 版本化支持

ABP 適用性改造 - 精簡 ABP CLI 生成的項目結構

在 ASP.NET Core 應用中使用 Cookie 進行身份認證

從零開始針對 .NET 應用的 DevOps 運營實踐 - Jenkins & SonarQube 安裝配置

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結