abp加DDD開發:低耦合、可復用、可擴展的【工單】業務模塊-簡介和集成


前言

很多場景【單體+模塊化】比微服務更合適,開發難度低、代碼可復用性強、可擴展性強。模塊化開發有些難點,模塊啟動與卸載、模塊之間的依賴和通訊。asp.net core abp為我們提供了模塊化開發能力及其它基礎功能。基於abp(一代6.3)結合DDD已基本開發好一個【工單管理模塊】,本篇做個基本介紹並說明如何集成此模塊。

資源

視頻講解:https://www.bilibili.com/video/BV1ky4y1b79u/

線上demo:http://web1.cqyuzuji.com:9000/  賬號:admin 密碼:123qwe

后端源碼:https://gitee.com/bxjg1987_admin/abp

前端源碼:https://gitee.com/bxjg1987_admin/front

必備知識

熟悉asp.net core和abp(注意是老版本,非vNext,但也很容易遷移到vNext上)

術語

下文會提供到一些概念,理解這個黑重要。

abp模塊:這個不解釋了,是abp基礎,請參考官方文檔

通用模塊:這個是使用abp模塊開發方式做的一些通用的,與具體業務無關的模塊,比如:數據字典模塊

業務模塊:工單管理、廣告管理、電商模塊等為了實現具體業務的模塊。

業務場景

客戶是做復印機出租的,它希望做一套系統管理整個業務,其中工單是一個比較重要的模塊,大致流程如下:

  1. 客戶通過小程序上報工單,說明什么設備出了什么問題
  2. 系統后台管理員查看下大致問題后審核    
  3. 后台管理員將已審核的工單分配給指定維修人員,或維修人員通過app自己領取已審核的工單
  4. 當維修人員到達客戶處,通過app將工單設置為已執行狀態
  5. 當維修人員處理完任務后通過app將工單設置為已完成狀態,同時可能需要錄入完成情況說明

以上是主體流程,還有些邊角的以后文章會詳細說明,比如:從審核狀態跳躍到已完成狀態;從已完成狀態回退到待審核狀態;狀態變化時的事件等。

工單類型不同:有些工單可能並不是客戶提交的,比如當采購的二手設備入庫時要做檢修,也會產生工單,這種情況工單不會與客戶關聯,而時與入庫單關聯;再比如讓某員工開車去托快遞回來這種情況工單會與物流信息關聯

工單創建方式不同:客戶通過小程序提交、后台管理員手動建立、當發生某些事件時自動創建(比如采購入庫時自動創建)

其實工單管理模塊是個通用的業務,在很多系統可能都需要,因此考慮做成獨立的業務模塊,方便復用。

目標

可復用

工單模塊以nuget包發布,你可以安裝后簡單配置后就可以使用。

易升級

上面說了,以nuget包形式發布的,將來模塊更新后發布新版本的nuget包,各系統更新下,引用新版本包就ok啦

獨立性

工單模塊只依賴些通用的、非業務型的模塊。工單模塊需要用到“員工”概念,在系統中往往體現為一個用戶,工單模塊本身不提供“員工管理”的功能,因為你的系統可能有自己的“員工管理”功能;或你直接拿abp原始的 AbpUser作為員工也行。試想如果“工單模塊”本身提供了員工管理模塊,你引用過去,發現自己系統中已有實現了的員工管理,是不是很麻煩?

所以你的項目引用工單模塊時需要做個適配,為工單模塊提供需要用到的員工相關功能,主要是幾個查詢。

說明:

abp vNext使用契約層來實現模塊獨立化,個人認為不完整,比如你的項目中有個”員工管理“模塊,你在定義契約接口和DTO時只能定義通用的,為了盡量通用,接口中的方法會盡量多,或分開多定義幾個接口,DTO中的屬性也會盡量多,因為你不知道將來哪各模塊引用你,所以你無法定義准確的、剛好夠用的接口和DTO。

現在有各”工資管理“模塊,引用你的”員工管理模塊“,它會拿到DTO中很多不必要的屬性,也會在引入接口時拿到很多不需要的方法。

再比如我的”工單模塊“如果直接引用你的契約,將來我發布工單模塊,其它系統引用后,它必須去實現”員工契約“中的接口,它會很迷茫,我要實現這個契約中所有的接口嗎?DTO所有的屬性我都需要賦值嗎?其實某些契約中的接口方法工單模塊可能根本不需要,同理契約中的DTO也不一定都需要賦值。

還有更多問題,這些問題不影響使用,但挺別扭。出現這樣的原因,是獨立的業務模塊應該在契約中定義自己能向外提供什么數據之外,還應該定義自己需要什么,而不是讓別的模塊的契約來指定

我們在開發工單模塊時,會從這兩個方向來定義契約,即:工單模塊需要什么數據?工單模塊能向外提供什么數據?

可擴展

abp本身提供了很強的擴展能力,你可以

  1. 通過“動態屬性系統”來擴展實體類
  2. 通過工單CRUD、工單狀態變化等事件來添加自己的業務邏輯
  3. 通過集成並替換工單模塊提供領域服務、應用服務來重寫現有業務邏輯
  4. 默認的UI只是結合我自己的項目用easyui實現的,你可以實現自己的UI
  5. 通過集成抽象工單實體、抽象工單的領域服務、抽象的工單應用服務來實現更多的工單類型

使用DDD開發方式

實踐下DDD

核心業務邏輯在工單實體類中,它定義了相應的業務方法,內部會改變工單實體自身的一些狀態,必要時觸發相應事件,以此來確保工單始終能處於正確的狀態,比如:某個已完成的工單無關聯的員工或沒有開始和完成時間;再比如某個已拒絕的工單,沒有拒絕說明。如果實體的屬性都是public get; set; 很容易出現這種問題,因為協作開發時別人很可能胡亂調用你的實體,隨意設置值。

領域服務有少量代碼,也觸發相應的領域事件。

應用服務來接收前端調用,協調領域實體和服務來實現業務邏輯。

關於DDD下篇詳細說明設計思路時再細說

集成

可擴展性中提到工單是抽象化的,但默認提供了一個”普通工單“的實現,因此安裝並配置模塊后此功能立即可用。另外也可用提供幾個子類實現一個自定義類型的工單。

線上demo:http://web1.cqyuzuji.com:9000/  賬號:admin 密碼:123qwe

先在abp官方下載一個干凈的abp項目,寫此文章時用的abp6.3 .net 5。或者你可用在你目前的項目引入並測試。按以下步驟進行配置。

安裝nuget包

相關nuget包都是以:BXJG.WorkOrder為前綴的。

先確保:

在解決方案上右鍵 > 管理解決方案的包 > 更新 -> Castle.Windsor.MsDependencyInjection 升級到3.4.0

在解決方案上右鍵 > 管理解決方案的包 > 更新 -> Microsoft.EntityFrameworkCore 更新到5.0.4

XXX.Core層中

Install-Package BXJG.WorkOrder.EFCore -Version 1.0.0-rc3

XXX.EntityFrameworkCore層中

Install-Package BXJG.WorkOrder.EFCore -Version 1.0.0-rc3

XXX.Application層中

Install-Package BXJG.WorkOrder.Application -Version 1.0.0-rc3
Install-Package BXJG.WorkOrder.EmployeeApplication -Version 1.0.0-rc3

工單模塊中,后台管理工單和員工端對工單的操作是分開兩個應用層項目定義的,根據你的情況決定是否分開,若分開則上面的包需要分開安裝。

配置

在DbContext中注冊相關實體

由於工單模塊沒有使用獨立DbContext的方式,因此需要在你的主程序的DbContext中注冊並配置”普通工單“和“工單分類”的實體。在XXX.EntityFrameworkCore層中找到你的DbContext,做如下配置:

1         public virtual DbSet<BXJG.WorkOrder.WorkOrderCategory.CategoryEntity> BXJGWorkOrderCategory { get; set; }
2         public virtual DbSet<BXJG.WorkOrder.WorkOrder.OrderEntity> BXJGWorkOrder { get; set; }
3 
4         protected override void OnModelCreating(ModelBuilder modelBuilder)
5         {
6             base.OnModelCreating(modelBuilder);
7             modelBuilder.ApplyConfigurationBXJGWorkOrder();//別忘了這里的映射配置 8         }

注冊權限和菜單

普通工單后台管理和員工端相關權限已定義為擴展方法,可以直接在主程序中調用,將其注冊到主程序的權限樹中。在XXX.Core/Authorization/XXXAuthorizationProvider中注冊【普通工單】和【工單分類】的權限,為了演示將權限注冊在了租戶權限下面。

admin.AddBXJGWorkOrderAllPermission();

同理在BXJG.Web.Mvc/Startup/XXXNavigationProvider中注冊【普通工單】和【工單分類】的菜單

context.Manager.MainMenu.AddBXJGWorkOrderAllNav();

默認情況會注冊 工單模塊的根、工單分類、默認工單的權限和菜單,可以調用另外幾個類似名稱的擴展方法來分別注冊需要的權限和菜單,你也完全可以按abp的方式完全自己定義權限和菜單的注冊,這種情況下,若你要使用默認工單的功能,權限的名稱必須對應,請參考默認工單權限常量名

注冊動態api

由於開發模塊時不確定你會如何使用工單模塊的應用層,因此默認並未自動注冊為動態web api,如果需要你可以自己配置,目前是手動,將來可能提供擴展方法一次性注冊。在XXX.Web.Core/XXXWebCoreModule的PreInitialize()中配置啟用工單模塊中普通工單和工單分類的相關動態web api

1 //注冊后台管理工單的動態api            
Configuration.Modules.AbpAspNetCore().CreateControllersForAppServices(typeof(BXJG.WorkOrder.ApplicationModule).Assembly,"bxjgworkorder");
2 //注冊后台和員工端管理工單的動態api
Configuration.Modules.AbpAspNetCore().CreateControllersForAppServices(typeof(BXJG.WorkOrder.BXJGCommonApplicationModule).Assembly, "bxjgworkorder");
3 //注冊員工端管理工單的動態api
Configuration.Modules.AbpAspNetCore().CreateControllersForAppServices(typeof(BXJG.WorkOrder.BXJGWorkOrderEmployeeApplicationModule).Assembly, "bxjgworkorder");

添加模塊依賴

雖然已添加了模塊相關包引用,但此時這些包對於主程序來說僅僅是普通的dll,必須按abp的方式,讓主程序的模塊依賴工單模塊,這樣工單模塊中的dll才會以Abp模塊方式啟動。由於工單模塊只提供到應用程序級別,因此在主程序的Application層中的Module類中添加依賴是最合適的。在XXX.Application/XXXApplicationModule中添加模塊依賴

    [DependsOn(略...
               typeof(BXJG.WorkOrder.ApplicationModule),              
typeof(BXJG.WorkOrder.BXJGWorkOrderEmployeeApplicationModule))] public class XXXApplicationModule : AbpModule {

添加模塊適配代碼

如前所述,工單模塊對員工的依賴是通過IEmployeeAppService接口隔離的,默認將AbpUser作為員工,但設計模塊時無法確定你的用戶類型,因此需要在你的主程序XXXApplicationModule.Initialize()按如下方式注冊服務

IocManager.RegisterBXJGWorkOrderDefaultAdapter<User>();//User為你項目的用戶類型

當然這個服務是可以替換的。

另外員工端對工單的管理服務中需要獲取當前登陸的員工,因此規定了IEmployeeSession接口,默認使用abp提供的IAbpSession,這個不需要做任何配置,當然你也可以替換這個服務

數據庫遷移

這個是按abp的套路,這不再詳述。注意abp默認下載來的項目連接字符串是連接到localhost的,而vs2019的localdb稍有不同,我是改成如下形式的,你看着辦

"Default": "Server=(localDB)\\mssqllocaldb; Database=BXJGDB; Trusted_Connection=True;"

運行

不出意外的話接口就可以訪問了

  

  • WorkOrder:后台管理員對工單進行管理的接口,其中ChangeStatus是將工單跳躍或回退到指定狀態,這個操作不是一步到位的,比如從”待審核“狀態 跳躍到 ”已完成“中間會經歷:確認、分配、執行、完成等步驟,操作員必須有這些步驟的權限,切工單狀態必須正確(打個比方,分配時會判斷工單是否已關聯的處理人,只是假設,目前沒做這個限制),這部分邏輯大多在工單實體中。
  • WorkOrderCategory:后台管理員對工單分類進行維護的接口
  • WorkOrderCommon:員工端或后台管理端都可以調用的接口,用來獲取工單狀態列表、緊急程度列表等
  • WorkOrderEmployee:員工端對工單進行操作的接口,獲取待分配的工單、執行、完成工單等。 

后續

  • 目前已實現真正的獨立的業務模塊
  • 配置還需要進一步簡化
  • 目前只是基本能跑通工單流程,未作詳細測試。
  • 上面說明了模塊的基本集成,以及模塊內默認實現的“普通工單”的功能,如何擴展后續會說明,比如:實現自定義類型的工單、如何通過繼承、事件等方式來擴展工單模塊等。
  • 目前模塊只提供到應用層級別,也就是只提供后端接口,前端我使用的easyui,雖然可以使用abp的虛擬文件系統來實現UI模塊化,但目前沒有這樣做,你可以使用自己喜歡的框架來完成UI


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM