Winform界面中實現菜單列表的動態個性化配置管理

本文轉載自查看原文 2017-11-22 11:11 8148 WinForm界面開發/ Winform開發框架

在我們一般的應用系統里面，由於系統是面向不同類型的用戶，我們所看到的菜單會越來越多，多一點的甚至上百個，但是我們實際工作接觸的菜單可能就是那么幾個，那么對於這種龐大的菜單體系，尋找起來非常不便。因此對菜單的個性化配置就顯得尤為重要，本篇隨筆就是基於這樣的理念，提供用戶對可見菜單進行一個動態配置，只選自己喜歡、常用的菜單顯示出來即可，菜單的配置存儲在數據庫里面，在不同的客戶端體驗都是一樣。本篇隨筆主要介紹實現這樣的功能的一個完整思路，部分代碼邏輯可供參考。

1、菜單列表的動態個性化配置的過程

在我們有些軟件里面，我們可能在界面上頂部放置菜單，也可能在界面的左側放置樹形列表菜單，這種情況都有可能，本篇摘取其中之一，左側菜單進行一個介紹菜單的配置處理。

例如我們在左側根據用戶權限展示相關的菜單信息，動態生成整個列表展示，大致的界面效果如下所示。

然后在功能列表上提供一個右鍵的菜單進行菜單的刷新、配置管理，如下界面所示。

通過配置功能，我們讓用戶進入一個配置管理界面，在其中配置顯示自己感興趣的菜單，然后進行保存即可，保存后同時刷新界面的功能菜單顯示。

以上幾個界面效果就是為了介紹整個菜單配置管理的一般過程，之所以把界面效果放在前面介紹，就是能夠讓我們有一個類似原型設計方式的感性認識，了解了相關的處理過程，我們就可以着手通過編碼的方式來實現這個處理邏輯了。

2、菜單動態個性化配置的功能實現

上面介紹了大概的界面效果，有了參考，我們可以把它的實現思路通過代碼實現出來。

1）參數的數據存儲

首先我們需要了解，用戶配置可以通過XML保存在本地，也可以通過數據庫存儲保存在服務器，后者在分布式的客戶端的時候，可以處處一樣，這樣就不會造成體驗上的差異，因此我們這里采用存儲在數據庫的方案。

這個存儲我們沿用我之前介紹過的配置管理組件（SettingsProvider.net），我在隨筆《Winform開發框架之參數配置管理功能實現-基於SettingsProvider.net的構建》中對它的使用進行了詳細的介紹。

這個配置管理組件SettingsProvider.net使用起來也是比較方便的，可以選擇存儲在本地的對象，也可以選擇存儲在數據庫的存儲對象。

首先我們先定義一個存儲的參數類，這個是使用這個組件所必須的存儲對象信息，如下代碼所示。

    /// <summary>
    /// 用來控制人員管理顯示菜單的參數配置
    /// </summary>
    public class UserMenuParameter
    {
        [DefaultValue("")]
        [Description("用戶ID")]
        public string UserID { get; set; }
        
        
        [Description("用戶設置可見的菜單")]
        public Dictionary<string, bool> VisibleDict { get; set; }
    }

需要獲取或存儲這個對象信息的時候，我們初始化幾個管理類，如下代碼所示。

        //參數存儲所需的相關對象
        private SettingsProvider settings;
        private ISettingsStorage store;
        private UserMenuParameter parameter;

然后在配置管理界面窗體里面，初始化這幾個對象，如下代碼所示。

                // PortableStorage: 在運行程序目錄創建一個setting的文件記錄參數數據
                // DatabaseStorage：在數據庫TB_UserParameter表存儲用戶配置參數
                store = new DatabaseStorage(LoginUserInfo.ID);
                settings = new SettingsProvider(store);
                parameter = settings.GetSettings<UserMenuParameter>();

這樣我們就可以根據用戶的ID，獲取對應記錄的信息並轉換為相關的對象了，如果我們需要把修改的信息寫會到存儲介質里面，代碼如下所示。

            try
            {
                parameter = settings.GetSettings<UserMenuParameter>();
                parameter.VisibleDict = dict;
                parameter.UserID = LoginUserInfo.ID;
                settings.SaveSettings<UserMenuParameter>(parameter);

                ProcessDataSaved(sender, e);//觸發外部事件

                this.DialogResult = System.Windows.Forms.DialogResult.OK;
            }
            catch (Exception ex)
            {
                LogHelper.Error(ex);
                MessageDxUtil.ShowError(ex.Message);
                return;
            }

2）配置管理界面的實現

解決了參數的獲取及存儲功能后，我們需要編寫一個界面來管理用戶的菜單配置，也就是我們前面介紹的菜單配置管理界面。

我們這個界面的定義代碼如下所示。

其中參數的數據存儲就是應用了前面介紹的代碼，這里需要根據用戶的配置項初始化樹形菜單的顯示處理，通過InitTree的函數實現菜單的顯示。

在顯示菜單前，我們先介紹一下功能菜單顯示的規則，僅當參數存在對應記錄，並且該記錄顯式設置不可見，菜單才不可見，否則默認菜單是可以看到的。

這樣確保了，在參數沒有配置前，所有的菜單對當前用戶是可見的，只有用戶設置為不不可見，該菜單才不顯示為不可見。

        /// <summary>
        /// 獲取菜單是否可見。
        /// 僅當參數存在對應記錄，並且該記錄顯式設置不可見，菜單才不可見，否則默認菜單是可以看到的。
        /// </summary>
        /// <param name="id">菜單ID</param>
        /// <returns></returns>
        private bool GetVisibleMenu(string id)
        {
            bool result = true;
            if (parameter != null)
            {
                var dict = parameter.VisibleDict;
                if(dict != null && dict.ContainsKey(id))
                {
                    result = dict[id];
                }
            }
            return result;
        }

顯示菜單的相關處理邏輯，就是根據上面的判斷，然后確定是否勾選記錄，如下代碼所示。

存儲用戶勾選的記錄的時候，我們需要遍歷整個樹節點，判斷勾選了那些選項，然后把它保存數據庫即可。

        /// <summary>
        /// 遞歸獲取選中的樹節點集合
        /// </summary>
        /// <param name="node">樹節點</param>
        /// <param name="dict">字典集合</param>
        /// <returns></returns>
        private Dictionary<string, bool> GetTreeSelection(TreeNode node, Dictionary<string, bool> dict)
        {
            if (node.Tag != null)
            {
                var check = node.Checked;
                var menuId = string.Concat(node.Tag);
                if(!dict.ContainsKey(menuId))
                {
                    dict.Add(menuId, check);
                }
            }

            foreach (TreeNode child in node.Nodes)
            {
                GetTreeSelection(child, dict);
            }

            return dict;
        }

參數的保存操作如下所示。

        /// <summary>
        /// 保存用戶配置信息
        /// </summary>
        private void btnOK_Click(object sender, EventArgs e)
        {
            //獲取用戶勾選的樹列表，存放在字典集合里面
            var dict = new Dictionary<string, bool>();
            foreach(TreeNode node in this.treeView1.Nodes)
            {
                GetTreeSelection(node, dict);
            }

            try
            {
                //重新獲取參數信息，並設置新值后保存
                parameter = settings.GetSettings<UserMenuParameter>();
                parameter.VisibleDict = dict;
                parameter.UserID = LoginUserInfo.ID;
                settings.SaveSettings<UserMenuParameter>(parameter);

                ProcessDataSaved(sender, e);//觸發外部事件

                this.DialogResult = System.Windows.Forms.DialogResult.OK;
            }
            catch (Exception ex)
            {
                LogHelper.Error(ex);
                MessageDxUtil.ShowError(ex.Message);
                return;
            }
        }

3）主界面的相關處理

以上處理完成后，我們在主界面的工具欄右鍵菜單添加一個菜單項，用來進入配置界面的，如下邏輯代碼所示。

        private void tool_MenuSetting_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e)
        {
            MenuSetting();
        }
        /// <summary>
        /// 配置菜單項
        /// </summary>
        private void MenuSetting()
        {
            FrmMenuSetting dlg = new FrmMenuSetting();
            dlg.OnDataSaved += (s, arg) =>
            {
                //用戶保存參數后，提示用戶更新樹形列表
                InitToolbar();
            };
            dlg.ShowDialog();
        }