前言
很多場景【單體+模塊化】比微服務更合適，開發難度低、代碼可復用性強、可擴展性強，模塊化開發有些難點，模塊啟動與卸載、模塊之間的依賴和通訊，asp.net core abp為我們提供了模塊化開發能力及其它基礎功能，基于abp（一代6.3）結合DDD已基本開發好一個【工單管理模塊】，本篇做個基本介紹并說明如何集成此模塊，后續會詳細說明思路，
資源
線上demo：http://web1.cqyuzuji.com:9000/ 賬號：admin 密碼：123qwe
后端原始碼：https://gitee.com/bxjg1987/abp
前端原始碼：https://gitee.com/bxjg1987/front
必備知識
熟悉asp.net core和abp（注意是老版本，非vNext，但也很容易遷移到vNext上）
術語
下文會提供到一些概念，理解這個黑重要，
abp模塊：這個不解釋了，是abp基礎，請參考官方檔案
通用模塊：這個是使用abp模塊開發方式做的一些通用的，與具體業務無關的模塊，比如：資料字典模塊
業務模塊：工單管理、廣告管理、電商模塊等為了實作具體業務的模塊，
業務場景
客戶是做復印機出租的，它希望做一套系統管理整個業務，其中工單是一個比較重要的模塊，大致流程如下：
- 客戶通過小程式上報工單，說明什么設備出了什么問題
- 系統后臺管理員查看下大致問題后審核
- 后臺管理員將已審核的工單分配給指定維修人員，或維修人員通過app自己領取已審核的工單
- 當維修人員到達客戶處，通過app將工單設定為已執行狀態
- 當維修人員處理完任務后通過app將工單設定為已完成狀態，同時可能需要錄入完成情況說明
以上是主體流程，還有些邊角的以后文章會詳細說明，比如：從審核狀態跳躍到已完成狀態；從已完成狀態回退到待審核狀態；狀態變化時的事件等，
工單型別不同：有些工單可能并不是客戶提交的，比如當采購的二手設備入庫時要做檢修，也會產生工單，這種情況工單不會與客戶關聯，而時與入庫單關聯；再比如讓某員工開車去托快遞回來這種情況工單會與物流資訊關聯
工單創建方式不同：客戶通過小程式提交、后臺管理員手動建立、當發生某些事件時自動創建（比如采購入庫時自動創建）
其實工單管理模塊是個通用的業務，在很多系統可能都需要，因此考慮做成獨立的業務模塊，方便復用，
目標
可復用
工單模塊以nuget包發布，你可以安裝后簡單配置后就可以使用，
易升級
上面說了，以nuget包形式發布的，將來模塊更新后發布新版本的nuget包，各系統更新下，參考新版本包就ok啦
獨立性
工單模塊只依賴些通用的、非業務型的模塊，工單模塊需要用到“員工”概念，在系統中往往體現為一個用戶，工單模塊本身不提供“員工管理”的功能，因為你的系統可能有自己的“員工管理”功能；或你直接拿abp原始的 AbpUser作為員工也行，試想如果“工單模塊”本身提供了員工管理模塊，你參考過去，發現自己系統中已有實作了的員工管理，是不是很麻煩？
所以你的專案參考工單模塊時需要做個適配，為工單模塊提供需要用到的員工相關功能，主要是幾個查詢，
說明：
abp vNext使用契約層來實作模塊獨立化，個人認為不完整，比如你的專案中有個”員工管理“模塊，你在定義契約介面和DTO時只能定義通用的，為了盡量通用，介面中的方法會盡量多，或分開多定義幾個介面，DTO中的屬性也會盡量多，因為你不知道將來哪各模塊參考你，所以你無法定義準確的、剛好夠用的介面和DTO，
現在有各”工資管理“模塊，參考你的”員工管理模塊“，它會拿到DTO中很多不必要的屬性，也會在引入介面時拿到很多不需要的方法，
再比如我的”工單模塊“如果直接參考你的契約，將來我發布工單模塊，其它系統參考后，它必須去實作”員工契約“中的介面，它會很迷茫，我要實作這個契約中所有的介面嗎？DTO所有的屬性我都需要賦值嗎？其實某些契約中的介面方法工單模塊可能根本不需要，同理契約中的DTO也不一定都需要賦值，
還有更多問題，這些問題不影響使用，但挺別扭，出現這樣的原因，是獨立的業務模塊應該在契約中定義自己能向外提供什么資料之外，還應該定義自己需要什么，而不是讓別的模塊的契約來指定，
我們在開發工單模塊時，會從這兩個方向來定義契約，即：工單模塊需要什么資料？工單模塊能向外提供什么資料？
可擴展
abp本身提供了很強的擴展能力，你可以
- 通過“動態屬性系統”來擴展物體類
- 通過工單CRUD、工單狀態變化等事件來添加自己的業務邏輯
- 通過集成并替換工單模塊提供領域服務、應用服務來重寫現有業務邏輯
- 默認的UI只是結合我自己的專案用easyui實作的，你可以實作自己的UI
- 通過集成抽象工單物體、抽象工單的領域服務、抽象的工單應用服務來實作更多的工單型別
使用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-rc
XXX.EntityFrameworkCore層中
Install-Package BXJG.WorkOrder.EFCore -Version 1.0.0-rc
XXX.Application層中
Install-Package BXJG.WorkOrder.Application -Version 1.0.0-rc
Install-Package BXJG.WorkOrder.EmployeeApplication -Version 1.0.0-rc
工單模塊中，后臺管理工單和員工端對工單的操作是分開兩個應用層專案定義的，根據你的情況決定是否分開，若分開則上面的包需要分開安裝，
配置
在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中注冊【普通工單】和【工單分類】的權限，為了演示將權限注冊在了租戶權限下面，
1 //注意這里的admin是指你已經存在的權限節點 2 admin.AddBXJGWorkOrderPermission(); 3 admin.AddBXJGEmployeeWorkOrderPermission();
同理在BXJG.Web.Mvc/Startup/XXXNavigationProvider中注冊【普通工單】和【工單分類】的選單
context.Manager.MainMenu.AddBXJGWorkOrderNavigation();
注冊動態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 {
添加模塊適配代碼
如前所述，工單模塊不提供員工管理功能，但依賴員工資訊，因此你需要提供一個適配，這也是完全獨立的工單模塊的關鍵，在XXXApplication中新增WorkOrder檔案夾，然后定義如代碼
1 public class EmployeeAppService : IEmployeeAppService 2 { 3 private readonly IRepository<User, long> userRepository; 4 public IAsyncQueryableExecuter AsyncQueryableExecuter { get; set; } = NullAsyncQueryableExecuter.Instance; 5 public EmployeeAppService(IRepository<User, long> userRepository) 6 { 7 this.userRepository = userRepository; 8 } 9 10 public async Task<IEnumerable<EmployeeDto>> GetByIdsAsync(params string[] ids) 11 { 12 var query = userRepository.GetAll() 13 .Where(c => ids.Contains(c.Id.ToString())) 14 .Select(c => new EmployeeDto 15 { 16 Id = c.Id.ToString(), 17 Name = c.Name, 18 Phone = c.PhoneNumber 19 }); 20 return await AsyncQueryableExecuter.ToListAsync(query); 21 } 22 23 public async Task<IEnumerable<string>> GetIdsByKeywordAsync(string keyword) 24 { 25 var query = userRepository.GetAll() 26 .WhereIf(!keyword.IsNullOrEmpty(), c => c.Name.Contains(keyword) || c.PhoneNumber.Contains(keyword)) 27 .Select(c => c.Id.ToString()); 28 return await AsyncQueryableExecuter.ToListAsync(query); 29 } 30 31 public async Task<IEnumerable<EmployeeDto>> GetAllAsync(string keyword) 32 { 33 var query = userRepository.GetAll() 34 .WhereIf(!keyword.IsNullOrEmpty(), c => c.Name.Contains(keyword) || c.PhoneNumber.Contains(keyword)) 35 .Select(c => new EmployeeDto 36 { 37 Id = c.Id.ToString(), 38 Name = c.Name, 39 Phone = c.PhoneNumber 40 }); 41 return await AsyncQueryableExecuter.ToListAsync(query); 42 } 43 } 44 public class EmployeeSession : IEmployeeSession 45 { 46 private readonly IAbpSession abpSession; 47 48 public EmployeeSession(IAbpSession abpSession) 49 { 50 this.abpSession = abpSession; 51 } 52 53 public string CurrentEmployeeId => abpSession.UserId?.ToString(); 54 }
當然還需要在XXXApplication中的Model檔案的Initialize()中配置依賴注入
IocManager.Register<IEmployeeAppService, WorkOrder.EmployeeAppService>(DependencyLifeStyle.Transient);
IocManager.Register<IEmployeeSession, EmployeeSession>(DependencyLifeStyle.Transient);
資料庫遷移
這個是按abp的套路，這不再詳述，注意abp默認下載來的專案連接字串是連接到localhost的，而vs2019的localdb稍有不同，我是改成如下形式的，你看著辦
"Default": "Server=(localDB)\\mssqllocaldb; Database=BXJGDB; Trusted_Connection=True;"
運行
不出意外的話介面就可以訪問了
- WorkOrder：后臺管理員對工單進行管理的介面，其中ChangeStatus是將工單跳躍或回退到指定狀態，這個操作不是一步到位的，比如從”待審核“狀態 跳躍到 ”已完成“中間會經歷：確認、分配、執行、完成等步驟，操作員必須有這些步驟的權限，切工單狀態必須正確（打個比方，分配時會判斷工單是否已關聯的處理人，只是假設，目前沒做這個限制），這部分邏輯大多在工單物體中，
- WorkOrderCategory：后臺管理員對工單分類進行維護的介面
- WorkOrderCommon：員工端或后臺管理端都可以呼叫的介面，用來獲取工單狀態串列、緊急程度串列等
- WorkOrderEmployee：員工端對工單進行操作的介面，獲取待分配的工單、執行、完成工單等，
后續
- 目前已實作真正的獨立的業務模塊
- 配置還需要進一步簡化
- 目前只是基本能跑通工單流程，未作詳細測驗，
- 上面說明了模塊的基本集成，以及模塊內默認實作的“普通工單”的功能，如何擴展后續會說明，比如：實作自定義型別的工單、如何通過繼承、事件等方式來擴展工單模塊等，
- 目前模塊只提供到應用層級別，也就是只提供后端介面，前端我使用的easyui，雖然可以使用abp的虛擬檔案系統來實作UI模塊化，但目前沒有這樣做，你可以使用自己喜歡的框架來完成UI
轉載請註明出處，本文鏈接：https://www.uj5u.com/net/271802.html
標籤：.NET技术