ABP vnext模組化架構的最佳實踐的實現

黃明基發表於2020-10-13

在上一篇文章《手把手教你用Abp vnext構建API介面服務》中，我們用ABP vnext實現了WebAPI介面服務，但是並非ABP模組化架構的最佳實踐。我本身也在學習ABP，我認為ABP新手應該從最佳實踐開始學習，可以少走很多彎路，所以寫了這篇最佳實踐來做個總結，同時給其他朋友們提供一點參考。

一、什麼是模組化架構的最佳實踐

ABP是一個包含許多nuget包的模組化框架。它提供了一個完整的基礎架構來開發你自己的具有實體、服務、資料庫整合、API、 UI元件等等功能的應用程式模組。
模組化架構的最佳實踐就是按功能的劃分建立相應的模組實現的服務，必要時可以把模組釋出到nuget，由其他模組安裝組合成新的服務或單體應用。這樣就可以複用現有的模組功能，快速的交付產品，告別996。

二、模組化架構的最佳實踐說明

這部分內容全部來自於模組化架構最佳實踐 & 約定，有興趣的朋友可以去官方文件檢視。如果已經很熟悉ABP分層了，可以直接閱讀第三部分。

1、解決方案結構：

為每個模組建立一個單獨的解決方案。將解決方案命名為CompanyName.ModuleName。
一個模組做為分層專案開發，因為它有幾個包(專案)是相互關聯的。每個包都有自己的模組定義檔案,並顯式宣告所依賴的包/模組的依賴關係。

2、模組分層和包之間的關係

下面展示了一個分層良好的模組中的包以及它們之間的依賴關係:

領域層

將領域層劃分為兩個專案：

Domain.Shared 包(專案) 命名為CompanyName.ModuleName.Domain.Shared,包含常量,列舉和其他型別，它不能包含實體、儲存庫、域服務或任何其他業務物件。可以安全地與模組中的所有層使用。此包也可以與第三方客戶端使用。
Domain 包(專案) 命名為CompanyName.ModuleName.Domain，包含實體、倉儲介面、領域服務介面及其實現和其他領域物件。Domain 包依賴於 Domain.Shared 包。

應用服務層

將應用服務層劃分為兩個專案:

Application.Contracts 包(專案) 命名為CompanyName.ModuleName.Application.Contracts,包含應用服務介面和相關的資料傳輸物件(DTO)。 Application contract 包依賴於 Domain.Shared 包。
Application 包(專案)命名為CompanyName.ModuleName.Application,包含應用服務實現。Application 包依賴於 Domain 包和 Application.Contracts 包。

基礎設施層

為每個orm/資料庫整合建立一個獨立的整合包，比如Entity Framework Core 和 MongoDB。例如，建立一個抽象Entity Framework Core整合的CompanyName.ModuleName.EntityFrameworkCore 包。ORM 整合包依賴於 Domain 包。不推薦依賴於orm/資料庫整合包中的其他層.
為每個主要的庫建立一個獨立的整合包, 在不影響其他包的情況下可以被另一個庫替換.

HTTP 層

建立命名為CompanyName.ModuleName.HttpApi的HTTP API包，為模組開發REST風格的HTTP API。
- HTTP API 包只依賴於 Application.Contracts 包。不要依賴 Application 包。
- 為每個應用服務建立一個Controller (通常通過實現其介面)。這些控制器使用應用服務介面來委託操作。它根據需要配置路由，HTTP方法和其他與Web相關的東西。
建立一個為HTTP API包提供客戶端服務的HTTP API Client包，它的命名為Companyname.ModuleName.HttpApi.Client。這些客戶端服務將應用服務介面實現遠端端點的客戶端。
- HTTP API Client包僅依賴於 Application.Contracts包。
- 推薦使用ABP框架提供的動態代理HTTP C＃客戶端的功能。

Web 層

建立命名為CompanyName.ModuleName.Web的Web包。包含頁面、檢視、指令碼、樣式、影像和其他UI元件。Web包僅依賴於HttpApi包。

三、實現模組化架構的最佳實踐

開發環境：Mac Visual Studio Code
SDK：dotnet core 3.1
資料庫：PostgreSQL

建立專案資料夾，然後進入改資料夾的命令目錄執行以下命令建立專案

在上一篇文章中引入的是Volo.Abp.Identity的包，現在改用Volo.Abp.DDD的包，更簡潔。

/**建立解決方案**/
dotnet new sln
/**建立模組分層**/
dotnet new classlib -o src/Lemon.Account.Domain.Shared
dotnet new classlib -o src/Lemon.Account.Domain
dotnet new classlib -o src/Lemon.Account.EntityFrameworkCore
dotnet new classlib -o src/Lemon.Account.EntityFrameworkCore.DbMigrations
dotnet new classlib -o src/Lemon.Account.Application.Contracts
dotnet new classlib -o src/Lemon.Account.Application
dotnet new classlib -o src/Lemon.Account.HttpApi
dotnet new classlib -o src/Lemon.Account.HttpApi.Client
dotnet new web -o src/Lemon.Account.Host

/**加入解決方案**/
dotnet sln Lemon.Account.sln add src/Lemon.Account.Domain.Shared
dotnet sln Lemon.Account.sln add src/Lemon.Account.Domain
dotnet sln Lemon.Account.sln add src/Lemon.Account.EntityFrameworkCore
dotnet sln Lemon.Account.sln add src/Lemon.Account.EntityFrameworkCore.DbMigrations
dotnet sln Lemon.Account.sln add src/Lemon.Account.Application.Contracts
dotnet sln Lemon.Account.sln add src/Lemon.Account.Application
dotnet sln Lemon.Account.sln add src/Lemon.Account.HttpApi
dotnet sln Lemon.Account.sln add src/Lemon.Account.HttpApi.Client
dotnet sln Lemon.Account.sln add src/Lemon.Account.Host

/**分層間互相引用**/
dotnet add src/Lemon.Account.Domain/Lemon.Account.Domain.csproj reference src/Lemon.Account.Domain.Shared/Lemon.Account.Domain.Shared.csproj
dotnet add src/Lemon.Account.EntityFrameworkCore/Lemon.Account.EntityFrameworkCore.csproj reference src/Lemon.Account.Domain/Lemon.Account.Domain.csproj
dotnet add src/Lemon.Account.EntityFrameworkCore.DbMigrations/Lemon.Account.EntityFrameworkCore.DbMigrations.csproj reference src/Lemon.Account.EntityFrameworkCore/Lemon.Account.EntityFrameworkCore.csproj
dotnet add src/Lemon.Account.Application/Lemon.Account.Application.csproj reference src/Lemon.Account.Application.Contracts/Lemon.Account.Application.Contracts.csproj
dotnet add src/Lemon.Account.Application/Lemon.Account.Application.csproj reference src/Lemon.Account.Domain/Lemon.Account.Domain.csproj
dotnet add src/Lemon.Account.HttpApi/Lemon.Account.HttpApi.csproj reference src/Lemon.Account.Application.Contracts/Lemon.Account.Application.Contracts.csproj
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj reference src/Lemon.Account.EntityFrameworkCore.DbMigrations/Lemon.Account.EntityFrameworkCore.DbMigrations.csproj
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj reference src/Lemon.Account.Application/Lemon.Account.Application.csproj
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj reference src/Lemon.Account.HttpApi/Lemon.Account.HttpApi.csproj

/**新增nuget依賴包**/
dotnet add src/Lemon.Account.Domain.Shared/Lemon.Account.Domain.Shared.csproj package Volo.Abp.Validation
dotnet add src/Lemon.Account.Domain/Lemon.Account.Domain.csproj package Volo.Abp.Ddd.Domain
dotnet add src/Lemon.Account.Domain/Lemon.Account.Domain.csproj package Lemon.Common

dotnet add src/Lemon.Account.EntityFrameworkCore/Lemon.Account.EntityFrameworkCore.csproj package Volo.Abp.EntityFrameworkCore
dotnet add src/Lemon.Account.EntityFrameworkCore/Lemon.Account.EntityFrameworkCore.csproj package Volo.Abp.EntityFrameworkCore.PostgreSql

dotnet add src/Lemon.Account.EntityFrameworkCore.DbMigrations/Lemon.Account.EntityFrameworkCore.DbMigrations.csproj package Volo.Abp.EntityFrameworkCore
dotnet add src/Lemon.Account.EntityFrameworkCore.DbMigrations/Lemon.Account.EntityFrameworkCore.DbMigrations.csproj package Volo.Abp.EntityFrameworkCore.PostgreSql
dotnet add src/Lemon.Account.EntityFrameworkCore.DbMigrations/Lemon.Account.EntityFrameworkCore.DbMigrations.csproj package Microsoft.EntityFrameworkCore.Design

dotnet add src/Lemon.Account.Application.Contracts/Lemon.Account.Application.Contracts.csproj package IdentityModel
dotnet add src/Lemon.Account.Application.Contracts/Lemon.Account.Application.Contracts.csproj package Volo.Abp.Ddd.Application.Contracts

dotnet add src/Lemon.Account.Application/Lemon.Account.Application.csproj package Volo.Abp.Ddd.Application
dotnet add src/Lemon.Account.Application/Lemon.Account.Application.csproj package Volo.Abp.AutoMapper

dotnet add src/Lemon.Account.HttpApi/Lemon.Account.HttpApi.csproj package Volo.Abp.AspNetCore.Mvc

dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Volo.Abp.AspNetCore.Mvc
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Swashbuckle.AspNetCore
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Microsoft.AspNetCore.DataProtection.StackExchangeRedis
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Microsoft.Extensions.Caching.StackExchangeRedis
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Serilog.AspNetCore
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Serilog.Settings.Configuration
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Serilog.Sinks.Async
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Serilog.Sinks.File
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Volo.Abp.AspNetCore.Serilog
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Volo.Abp.Autofac
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package IdentityServer4.AccessTokenValidation
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj reference src/Lemon.Account.EntityFrameworkCore.DbMigrations/Lemon.Account.EntityFrameworkCore.DbMigrations.csproj

實現領域層

在Domain建立實體類及其約束關聯，具體程式碼請看UserData類，此處不再詳細說明。

實現基礎設施層

在EntityFrameworkCore建立AccountDbContext類和LemonAccountDbContextModelCreatingExtensions類。請特別關注LemonAccountDbContextModelCreatingExtensions類，主要是用來定義實體在資料庫表中的欄位屬性。

實現應用服務層

實現httpapi

用swagger除錯介面

進入Host目錄，執行命令

dotnet watch run

服務啟動成功，在瀏覽器開啟連結http://localhost:5000/swagger/index.html，開始除錯賬號註冊和驗證介面。結果如下：

四、模組化架構的最佳實踐的好處

使用模組化架構的好處有幾點：

可以方便的更換模組
比如我現在用的資料庫是PostgreSQL，如果想要更換成MySQL，只要以EntityFrameworkCore層為基礎，新增一個MySQL連線庫，就可以在不改變業務邏輯的前提下快速的切換資料庫。

dotnet new classlib -o src/Lemon.Account.EntityFrameworkCore.MySQL
dotnet new classlib -o src/Lemon.Account.EntityFrameworkCore.MySQL.DbMigrations
dotnet sln Lemon.Account.sln add src/Lemon.Account.EntityFrameworkCore.MySQL
dotnet sln Lemon.Account.sln add src/Lemon.Account.EntityFrameworkCore.MySQL.DbMigrations

dotnet add src/Lemon.Account.EntityFrameworkCore.MySQL/Lemon.Account.EntityFrameworkCore.MySQL.csproj reference src/Lemon.Account.Domain/Lemon.Account.Domain.csproj
dotnet add src/Lemon.Account.EntityFrameworkCore.MySQL.DbMigrations/Lemon.Account.EntityFrameworkCore.MySQL.DbMigrations.csproj reference src/Lemon.Account.EntityFrameworkCore.MySQL/Lemon.Account.EntityFrameworkCore.MySQL.csproj

dotnet add src/Lemon.Account.EntityFrameworkCore.MySQL/Lemon.Account.EntityFrameworkCore.MySQL.csproj package Volo.Abp.EntityFrameworkCore.MySQL

dotnet add src/Lemon.Account.EntityFrameworkCore.MySQL.DbMigrations/Lemon.Account.EntityFrameworkCore.MySQL.DbMigrations.csproj package Microsoft.EntityFrameworkCore.Design

最後再修改ConnectionStrings default為mysql的連線，修改LemonAccountHostModule的依賴項LemonAccountEntityFrameworkCoreDbMigrationsModule為MySQL

單體應用和微服務無縫切換
模組開發完成後，一般當作微服務來部署；或者把模組釋出到nuget，在單體應用的各個分層中引入模組，多個模組在單體應用中的應用就構成了一個完整系統服務。
模組複用
由於模組是釋出到nuget的，所以如果有新的專案需要用到相同功能的，可以直接從nuget引入安裝，無需重複開發或者複製程式碼。
自動API控制器
動態 C# API 客戶端

GiHub地址：https://github.com/huangbenq/abp-samples

參考文件：

模組化：https://docs.abp.io/zh-Hans/abp/latest/Module-Development-Basics
最佳實踐：https://docs.abp.io/zh-Hans/abp/latest/Best-Practices/Index
自動API控制器：https://docs.abp.io/zh-Hans/abp/latest/API/Auto-API-Controllers

初識ABP vNext（6）：vue+ABP實現國際化
2020-08-26
Vue
淺談Abp vNext的模組化設計
2020-12-02
iOS 元件化/模組化架構設計實踐
2021-10-31
iOS元件化架構
OData WebAPI實踐-與ABP vNext整合
2023-05-16
WebAPI
Abp Vnext Vue3 的版本實現
2021-11-07
Vue
微服務架構最佳實踐
2019-04-21
微服務架構
基於 WPF 模組化架構下的本地化設計實踐
2019-08-13
架構
Android 基於註解IOC元件化/模組化的架構實踐
2018-04-15
Android元件化架構
關於 JS 模組化的最佳實踐總結
2019-01-21
JS
Redis 高可用架構最佳實踐
2017-05-28
Redis架構
編寫架構文件的最佳實踐 - Singh
2021-11-12
架構
Google 官方應用架構的最佳實踐指南
2017-06-19
Go應用架構
初識ABP vNext（9）：ABP模組化開發-檔案管理
2020-09-14
Gulp 結構化最佳實踐
2016-08-23
iOS架構：AOP實現區域性模組化
2019-04-02
iOS架構
微服務架構十條最佳實踐
2018-07-04
微服務架構
J2EE架構的6個最佳實踐
2005-04-05
架構
簡單實現微服務架構的實踐分享
2023-02-24
微服務架構
開發者最佳實踐日•第13期－實踐微服務架構
2015-05-19
微服務架構
ABP VNext實踐之搭建可用於生產的IdentityServer4
2020-09-02
IDEServer
Abp vNext 基礎篇丨分層架構
2021-08-19
架構
華為雲：微服務架構下的效能保障最佳實踐
2019-03-19
微服務架構
前端外掛化架構的探索和實踐
2020-09-21
前端架構
WebRTC 架構優化及實踐
2018-09-28
Web架構優化
Abp vNext 模組載入機制
2023-09-25
初識ABP vNext（5）：ABP擴充套件實體
2020-08-21
套件
實現容器安全管理的最佳實踐
2022-04-22
美團視覺GPU推理服務部署架構最佳化實踐
2023-02-10
視覺GPU架構
保護你微服務架構安全的三個最佳實踐
2022-05-09
微服務架構
架構師必備：多維度查詢的最佳實踐
2022-05-22
架構
maven最佳實踐：劃分模組
2015-07-18
Maven
雲原生架構日誌監控最佳實踐
2022-02-28
架構
MySQL高可用架構案例篇：UCloud最佳實踐
2018-05-26
MySql架構Cloud
mvc架構的簡單實踐----使用者註冊的實現
2024-11-04
MVC架構
搜狐服務架構優化實踐
2019-02-27
架構優化
ABP vNext 實現租戶Id自動賦值插入
2021-01-23
賦值
TencentHub的架構實現
2018-07-17
架構
開發者最佳實踐日·第15期－實踐微服務架構北京站
2015-07-09
微服務架構