基於ABP框架實現數據字典開發

Posted on by

在業務型的系統開發中，我們需要維護各種個樣的類型，比如客戶類型、客戶行業、商品類型等等，這些類型往往信息量不多，並且相似度極高，如果采用一類型一表去設計，將會造成極大的工作量，通過將這部分類型的信息進行抽象，利用字段去存儲類型區分，共用表結構，來達到兼容各種類型的功能，也就是設計一個數據字典，而對於一個具體類型來講，是有多個選項的，比如性別，有男女，行業有工農商等，對於這部分選項，可抽象為某個類型下的字典項，即數據字典項。

一、數據字典設計思路

1、從客戶類型、商品類型、行業類型來抽象考慮，首先三者都存在一個類型描述，即客戶、商品、行業，同時，三者是本質是不同的，並且，隨著業務上的需求越來越多，更多的xx類型將會加入，因此，單從類型考慮出發，就存在三個點瞭，如類型名稱、類型獨立、數量擴展，因此在考慮表結構設計時，就可以先考慮到這三點瞭，同時還有一個關鍵的信息，便是，在系統設計過程中，這些類型其實便已經確定完畢瞭，而不是說，在開發完畢，再去系統中增加類型。

2、從具體的某個類型出發考慮，比如以商品類型為例，存在日用品、電子產品、化妝品等，同樣是存在幾個關鍵信息，比如類型項名稱、類型項獨立、類型項數量擴展，類型項的歸屬，而這部分信息，往往是由客戶去維護的，屬於系統開發完畢後期的信息維護，在此，不考慮類型項的先後順序問題，如有需要可以擴展。

按照這些信息點，可以對數據字典設計一些必要的字段，如類型名稱即TypeName、類型獨立便是類型間相互獨立，但是這裡也存在一個類型間的上下父子問題，暫不加入進來，該父子問題使用場景較少，但又存在，如果按照“二八原則”的話，我還是喜歡把“八”的部分完成。對於數據字典項而言，按照給定的必要信息，設計成如下結構，其中的業務代碼，是需要唯一的，比如對於性別來將，業務代碼便是1或0，來代表男女，這部分可由客戶的系統管理員進行維護。

二、完成數據字典設計

在明確瞭這些基礎信息後，開始在項目中完成設計過程，首先得明確數據字典本身的歸屬，數據字典是為整個業務而服務的，因此我把它劃分到核心層這一級別中，首先在領域層設置Core層文件夾，用來存放為整個業務提供基礎設施的功能模塊。

1、在Core層中加入數據字典模塊，結構設計如：

開始創建數據字典類，並添加設計的字段，以保證夠用為前提，或許更多場景下會出現諸如父子字典情形，或是對字典內容的描述等，暫不考慮。

/// <summary>
/// 核心_數據字典
/// </summary>
[Table("Core_DataDictionary")]
public class DataDictionary : Entity<long>
{
    public const int MaxNameLength = 30;

    /// <summary>
    /// 字典類型
    /// </summary>
    [StringLength(MaxNameLength)]
    public string TypeName { get; set; }

    /// <summary>
    /// 關聯數據字典項
    /// </summary>
    public virtual ICollection<DataDictionaryItem> DataDictionaryItem { get; set; }
}

在增加數據字典項類，並添加設計時的字段信息，這裡我通過數據註解完成對字段的一些約束，如長度約束，表名的映射等。

/// <summary>
/// 核心_數據字典項
/// </summary>
[Table("Core_DataDictionaryItem")]
public class DataDictionaryItem : Entity<long>
{
    public const int MaxCodeLength = 5;
    public const int MaxNameLength = 30;

    /// <summary>
    /// 業務代碼
    /// </summary>
    [StringLength(MaxCodeLength)]
    public string Code { get; set; }

    /// <summary>
    /// 類型項名稱
    /// </summary>
    [StringLength(MaxNameLength)]
    public string Name { get; set; }

    /// <summary>
    /// 數據字典Id
    /// </summary>
    public long DataDictionaryId { get; set; }

    /// <summary>
    /// 關聯數據字典項
    /// </summary>
    public virtual DataDictionary DataDictionary { get; set; }
}

加入到DbContext中，添加一個遷移並更新數據庫。

2、開始完成應用層的封裝工作，在應用層定義瞭幾個常用的對字典的一些操作，諸如添加刪除修改等常見操作，此處的數據字典暫時通過手動加入，而不是將已有數據字典或是更改瞭的數據字典自動更新到數據庫中。

/// <summary>
/// 獲取數據字典集合
/// </summary>
/// <returns></returns>
Task<ListResultDto<DataDictionaryListDto>> GetAllDataDictionaryListAsync();

/// <summary>
/// 獲取數據字典記錄
/// </summary>
/// <param name="input"></param>
/// <returns></returns>
Task<DataDictionaryEditDto> GetDataDictionaryForEditAsync(NullableIdDto<long> input);

/// <summary>
/// 添加或更新數據字典記錄
/// </summary>
/// <param name="input"></param>
/// <returns></returns>
Task CreateOrUpdateDataDictionaryAsync(CreateOrUpdateDataDictionaryInput input);

/// <summary>
/// 刪除數據字典記錄
/// </summary>
/// <param name="ids"></param>
/// <returns></returns>
Task DeleteDataDictionaryAsync(List<EntityDto<long>> inputs);

/// <summary>
/// 根據字典類型名稱獲取數據字典集合
/// </summary>
/// <param name="input"></param>
/// <returns></returns>
Task<ListResultDto<DataDictionaryListDto>> GetDataDictionaryListByTypeNamesAsync(GetDataDictionaryListByTypeNamesInput input);

對數據字典項也準備瞭幾個方法，用於對某一具體數據字典類型增加刪除修改數據字典項。

/// <summary>
/// 獲取數據字典項
/// </summary>
/// <param name="input"></param>
/// <returns></returns>
Task<DataDictionaryItemEditDto> GetDataDictionaryItemForEditAsync(NullableIdDto<long> input);

/// <summary>
/// 添加或更新數據字典項
/// </summary>
/// <param name="input"></param>
/// <returns></returns>
Task CreateOrUpdateDataDictionaryItemAsync(CreateOrUpdateDataDictionaryItemInput input);

/// <summary>
/// 刪除數據字典項
/// </summary>
/// <param name="ids"></param>
/// <returns></returns>
Task DeleteDataDictionaryItemAsync(List<EntityDto<long>> inputs);

/// <summary>
/// 根據字典類型和字典項名稱獲取字典項值
/// </summary>
/// <param name="input"></param>
/// <returns></returns>
Task<GetDataDictionaryItemNameOutput> GetDataDictionaryItemNameAsync(GetDataDictionaryItemNameInput input);

/// <summary>
/// 獲取數據字典列表
/// </summary>
/// <param name="input"></param>
/// <returns></returns>
Task<ListResultDto<DataDictionaryItemListDto>> GetDataDictionaryItemListAsync(GetDataDictionaryItemListInput input);

在應用層建立一個全局常量數據字典類，用於存儲數據字典信息，該部分信息也將成為需要維護到系統中的必備信息，並且，在系統中如有地方需要調用到數據字典類型時，不需要寫死代碼。

/// <summary>
/// 數據字典類型存儲表
/// </summary>
public class DataDictionaryTypeConsts
{
    #region 分瓶規則
    public const string GroupRule_FixAtive = "固定劑及使用";

    public const string GroupRule_ContainerType = "容器類型";
    #endregion
}

3、完成控制器層調用及頁面中對數據字典的管理，對於字典信息而言，足夠在界面中一覽全貌，因此頁面設計時，直接以樹形結構加表格展示即可，左側數據類型樹形結構，右側相應的數據類型項表格。

<div class="layui-row">
    <div class="layui-col-md2 layui-col-xs12">
        <ul id="tree" class="ztree" style="padding: 0px; border: 1px solid #ddd; overflow: auto;"></ul>
    </div>
    <div class="layui-col-md10 layui-col-xs12">
        <table class="layui-table"
                lay-data="{height: 'full-180', page:true, id:'mainList'}"
                lay-filter="list" lay-size="xs">
            <thead>
                <tr>
                    <th lay-data="{checkbox:true, fixed: true}"></th>
                    <th lay-data="{field:'code', sort: true}">業務代碼</th>
                    <th lay-data="{field:'name'}">名稱</th>
                    @if (await PermissionChecker.IsGrantedAsync(PermissionNames.Pages_Core_DataDictionaryItem_Edit) ||
                await PermissionChecker.IsGrantedAsync(PermissionNames.Pages_Core_DataDictionaryItem_Delete))
                    {
                        <th lay-data="{fixed:'right', align:'center', toolbar: '#barList'}"></th>
                    }
                </tr>
            </thead>
        </table>
    </div>
</div>

三、數據字典頁面展示

利用layui節省瞭不少時間，對於前端東西不太精通，隻能夠用，勉強實現瞭數據字典的一些操作，其中的數據字典類型是按照開發過程中可能用到的進行加入的，合理的存在，而不是空穴來風，在之前的DataDictionaryConst類中可以定義需要用到的數據字典類型，此處並沒有直接從那裡增加後自動導入到數據庫中。

至此，數據字典的初步邏輯設計完畢，至於要加入更為豐富的功能，諸如排序，父子數據類型，或是數據類型描述，均可擴展。

代碼地址：https://gitee.com/530521314/Partner.Surround.git

到此這篇關於基於ABP框架實現數據字典開發的文章就介紹到這瞭。希望對大傢的學習有所幫助，也希望大傢多多支持WalkonNet。

推薦閱讀：