Winform界面中实现菜单列表的动态个性化配置管理

在咱们通常的应用系统里面，因为系统是面向不一样类型的用户，咱们所看到的菜单会愈来愈多，多一点的甚至上百个，可是咱们实际工做接触的菜单可能就是那么几个，那么对于这种庞大的菜单体系，寻找起来很是不便。所以对菜单的个性化配置就显得尤其重要，本篇随笔就是基于这样的理念，提供用户对可见菜单进行一个动态配置，只选本身喜欢、经常使用的菜单显示出来便可，菜单的配置存储在数据库里面，在不一样的客户端体验都是同样。本篇随笔主要介绍实现这样的功能的一个完整思路，部分代码逻辑可供参考。

一、 菜单列表的动态个性化配置的过程

在咱们有些软件里面，咱们可能在界面上顶部放置菜单，也可能在界面的左侧放置树形列表菜单，这种状况都有可能，本篇摘取其中之一，左侧菜单进行一个介绍菜单的配置处理。

例如咱们在左侧根据用户权限展现相关的菜单信息，动态生成整个列表展现，大体的界面效果以下所示。

而后在功能列表上提供一个右键的菜单进行菜单的刷新、配置管理，以下界面所示。

经过配置功能，咱们让用户进入一个配置管理界面，在其中配置显示本身感兴趣的菜单，而后进行保存便可，保存后同时刷新界面的功能菜单显示。

以上几个界面效果就是为了介绍整个菜单配置管理的通常过程，之因此把界面效果放在前面介绍，就是可以让咱们有一个相似原型设计方式的感性认识，了解了相关的处理过程，咱们就能够着手经过编码的方式来实现这个处理逻辑了。

二、菜单动态个性化配置的功能实现

上面介绍了大概的界面效果，有了参考，咱们能够把它的实现思路经过代码实现出来。

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();
        }

这样界面配置参数并保存后，界面的树形菜单会及时获得更新处理。

另外，咱们主界面的树形列表，也要根据配置参数的信息做相关的调整，若是用户配置了不显示某个菜单，那么主界面也要根据配置参数控制显示。

 

三、总结

以上就是整个菜单列表的动态个性化配置管理的总体思路和实现步骤代码，主要的界面考量仍是以用户的视觉来考虑界面的布局和功能，若是在几百个菜单项中寻找几个经常使用的菜单，每次是一个比较耗时无聊的操做，所以提供一个个性化的界面，根据工做状况的不一样，显示一些和本身相关的功能便可。

例若有些状况下，咱们的菜单显示，但愿经过工具栏的方式进行控制显示，以下界面效果所示。

那么配置维护界面仍是差很少，只是咱们控制工具栏的显示逻辑有所不一样而已，对于RibbonPage及其功能菜单的动态生成处理以下所示。

本篇随笔主要仍是但愿读者借鉴配置存储和菜单个性化管理的思路，具体的逻辑会因用户界面的不一样，使用的控件不一样而有所差别，不过整体思路是一致的便可。

例若有些参数的配置管理，能够统一使用一个配置管理界面进行维护，如我以前的随笔介绍的界面功能同样。

 但愿本篇随笔对你有所启发，感谢耐心阅读。