在Winform开发框架中下拉列表绑定字典以及使用缓存提高界面显示速度

在我们开发winform界面的时候，往往需要绑定数据字典操作，也就是绑定一些下拉列表或者一些列表显示等，以便我们方便选择数据操作，常见的字典绑定操作就是对下拉列表的处理，本篇随笔是基于devexpress界面的一些处理操作，原理也适用于常规winform界面或者dotnetbar控件界面处理。另外对于缓存的处理，一般在基于单机版数据或者局域网api接口处理的字典绑定，速度是比较快的，基本上可以不用考虑缓存的处理，但是对于基于互联网api接口的数据处理，往往受限于带宽等原因，请求数据的速度没有那么快，那么需要做好数据缓存处理，才可能更好的提高用户体验。

1、常规字典列表的绑定

对于普通的下拉列表控件，我们绑定操作就是先获取字典数据列表，然后对它的数据项进行添加操作即可，为了方便，我们往往做成一个扩展函数的方式来进行处理，并把这些通用的扩展函数放到界面基类库里面方便重用，这样我们可以在设计到界面的数据绑定的时候，非常方便的调用了。

如类似下面的扩展函数定义。

        /// <summary>
        /// 绑定下拉列表控件为指定的数据字典列表
        /// </summary>
        /// <param name="combo">下拉列表控件</param>
        /// <param name="itemlist">数据字典列表</param>
        /// <param name="defaultvalue">控件默认值</param>
        /// <param name="emptyflag">是否加入空值选项</param>
        public static void binddictitems(this comboboxedit combo, list<string> itemlist, string defaultvalue, bool emptyflag = true)
        {
            combo.properties.beginupdate();//可以加快
            combo.properties.items.clear();
            combo.properties.items.addrange(itemlist);
            if (emptyflag)
            {
                combo.properties.items.insert(0, "");
            }

            if (itemlist.count > 0)
            {
                combo.setdropdownvalue(defaultvalue);
            }

            combo.properties.endupdate();//可以加快
        }

还有有时候我们需要一个显示文本、值的键值对来对字典进行处理，如定义的clistitem对象

    /// <summary>
    /// 框架用来记录字典键值的类，用于comobox等控件对象的值传递
    /// </summary>
    [serializable]
    public class clistitem
    {
        /// <summary>
        /// 显示内容
        /// </summary>
        public string text { get; set; }

        /// <summary>
        /// 实际值内容
        /// </summary>
        public string value { get; set; }
    }

这样我们绑定列表的扩展函数在定义一个函数，如下所示。

        /// <summary>
        /// 绑定下拉列表控件为指定的数据字典列表
        /// </summary>
        /// <param name="combo">下拉列表控件</param>
        /// <param name="itemlist">数据字典列表</param>
        /// <param name="defaultvalue">控件默认值</param>
        /// <param name="emptyflag">是否加入空值选项</param>
        public static void binddictitems(this comboboxedit combo, list<clistitem> itemlist, string defaultvalue, bool emptyflag = true)
        {
            combo.properties.beginupdate();//可以加快
            combo.properties.items.clear();
            combo.properties.items.addrange(itemlist);
            if (emptyflag)
            {
                combo.properties.items.insert(0, new clistitem(""));
            }

            if (itemlist.count > 0)
            {
                if (!string.isnullorempty(defaultvalue))
                {
                    combo.setcomboboxitem(defaultvalue);
                }
                else
                {
                    combo.selectedindex = 0;
                }
            }

            combo.properties.endupdate();//可以加快
        }

当然，除了上面的这两个处理，我们还可以定义很多不同类型的重载方法，以便更方便处理相关的控件的字典数据绑定。

对于固定数据源list<string>、或者list<clistitem>来说，我们绑定的操作就非常简单。

list<clistitem> itemlist= new list<clistitem>() { new clistitem("有"), new clistitem("无") };
txtitem.binddictitems(itemlist);

然后获取对应字典值的方式，我们可以定义一个扩展函数来处理，如下代码所示。

        /// <summary>
        /// 获取下拉列表的值
        /// </summary>
        /// <param name="combo">下拉列表</param>
        /// <returns></returns>
        public static string getcomboboxvalue(this comboboxedit combo)
        {
            clistitem item = combo.selecteditem as clistitem;
            if (item != null)
            {
                return item.value;
            }
            else
            {
                return "";
            }
        }

对于以上的操作，我们这里还没有涉及到字典模块里面的数据源，只是提供一些常规的固定列表，我们知道，大多数的数据字典我们是通过字典模块来进行维护的。

因此我们也需要动态的从字典库上获取对应的字典集合来进行绑定。字典的数据，我们可以通过字典类型或者字典代码来获取，如下是通过字典类型获取对应的字典列表代码。

bllfactory<dictdata>.instance.getdictbydicttype(dicttypename);

有了这些数据的获取方法，我们就可以通过扩展函数来进一步扩展我们绑定字典类别的方式了，如下扩展函数所示。

        /// <summary>
        /// 绑定下拉列表控件为指定的数据字典列表
        /// </summary>
        /// <param name="combo">下拉列表控件</param>
        /// <param name="dicttypename">数据字典类型名称</param>
        /// <param name="defaultvalue">控件默认值</param>
        public static void binddictitems(this comboboxedit combo, string dicttypename, string defaultvalue)
        {            
            dictionary<string, string> dict = bllfactory<dictdata>.instance.getdictbydicttype(dicttypename);
            list<clistitem> itemlist = new list<clistitem>();
            foreach (string key in dict.keys)
            {
                itemlist.add(new clistitem(key, dict[key]));
            }

            binddictitems(combo, itemlist, defaultvalue);            
        }

使用的时候，就非常简单了，如下代码是实际项目中对字典列表绑定的操作，字典数据在字典模块里面统一定义的。

        /// <summary>
        /// 初始化数据字典
        /// </summary>
        private void initdictitem()
        {
            txtindiagnosis.binddictitems("入院诊断");
            txtleavediagnosis.binddictitems("最后诊断");

            //初始化代码
            this.txtfollowtype.binddictitems("随访方式");
            this.txtfollowstatus.binddictitems("随访状态");
        }

这样就非常简化了我们对字典数据源的绑定操作了，非常方便易读，下面是其中一个功能界面的下拉列表展示。

 

2、使用缓存提高界面响应速度

 前面介绍了通过扩展函数来进一步扩展我们绑定字典类别的方式了，如下扩展函数所示。

        /// <summary>
        /// 绑定下拉列表控件为指定的数据字典列表
        /// </summary>
        /// <param name="combo">下拉列表控件</param>
        /// <param name="dicttypename">数据字典类型名称</param>
        /// <param name="defaultvalue">控件默认值</param>
        public static void binddictitems(this comboboxedit combo, string dicttypename, string defaultvalue)
        {            
            dictionary<string, string> dict = bllfactory<dictdata>.instance.getdictbydicttype(dicttypename);
            list<clistitem> itemlist = new list<clistitem>();
            foreach (string key in dict.keys)
            {
                itemlist.add(new clistitem(key, dict[key]));
            }

            binddictitems(combo, itemlist, defaultvalue);            
        }
 

如果是基于服务接口的方式（通过web api或者wcf方式）获取字典列表，那么bllfactory<t>的方式就修改为callerfactory<t>的方式获取数据了，如下扩展函数所示。

        /// <summary>
        /// 绑定下拉列表控件为指定的数据字典列表
        /// </summary>
        /// <param name="control">下拉列表控件</param>
        /// <param name="dicttypename">数据字典类型名称</param>
        /// <param name="defaultvalue">控件默认值</param>
        /// <param name="emptyflag">是否添加空行</param>
        public static void binddictitems(this comboboxedit control, string dicttypename, string defaultvalue, bool emptyflag = true)
        {
            dictionary<string, string> dict = callerfactory<idictdataservice>.instance.getdictbydicttype(dicttypename);
            list<clistitem> itemlist = new list<clistitem>();
            foreach (string key in dict.keys)
            {
                itemlist.add(new clistitem(key, dict[key]));
            }

            control.binddictitems(itemlist, defaultvalue, emptyflag);
        }

也就是通过服务接口工厂方法调用

callerfactory<idictdataservice>.instance.getdictbydicttype(dicttypename);

而获取数据字典列表的内容，这个可以配置为web api访问方式、wcf访问方式，底层就是调用客户端封装的代理方法获取就是了。例如对于web api调用来说就是通过客户端直接访问web api服务接口获取数据的，实现代码如下所示。

        /// <summary>
        /// 根据字典类型名称获取所有该类型的字典列表集合(key为名称，value为值）
        /// </summary>
        /// <param name="dicttypename">字典类型名称</param>
        /// <returns></returns>
        public dictionary<string, string> getdictbydicttype(string dicttypename)
        {
            var action = system.reflection.methodbase.getcurrentmethod().name;
            string url = gettokenurl(action) + string.format("&dicttypename={0}", dicttypename.urlencode());

            dictionary<string, string> result = jsonhelper<dictionary<string, string>>.convertjson(url);
            return result;
        }

由于字典数据是相对比较固定的，一般时效不是那么及时都没问题，由于这部分数据是通过网络的方式获取的，反复的调用获取是会耗费一定的时间。

为了提高用户响应速度，我们可以把它放到客户端的缓存里面（非服务器缓存），设置一定的失效时间，在失效时间内，我们数据不再反复的从网络接口获取，而是直接通过缓存里面提取，速度非常快，同时也提高了界面响应速度。

但是为了不影响已有代码，我们可以继续在扩展函数的实现上做一些扩展即可，首先我们定义一个公共的获取字典数据的方法，如下所示。

        /// <summary>
        /// 获取字典类型的通用处理
        /// </summary>
        /// <param name="dicttypename">字典类型</param>
        /// <param name="iscache">是否缓存，默认为true</param>
        /// <returns></returns>
        private static dictionary<string, string> getdictbydicttype(string dicttypename, bool iscache = true)
        {
            dictionary<string, string> dict = null;
            if (iscache)
            {
                system.reflection.methodbase method = system.reflection.methodbase.getcurrentmethod();
                string key = string.format("{0}-{1}-{2}", method.declaringtype.fullname, method.name, dicttypename);

                dict = memorycachehelper.getcacheitem<dictionary<string, string>>(key,
                    delegate () {
                        return callerfactory<idictdataservice>.instance.getdictbydicttype(dicttypename);
                    },
                    new timespan(0, 30, 0));//30分钟过期
            }
            else
            {
                dict = callerfactory<idictdataservice>.instance.getdictbydicttype(dicttypename);
            }
            return dict;
        }

通过使用 memorycachehelper.getcacheitem<dictionary<string, string>> 的方式，我们可以把它设置为缓存处理方式，如果在失效时间内，则从缓存里面提取。

这样原来的绑定下拉列表的扩展方法获取字典数据，从这个公共的接口里面获取即可，而我们也仅仅是增加一个具有默认值的缓存与否的参数，用来决定是否使用缓存模式，默认为使用缓存处理。

        /// <summary>
        /// 绑定下拉列表控件为指定的数据字典列表
        /// </summary>
        /// <param name="control">下拉列表控件</param>
        /// <param name="dicttypename">数据字典类型名称</param>
        /// <param name="defaultvalue">控件默认值</param>
        /// <param name="emptyflag">是否添加空行</param>
        public static void binddictitems(this comboboxedit control, string dicttypename, string defaultvalue, bool iscache = true, bool emptyflag = true)
        {
            var dict = getdictbydicttype(dicttypename, iscache);

            list<clistitem> itemlist = new list<clistitem>();
            foreach (string key in dict.keys)
            {
                itemlist.add(new clistitem(key, dict[key]));
            }

            control.binddictitems(itemlist, defaultvalue, emptyflag);
        }

这样原来的数据下拉列表绑定的方式没有变化，依旧是我们原来的代码，但是默认采用缓存方式来绑定基于网络接口（混合框架模式）获取的字典数据。

        /// <summary>
        /// 初始化数据字典
        /// </summary>
        private void initdictitem()
        {
            //初始化代码
            this.txtsurgerytype.binddictitems("手术方式");
            this.txtisfirsttime.binddictitems("首发");
            this.txtwhograde.binddictitems("病理who分级");
            this.txtlesionpart.binddictitems("病灶部位");

            this.txtoccupation.binddictitems("病人职业");
            this.txtrelapse.binddictitems("复发");
            this.txtpathologygrade.binddictitems("病理分级");
            this.txtsymptom.binddictitems("初发症状");
            this.txtanesthesiamethod.binddictitems("麻醉方法");
            this.txtspecimendetail.binddictitems("具体标本情况");
        }

得到的编辑界面如下所示，使用缓存接口，对于大量字典数据显示的界面，界面显示速度有了不错的提升。

而对于一些特殊列表的字典显示，如需要通过拼音首字母进行检索功能的下拉列表，我们依旧可以使用这种绑定的方式实现缓存处理的。

如字典绑定的扩展函数如下所示，这样就统一了整个字典列表的绑定操作，比较容易记住。

        /// <summary>
        /// 绑定下拉列表控件为指定的数据字典列表
        /// </summary>
        /// <param name="combo">下拉列表控件</param>
        /// <param name="dicttypename">数据字典类型名称</param>
        /// <param name="defaultvalue">控件默认值</param>
        public static void binddictitems(this customgridlookupedit combo, string dicttypename, string defaultvalue, bool iscache = true)
        {
            string displayname = dicttypename;
            const string valuename = "值内容";
            const string pinyin = "拼音码";
            var dt = datatablehelper.createtable(string.format("{0},{1},{2}", displayname, valuename, pinyin));

            var dict = getdictbydicttype(dicttypename, iscache);
            foreach (string key in dict.keys)
            {
                var row = dt.newrow();
                row[displayname] = key;
                row[valuename] = dict[key];
                row[pinyin] = pinyin.getfirstpy(key);
                dt.rows.add(row);
            }

            combo.properties.valuemember = valuename;
            combo.properties.displaymember = displayname;
            combo.properties.datasource = dt;
            combo.properties.populateviewcolumns();
            combo.properties.view.columns[valuename].visible = false;
            combo.properties.view.columns[displayname].width = 400;
            combo.properties.view.columns[pinyin].width = 200;
            combo.properties.popupformminsize = new system.drawing.size(600, 0);

            if (!string.isnullorempty(defaultvalue))
            {
                combo.editvalue = defaultvalue;
            }
        }

界面效果如下所示。

以上就是常规单机版数据绑定操作，以及基于网络版缓存数据的数据字典绑定操作，我们在界面代码的处理上没有任何差异，只是辅助扩展函数做一些调整就可以很好的变化过来了，这样对于我们界面代码的重用或者调整是非常便利的，同时缓存的使用，对于网络性能有所差异的地方，速度也会明细的有所提高。以上就是对于字典模块的一些处理上的分享，希望对大家开发winform界面代码有所帮助和启发。