abp加DDD開發：低耦合、可複用、可擴充套件的【工單】業務模組-簡介和整合

前言

很多場景【單體+模組化】比微服務更合適，開發難度低、程式碼可複用性強、可擴充套件性強。模組化開發有些難點，模組啟動與解除安裝、模組之間的依賴和通訊。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模組開發方式做的一些通用的，與具體業務無關的模組，比如：資料字典模組

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

業務場景

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

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-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，做如下配置：

        public virtual DbSet<BXJG.WorkOrder.WorkOrderCategory.CategoryEntity> BXJGWorkOrderCategory { get; set; }
        public virtual DbSet<BXJG.WorkOrder.WorkOrder.OrderEntity> BXJGWorkOrder { get; set; }

        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            base.OnModelCreating(modelBuilder);
            modelBuilder.ApplyConfigurationBXJGWorkOrder();//別忘了這裡的對映配置
        }

註冊許可權和選單

普通工單後臺管理和員工端相關許可權已定義為擴充套件方法，可以直接在主程式中呼叫，將其註冊到主程式的許可權樹中。在XXX.Core/Authorization/XXXAuthorizationProvider中註冊【普通工單】和【工單分類】的許可權，為了演示將許可權註冊在了租戶許可權下面。

//注意這裡的admin是指你已經存在的許可權節點
admin.AddBXJGWorkOrderPermission();
admin.AddBXJGEmployeeWorkOrderPermission();

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

context.Manager.MainMenu.AddBXJGWorkOrderNavigation();

註冊動態api

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

//註冊後臺管理工單的動態api            
Configuration.Modules.AbpAspNetCore().CreateControllersForAppServices(typeof(BXJG.WorkOrder.ApplicationModule).Assembly,"bxjgworkorder");
//註冊後臺和員工端管理工單的動態api               
Configuration.Modules.AbpAspNetCore().CreateControllersForAppServices(typeof(BXJG.WorkOrder.BXJGCommonApplicationModule).Assembly, "bxjgworkorder");
//註冊員工端管理工單的動態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資料夾，然後定義如程式碼

    public class EmployeeAppService : IEmployeeAppService
    {
        private readonly IRepository<User, long> userRepository;
        public IAsyncQueryableExecuter AsyncQueryableExecuter { get; set; } = NullAsyncQueryableExecuter.Instance;
        public EmployeeAppService(IRepository<User, long> userRepository)
        {
            this.userRepository = userRepository;
        }

        public async Task<IEnumerable<EmployeeDto>> GetByIdsAsync(params string[] ids)
        {
            var query = userRepository.GetAll()
                                      .Where(c => ids.Contains(c.Id.ToString()))
                                      .Select(c => new EmployeeDto
                                      {
                                          Id = c.Id.ToString(),
                                          Name = c.Name,
                                          Phone = c.PhoneNumber
                                      });
            return await AsyncQueryableExecuter.ToListAsync(query);
        }

        public async Task<IEnumerable<string>> GetIdsByKeywordAsync(string keyword)
        {
            var query = userRepository.GetAll()
                                      .WhereIf(!keyword.IsNullOrEmpty(), c => c.Name.Contains(keyword) || c.PhoneNumber.Contains(keyword))
                                      .Select(c => c.Id.ToString());
            return await AsyncQueryableExecuter.ToListAsync(query);
        }

        public async Task<IEnumerable<EmployeeDto>> GetAllAsync(string keyword)
        {
            var query = userRepository.GetAll()
                                      .WhereIf(!keyword.IsNullOrEmpty(), c => c.Name.Contains(keyword) || c.PhoneNumber.Contains(keyword))
                                      .Select(c => new EmployeeDto
                                      {
                                          Id = c.Id.ToString(),
                                          Name = c.Name,
                                          Phone = c.PhoneNumber
                                      });
            return await AsyncQueryableExecuter.ToListAsync(query);
        }
    }
    public class EmployeeSession : IEmployeeSession
    {
        private readonly IAbpSession abpSession;

        public EmployeeSession(IAbpSession abpSession)
        {
            this.abpSession = abpSession;
        }

        public string CurrentEmployeeId => abpSession.UserId?.ToString();
    }

當然還需要在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