在Winform開發框架中下拉列表綁定字典以及使用緩存提升界面顯示速度

在咱們開發Winform界面的時候，每每須要綁定數據字典操做，也就是綁定一些下拉列表或者一些列表顯示等，以便咱們方便選擇數據操做，常見的字典綁定操做就是對下拉列表的處理，本篇隨筆是基於DevExpress界面的一些處理操做，原理也適用於常規Winform界面或者DotNetBar控件界面處理。另外對於緩存的處理，通常在基於單機版數據或者局域網API接口處理的字典綁定，速度是比較快的，基本上能夠不用考慮緩存的處理，可是對於基於互聯網API接口的數據處理，每每受限於帶寬等緣由，請求數據的速度沒有那麼快，那麼須要作好數據緩存處理，纔可能更好的提升用戶體驗。

一、常規字典列表的綁定

對於普通的下拉列表控件，咱們綁定操做就是先獲取字典數據列表，而後對它的數據項進行添加操做便可，爲了方便，咱們每每作成一個擴展函數的方式來進行處理，並把這些通用的擴展函數放到界面基類庫裏面方便重用，這樣咱們能夠在設計到界面的數據綁定的時候，很是方便的調用了。

如相似下面的擴展函數定義。

        /// <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("隨訪狀態");
        }

這樣就很是簡化了咱們對字典數據源的綁定操做了，很是方便易讀，下面是其中一個功能界面的下拉列表展現。

 

二、使用緩存提升界面響應速度

 前面介紹了經過擴展函數來進一步擴展咱們綁定字典類別的方式了，以下擴展函數所示。

        /// <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界面代碼有所幫助和啓發。