asp.net abp模塊化開發之通用樹2：設計思路及源碼解析

1、前言

 

 

上一篇大概說了下abp通用樹形模塊如何使用，本篇主要分析下設計思路。

平常開發中會用到不少樹狀結構的數據，好比：產品的多級分類、省市區縣，大多數系統也會用到相似「通用字典/數據字典」的功能，爲系統各個地方提下拉框選擇的數據源。abp提供了一個模塊化系統，只要按它的約定就能夠實現一個通用的樹形數據的模塊，這樣公司的多個系統均可以使用，也能夠用相似nuget的方式提供給別人使用。

先列舉下它的功能

1. 經過nuget方便安裝和升級
2. 配置簡單
3. 默認已經提供「通用字典」功能
4. 實體、管理器、應用服務都是抽象類，結合泛型 狠容易擴展實現本身的樹形結構

 

 

 

 

2、必備知識

這不是abp入門級的文章，是探討系統模塊化開發的一種思路。因此要求對abp有經驗，完整看過abp文檔，對涉及到的模塊、依賴注入、啓動配置、權限、菜單、本地化等等概念有清晰的認識

 

3、包和源碼

源碼地址：https://github.com/bxjg1987/abpGeneralModules
nuget：Install-Package BXJG.GeneralTree -Version 1.0.2
在線地址：  http://test.cqsifang.com/    帳號密碼：admin  zlj.com    （別胡來，拜託...）
源碼倉庫中還有通用的文件模塊、附件模塊，後期會講講；nuget搜索bxjg能夠找到這幾個相關的包

 

4、整體設計

爲了便於說明，咱們以常見的產品無限級分類來講明，全部樹形結構數據有這麼幾個特色：

• 有個ParentId屬性指向父級節點，
• 有個code，數據格式相似：00001.00001，一個是能簡單體現產品分類節點的層級結構，二個是方便未來查詢某個分類及其後代分類下的全部產品 where categoryCode like '00001%
• 固然還有Name屬性

上面說了定義實體類的關鍵點，而後咱們須要提供一個對應的Manager（這個是abp定義領域服務的套路），來主負責CRUD和節點間的移動操做，其實最麻煩的就是自動處理code，新增和修改時要根據所屬父節點的code自動生成子節點的code，移動時就更復雜了，要從新計算當前節點及其兄弟節點及其全部後代節點的code，這還涉及到目標節點和源節點。爲了便於擴展，上面的領域服務還得將被處理的實體泛型話，文章後續會具體說明

最後按abp套路咱們還須要提一個應用服務，它核心操做就是調用上面提供的Manager作節點的crud操做，在此基礎上按abp的套路應該提供權限驗證、處理實體與dto之間的轉換。同理爲了便於未來模塊的使用方進行擴展，咱們應該應用抽象類和泛型的威力，文章後續會具體說明

最後咱們如何提供Repository呢？參考abp zero的思路，咱們將這個遺留到調用方來定義。在咱們的領域服務Manager和應用服務AppService中都是經過依賴注入注入的IRepository<TEntity,TKey>

核心的3個東東定義好後，咱們分別實現一個默認類，實現一個「通用字典」，未來調用方能夠繼承咱們的類並提供泛型參數來實現他們本身的樹形結構。
另外咱們將全部的代碼放在一個項目中，由於模塊足夠小，功能少  這樣調用方用起來更方便

注意一點，上面以產品分類來講明只是便於理解，既然要提供擴展能力，設計時只能從抽象的角度來看待樹形數據，不然設計出來的東西很容易最後發現不夠抽象，此廢話只可意會不可言傳

最後是abp相關的：本地化定義、模塊定義及依賴關係、權限提供器、菜單提供器、動態webapi的處理

5、實體類

實體類我這裏只是說明，具體源碼請訪問頂部的github

GeneralTreeEntity<TEntity>

它定義了樹形結構數據的通用樹形，Id、Code、Name、Parent等
泛型TEntity是子節點的類型，因爲是樹，實際上也是父節點的類型，這種設計是方便未來模塊使用方在實現自定義的樹形結構時拿到的Parent樹形和Children樹形，是他們本身定義的類型
主鍵Id屬性，我定死了long類型，其實也可使用泛型的TKey，思來想去簡單起見直接定死吧

public class GeneralTreeEntity : GeneralTreeEntity<GeneralTreeEntity>

爲了提供咱們默認實現的「通用字典」功能，咱們定義一個默認的子類GeneralTreeEntity，未來系統中那些簡單的數據能夠直接使用它
IsSysDefine表示此節點是不是系統預約義的，未來不容許刪除
IsTree是不是樹形，未來可能會用到，由於某些下拉框數據可能不須要多層次的，好比：民族，學歷

6、領域服務

按套路咱們提供一個抽象的領域服務Manager類，和一個爲了實現「通用字典」功能的默認實現

public abstract class GeneralTreeManager<TEntity> : DomainService  where TEntity : GeneralTreeEntity<TEntity>

它的主要職責整體設計也說了一嘴，完成crud和move移動操做，難點是處理code的自動生成，尤爲是移動節點時，節點原來位置以後的其它節點及其後代節點、目標節點以後的其它節點及其後代節點的code的生成
內部對數據的操做直接注入IRepository<TEntity, long>，所以按abp的套路，默認狀況下使用EF時，調用方只須要在他的DBContext中頂一個DBSet就能夠了

public class GeneralTreeManager : GeneralTreeManager<GeneralTreeEntity>

實現「通用數據字典」的默認領域服類，由於核心功能父類基本都完成了。因此幾乎沒代碼

7、應用服務

按套路一個抽象類，一個默認實現類，內部核心操做是上面提供的Manager來完成的，應用服務主要是出去權限和dto之間的轉換

public  class GeneralTreeAppServiceBase< TEntity,  TDto, TEditDto> : ApplicationService,     IGeneralTreeAppServiceBase<TDto, TEditDto>
        where TEntity : GeneralTreeEntity<TEntity>
        where TDto : GeneralTreeGetTreeNodeBaseDto<TDto>, new()
        where TEditDto : GeneralTreeNodeEditBaseDto

另外它提供了一些通用方法，一個樹形數據一般在3個地方唄使用，以產品分類爲例，在產品分類的管理頁面、在產品的搜索欄應該提供產品類別的選擇、在產品編輯頁面應該有個下拉框選擇當前產品所屬類別，其它樹形數據都有相似的場景，所以抽象的應用服務處理了這部分功能

public class GeneralTreeAppService : GeneralTreeAppServiceBase< GeneralTreeEntity, GeneralTreeDto, GeneralTreeEditDt, GeneralTreeManager>,IGeneralTreeAppService

按套路咱們爲「通用字典」提供了一個默認的實現類

 

應用服務中的DTO定義、應用服務接口我這裏省略了，這是abp的常規套路，請看源碼

8、abp相關套路：模塊、本地化、權限、菜單

模塊和本地化就不說了，abp的常規套路
因爲咱們提供了「通用字典」，默認狀況下是能夠直接用做你項目的，調用方徹底能夠按abp的套路在本身的模塊中來配置權限和菜單，可是默認咱們的模塊也提供了，調用方徹底能夠在主機的PermissionProvicer和NavigationProvider的合適的位置配置權限和菜單。參考GeneralTreeModuleConfig源碼

9、總結

abp自己提供了模塊化方式，若是運用得當咱們的系統能夠由不少小模塊組成，未來更容易維護、升級和複用就比如咱們目前提供的通用樹，若是你使用的是abp，那麼徹底能夠拿去就用，相似的「通用附件」模塊，由於咱們的多個系統或者同一個系統均可能會用到附件的功能，處處複製代碼是下下策。