欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

X-Admin&ABP框架开发-数据字典

程序员文章站 2022-12-05 15:06:46
在业务型的系统开发中,我们需要维护各种个样的类型,比如客户类型、客户行业、商品类型等等,这些类型往往信息量不多,并且相似度极高,如果采用一类型一表去设计,将会造成极大的工作量,通过将这部分类型的信息进行抽象,利用字段去存储类型区分,共用表结构,来达到兼容各种类型的功能,也就是设计一个数据字典,而对于 ......

  在业务型的系统开发中,我们需要维护各种个样的类型,比如客户类型、客户行业、商品类型等等,这些类型往往信息量不多,并且相似度极高,如果采用一类型一表去设计,将会造成极大的工作量,通过将这部分类型的信息进行抽象,利用字段去存储类型区分,共用表结构,来达到兼容各种类型的功能,也就是设计一个数据字典,而对于一个具体类型来讲,是有多个选项的,比如性别,有男女,行业有工农商等,对于这部分选项,可抽象为某个类型下的字典项,即数据字典项。

 

一、数据字典设计思路

  1、从客户类型、商品类型、行业类型来抽象考虑,首先三者都存在一个类型描述,即客户、商品、行业,同时,三者是本质是不同的,并且,随着业务上的需求越来越多,更多的xx类型将会加入,因此,单从类型考虑出发,就存在三个点了,如类型名称、类型独立、数量扩展,因此在考虑表结构设计时,就可以先考虑到这三点了,同时还有一个关键的信息,便是,在系统设计过程中,这些类型其实便已经确定完毕了,而不是说,在开发完毕,再去系统中增加类型。

   X-Admin&ABP框架开发-数据字典

   2、从具体的某个类型出发考虑,比如以商品类型为例,存在日用品、电子产品、化妆品等,同样是存在几个关键信息,比如类型项名称、类型项独立、类型项数量扩展,类型项的归属,而这部分信息,往往是由客户去维护的,属于系统开发完毕后期的信息维护,在此,不考虑类型项的先后顺序问题,如有需要可以扩展。

   X-Admin&ABP框架开发-数据字典

  按照这些信息点,可以对数据字典设计一些必要的字段,如类型名称即typename、 类型独立便是类型间相互独立,但是这里也存在一个类型间的上下父子问题,暂不加入进来,该父子问题使用场景较少,但又存在,如果按照“二八原则”的话,我还是喜欢把“八”的部分完成。对于数据字典项而言,按照给定的必要信息,设计成如下结构,其中的业务代码,是需要唯一的,比如对于性别来将,业务代码便是1或0,来代表男女,这部分可由客户的系统管理员进行维护。

  X-Admin&ABP框架开发-数据字典

 

二、完成数据字典设计

   在明确了这些基础信息后,开始在项目中完成设计过程,首先得明确数据字典本身的归属,数据字典是为整个业务而服务的,因此我把它划分到核心层这一级别中,首先在领域层设置core层文件夹,用来存放为整个业务提供基础设施的功能模块。

   X-Admin&ABP框架开发-数据字典

  1、在core层中加入数据字典模块,结构设计如:

  X-Admin&ABP框架开发-数据字典

  开始创建数据字典类,并添加设计的字段,以保证够用为前提,或许更多场景下会出现诸如父子字典情形,或是对字典内容的描述等,暂不考虑。

/// <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中,添加一个迁移并更新数据库。

  X-Admin&ABP框架开发-数据字典

  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类中可以定义需要用到的数据字典类型,此处并没有直接从那里增加后自动导入到数据库中。 

X-Admin&ABP框架开发-数据字典

 

 至此,数据字典的初步逻辑设计完毕,至于要加入更为丰富的功能,诸如排序,父子数据类型,或是数据类型描述,均可扩展。 

 代码地址:https://gitee.com/530521314/partner.surround.git

 

2019-07-07,望技术有成后能回来看见自己的脚步