在Winform界面菜单中实现动态增加【最近使用的文件】菜单项

在我们一些和文件处理打交道的系统中,我们往往需要记录下最近使用的文件,这样方便用户快速打开之前浏览或者编辑过的文件,这种在很多软件上很常见,本文主要介绍在Winform界面菜单中实现【最近使用的文件】动态菜单的处理,实现一个较为常用的功能。

在我们一些和文件处理打交道的系统中,我们往往需要记录下最近使用的文件,这样方便用户快速打开之前浏览或者编辑过的文件,这种在很多软件上很常见,本文主要介绍在Winform界面菜单中实现【最近使用的文件】动态菜单的处理,实现一个较为常用的功能。

在我上篇随笔《文字处理控件TX Text Control的使用》介绍的内容中,我针对性的对这个控件的使用做了一个全面的了解,发现其中案例代码总这部分的功能实现【最近使用的文件】挺好,于是把它进行了整理,把整个思路作为一篇随笔进行记录,希望对大家有所帮助。

1、菜单动态加入【最近使用的文件】的介绍

这个功能我们在很多程序上有见过,如在Visual  Studio里面,我们可以看到这个列表的动态处理。

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发

以及在Word工具栏里面,一样有这样的实现

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_02

这个功能主要的处理逻辑就是,我们在打开文件、保存文件、或者另存为其他文件的时候,把对应的文件路径进行记录存储,当我们打开这个菜单的时候,把它们进行加载动态生成相关的菜单即可,一旦我们选择其中一个文件,我们就把它们加载到主界面进行展示或者编辑即可。

 

2、菜单动态加入【最近使用的文件】的实现

1)设计处理过程

首先我们需要在界面里面添加一个 菜单的占位符,方便我们以此为基准,加入对应的动态菜单,如下设计界面所示

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_03

剩下的就是代码的处理了,我们刚才提到,我们需要记录文件打开,保存、另存为的几个操作的文件,然后存储起来使用,也就是存储一个文件路径和文件标题列表了。

这个存储我们可以通过系统配置文件的常规处理实现,先在程序项目解决方案里面找到对应的Settigns.settings文件,打开后进行添加记录对象处理,如下所示。

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_04

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_05

有了这些,那么我们的信息存储就实现了第一步了,需要的就是把它们通过代码进行管理起来。

 

2)代码实现处理过程

有了上面的设计处理过程,我们有了一个固定的菜单可以使用,有了一个配置对象以及对应的属性可以存储和加载处理,那么剩下的就是通过代码把它们之间的关系联系起来,实现动态文件列表的菜单处理即可。

我们定义一个类,并添加对应的文件数量大小和文件列表的属性,用来记录和配置文件定义的属性内容,以及存储对应的菜单项对象,如下所示。

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_06

其中我们需要在文件打开,保存、另存的时候,做一个文件列表的记录处理,因此需要增加一个函数,用来把最近的文件追加到列表的顶端(最近文件列表),以及裁剪多于指定数量的记录,具体操作如下所示。

/// <summary>
/// 添加新文件路径到顶部列表(在打开、保存、另存为操作中)
/// </summary>
public void AddRecentFile(string filePath)
{
    _fileList.Insert(0, filePath);

    //从最后位置开始倒着找,如果找到一致名称,则移除旧记录
    for (int i = _fileList.Count - 1; i > 0; i--)
    {
        for (int j = 0; j < i; j++)
        {
            if (_fileList[i] == _fileList[j])
            {
                _fileList.RemoveAt(i);
                break;
            }
        }
    }

    //最后,仅保留指定的文件列表数量
    for (int bynd = _fileList.Count - 1; bynd > _nMaxFiles - 1; bynd--)
    {
        _fileList.RemoveAt(bynd);
    }

    UpdateMenu();
}

动态增加菜单的处理,就是根据这些文件列表进行的菜单项处理,先清空旧的记录,然后添加新纪录,并添加对应给的事件处理即可。

其中增加一个【清空列表】的维护性操作。

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_07

当然,文件的打开,我们最好用一个状态记录文件是否编辑过,如果编辑过则应该提示用户是否保存原来的文件。

/// <summary>
/// 最近文件法的菜单项
/// </summary>
void menuItem_Click(object sender, EventArgs e)
{
    if (_bDocumentDirty)
    {
        var result = MessageBox.Show("需要保存到 " + DocumentFileName + "吗?", "提示", MessageBoxButtons.YesNoCancel);
        if (result == DialogResult.Yes)
        {
            FileSave();
        }
    }

    ToolStripMenuItem item = (ToolStripMenuItem)sender;
    int pos = item.GetCurrentParent().Items.IndexOf(item);
    if (pos >= 0 && pos < _fileList.Count)
    {
        DocumentFileName = item.Tag.ToString();
        FileOpen();
    }
}

/// <summary>
/// 清空最近菜单列表的菜单项
/// </summary>
void clearListItem_Click(object sender, EventArgs e)
{
    _fileList.Clear();
    UpdateMenu();
}

其中的菜单项入口,我

.NET缓存框架CacheManager在混合式开发框架中的应用(1)-CacheManager的介绍和使用

在我们开发的很多分布式项目里面(如基于WCF服务、Web API服务方式),由于数据提供涉及到数据库的相关操作,如果客户端的并发数量超过一定的数量,那么数据库的请求处理则以爆发式增长,如果数据库服务器无法快速处理这些并发请求,那么将会增加客户端的请求时间,严重者可能导致数据库服务或者应用服务直接瘫痪。缓存方案就是为这个而诞生,随着缓存的引入,可以把数据库的IO耗时操作,转换为内存数据的快速响应操作,或者把整个页面缓存到缓存系统里面。缓存框架在各个平台里面都有很多的实现,基本上多数是采用分布式缓存Redis、Memcached来实现。本系列文章介绍在.NET平台中,使用开源缓存框架CacheManager来实现数据的缓存的整个过程,本篇主要介绍CacheManager的使用和相关的测试。

在我们开发的很多分布式项目里面(如基于WCF服务、Web API服务方式),由于数据提供涉及到数据库的相关操作,如果客户端的并发数量超过一定的数量,那么数据库的请求处理则以爆发式增长,如果数据库服务器无法快速处理这些并发请求,那么将会增加客户端的请求时间,严重者可能导致数据库服务或者应用服务直接瘫痪。缓存方案就是为这个而诞生,随着缓存的引入,可以把数据库的IO耗时操作,转换为内存数据的快速响应操作,或者把整个页面缓存到缓存系统里面。缓存框架在各个平台里面都有很多的实现,基本上多数是采用分布式缓存Redis、Memcached来实现。本系列文章介绍在.NET平台中,使用开源缓存框架CacheManager来实现数据的缓存的整个过程,本篇主要介绍CacheManager的使用和相关的测试。

1、CacheManager的介绍

CacheManager是一个以C#语言开发的开源.Net缓存框架抽象层。它不是具体的缓存实现,但它支持多种缓存提供者(如Redis、Memcached等)并提供很多高级特性。
CacheManager 主要的目的使开发者更容易处理各种复杂的缓存场景,使用CacheManager可以实现多层的缓存,让进程内缓存在分布式缓存之前,且仅需几行代码来处理。
CacheManager 不仅仅是一个接口去统一不同缓存提供者的编程模型,它使我们在一个项目里面改变缓存策略变得非常容易,同时也提供更多的特性:如缓存同步、并发更新、序列号、事件处理、性能计算等等,开发人员可以在需要的时候选择这些特性。

CacheManager的GitHub源码地址为:https://github.com/MichaCo/CacheManager,如果需要具体的Demo及说明,可以访问其官网:http://cachemanager.net/。

使用Nuget为项目添加CacheManager包引用。CacheManager包含了很多的Package. 其中CacheManager.Core是必须的,其它的针对不同缓存平台上有不同的对应Package,整个Nuget包包含下面几个部分的内容。

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_08

CacheManager缓存框架支持Winform和Web等应用开发,以及支持多种流行的缓存实现,如MemoryCache、Redis、Memcached、Couchbase、System.Web.Caching等。

纵观整个缓存框架,它的特定很明显,在支持多种缓存实现外,本身主要是以内存缓存(进程内)为主,其他分布式缓存为辅的多层缓存架构方式,以达到快速命中和处理的机制,它们内部有相关的消息处理,使得即使是分布式缓存,也能够及时实现并发同步的缓存处理。

在网上充斥着基于某种单独缓存的实现和应用的趋势下,这种更抽象一层,以及提供更高级特性的缓存框架,在提供了统一编程模型的基础上,也实现了非常强大的兼容性,使得我一接触到这个框架,就对它爱不释手。

在GitHub上,缓存框架的前几名,除了这个缓存框架外,也还有一些,不过从文档的丰富程度等各方面来看,这个缓存框架还是非常值得拥有的。

CacheManager缓存框架在配置方面,支持代码方式的配置、XML配置,以及JSON格式的配置处理,非常方便。

CacheManager缓存框架默认对缓存数据的序列化是采用二进制方式,同时也支持多种自定义序列化的方式,如基于JOSN.NET的JSON序列化或者自定义序列化方式。

CacheManager缓存框架可以对缓存记录的增加、删除、更新等相关事件进行记录。

CacheManager缓存框架的缓存数据是强类型的,可以支持各种常规类型的处理,如Int、String、List类型等各种基础类型,以及可序列号的各种对象及列表对象。

CacheManager缓存框架支持多层的缓存实现,内部良好的机制可以高效、及时的同步好各层缓存的数据。

CacheManager缓存框架支持对各种操作的日志记录。

CacheManager缓存框架在分布式缓存实现中支持对更新的锁定和事务处理,让缓存保持更好的同步处理,内部机制实现版本冲突处理。

CacheManager缓存框架支持两种缓存过期的处理,如绝对时间的过期处理,以及固定时段的过期处理,是我们处理缓存过期更加方便。

....

很多特性基本上覆盖了缓存的常规特性,而且提供的接口基本上也是我们所经常用的Add、Put、Update、Remove等接口,使用起来也非常方便。

 

2、CacheManager缓存框架的应用

通过上面对CacheManager缓存框架的简单了解,我们大概了解了它应用的一些功能,但是实际上我们如何使用它,我们需要做一些学习和了解,首先我们需要在整个应用框架里面,知道缓存框架所扮演的角色。

一般来说,对于单机版本的应用场景,基本上是无需引入这种缓存框架的,因为客户端的并发量很少,而且数据请求也是寥寥可数的,性能方便不会有任何问题。

如果对于分布式的应用系统,如我在很多随笔中介绍到我的《混合式开发框架》、《Web开发框架》,由于数据请求是并发量随着用户增长而增长的,特别对于一些互联网的应用系统,极端情况下某个时间点一下可能就会达到了整个应用并发的峰值。那么这种分布式的系统架构,引入数据缓存来降低IO的并发数,把耗时请求转换为内存的高速请求,可以极大程度的降低系统宕机的风险。

我们以基于常规的Web API层来构建应用框架为例,整个数据缓存层,应该是在Web API层之下、业务实现层之上的一个层,如下所示。

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_09

在这个数据缓存层里面,我们引入了CacheManager缓存框架,实现分布式的缓存处理,使得我们的缓存数据能够在Redis服务器上实现数据的处理,同时可以在系统重启的时候,不至于丢失数据,能够快速恢复缓存数据。

为了实现对这个CacheManager缓存框架的使用,我们需要先进行一个使用测试,以便了解它的各个方便情况,然后才能广泛应用在我们的数据中间层上。

我们建立一个项目,并在引用的地方打开管理NuGet程序包,然后搜索到CacheManager的相关模块应用,并加入到项目引用里面,此为第一步工作。

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_10

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_11

我们创建一个客户对象类,用来模拟数据的存储和显示的,如下代码所示。

/// <summary>
/// 模拟数据存储的客户对象类
/// </summary>
public class Customer
{
    private static Customer m_Customer = null;
    private static ICacheManager<object> manager = null;

    //初始化列表值
    private static List<string> list = new List<string>() { "123", "456", "789" };

    /// <summary>
    /// 客户对象的单件实例
    /// </summary>
    public static Customer Instance
    {
        get
        {
            if(m_Customer == null)
            {
                m_Customer = new Customer();
            }
            if (manager == null)
            {
                manager = CacheFactory.Build("getStartedCache", settings =>
                {
                    settings.WithSystemRuntimeCacheHandle("handleName");
                }); 
            }

            return m_Customer;
        }
    }

这个类先做了一个单例的实现,并初始化缓存Customer类对象,以及缓存管理类ICacheManager<object> manager,这个是我们后面用来操作缓存数据的主要引用对象。

我们编写几个函数,用来实现对数据的获取,数据增加、数据删除的相关操作,并在数据增加、删除的时候,触发缓存的更新,这样我们下次获取数据的时候,就是最新的数据了。

/// <summary>
/// 获取所有客户信息
/// </summary>
/// <returns></returns>
public List<string> GetAll()
{
    var value = manager.Get("GetAll") as List<string>;
    if(value == null)
    {
        value = list;//初始化并加入缓存
        manager.Add("GetAll", value);

        Debug.WriteLine("初始化并加入列表");
    }
    else
    {
        Debug.WriteLine("访问缓存获取:{0}", DateTime.Now);
    }
    return value;
}

/// <summary>
/// 插入新的记录
/// </summary>
/// <param name="customer"></param>
/// <returns></returns>
public bool Insert(string customer)
{
    //先获取全部记录,然后加入记录
    if (!list.Contains(customer))
    {
        list.Add(customer);
    }

    //重新设置缓存
    manager.Update("GetAll", v => list);
    return true;
}

/// <summary>
/// 删除指定记录
/// </summary>
/// <param name="customer"></param>
/// <returns></returns>
public bool Delete(string customer)
{
    if(list.Contains(customer))
    {
        list.Remove(customer);
    }
    manager.Update("GetAll", v=>list);
    return true;
}

我们编写一个Winform程序来对这个缓存测试,以方便了解其中的机制。

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_12

我们在测试读取的时候,也就是对GetAll进行处理,插入以及删除主要就是为了测试缓存更新的处理。代码如下所示。

private void btnTestSimple_Click(object sender, EventArgs e)
{
    var list = Customer.Instance.GetAll();
    Debug.WriteLine("客户端获取记录数:{0}", list != null ? list.Count : 0);
}

private void btnInsert_Click(object sender, EventArgs e)
{
    var name = "abc";
    Customer.Instance.Insert(name);
    Debug.WriteLine(string.Format("插入记录:{0}", name));
}

private void btnDelete_Click(object sender, EventArgs e)
{
    var name = "abc";
    Customer.Instance.Delete(name);
    Debug.WriteLine(string.Format("删除记录:{0}", name));
}

我们跟踪记录,可以看到下面的日志信息。

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_13

我们可以看到,其中第一次是缓存没有的情况下进行初始化,初始化的记录数量为3个,然后插入记录后,再次获取数据的时候,缓存更新后的数量就变为4个了。

我们前面介绍了插入记录的后台代码,它同时进行了缓存数据的更新了。

/// <summary>
/// 插入新的记录
/// </summary>
/// <param name="customer"></param>
/// <returns></returns>
public bool Insert(string customer)
{
    //先获取全部记录,然后加入记录
    if (!list.Contains(customer))
    {
        list.Add(customer);
    }

    //重新设置缓存
    manager.Update("GetAll", v => list);
    return true;
}

我们前面介绍的缓存初始化配置的时候,默认是使用内存缓存的,并没有使用分布式缓存的配置,它的初始化代码如下:

manager = CacheFactory.Build("getStartedCache", settings =>
{
    settings.WithSystemRuntimeCacheHandle("handleName");
}); 

我们在正常情况下,还是需要使用这个强大的分布式缓存的,例如我们可以使用Redis的缓存处理,关于Redis的安装和使用,请参考我的随笔《基于C#的MongoDB数据库开发应用(4)--Redis的安装及使用》。

引入分布式的Redis缓存实现,我们的配置代码只需要做一定的改变即可,如下所示。

manager = CacheFactory.Build("getStartedCache", settings =>
{
    settings.WithSystemRuntimeCacheHandle("handleName")

    .And
    .WithRedisConfiguration("redis", config =>
    {
        config.WithAllowAdmin()
            .WithDatabase(0)
            .WithEndpoint("localhost", 6379);
    })
    .WithMaxRetries(100)
    .WithRetryTimeout(50)
    .WithRedisBackplane("redis")
    .WithRedisCacheHandle("redis", true)
    ;
}); 

其他的使用没有任何变化,我们同时增加一些测试数据方便我们查阅对应的缓存数据。

/// <summary>
/// 测试加入几个不同的数据
/// </summary>
/// <returns></returns>
public void TestCache()
{
    manager.Put("string", "abcdefg");
    manager.Put("int", 2016);
    manager.Put("decimal", 2016.9M);
    manager.Put("date", DateTime.Now);
    manager.Put("object", new UserInfo { ID = "123", Name = "Test", Age = 35 });
}
private void btnTestSimple_Click(object sender, EventArgs e)
{
    var list = Customer.Instance.GetAll();
    Debug.WriteLine("客户端获取记录数:{0}", list != null ? list.Count : 0);

    //测试加入一些值
    Customer.Instance.TestCache();
}

我们其中测试,一切和原来没有什么差异,程序的记录信息正常。

但是我们配置使用了Redis的缓存处理,因此可以使用“Redis Desktop Manager”软件来查看对应的缓存数据的,打开软件我们可以看到对应的缓存记录如下所示。

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_14

从上图我们可以查看到,我们添加的所有缓存键值都可以通过这个Redis的客户来进行查看,因为我们缓存里面有基于Redis缓存的实现,同理如果我们配置其他的缓存实现,如MemCache等,那么也可以在对应的管理界面上查看到。

我们完成这些处理后,可以发现缓存数据是可以实现多层缓存的,最为高效的就是内存缓存(也是它的主缓存),它会自动协同好各个分布式缓存的数据版本冲突问题。

引入如Redis的分布式缓存有一个好处,就是我们的数据可以在程序重新启动的时候,如果没有在内存缓存里面找到(没有击中目标),那么会寻找分布式缓存并进行加载,从而即使程序重启,我们之前的缓存数据依旧保存完好。

 

以上就是我基于对缓存框架的整体了解和其角色扮演做的相关介绍,以及介绍CacheManager的使用和一些场景的说明,通过上面简单案例的研究,我们可以逐步引入到更具实际价值的Web API 框架层面上进行使用,以期把缓存框架发挥其真正强大的价值,同时也为我们各种不同的缓存需要进行更高层次的探索,希望大家继续支持。

 

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_15主要研究技术:代码生成工具、会员管理系统、客户关系管理软件、病人资料管理软件、Visio二次开发、酒店管理系统、仓库管理系统等共享软件开发
专注于Winform开发框架/混合式开发框架、Web开发框架、Bootstrap开发框架、微信门户开发框架的研究及应用。
  转载请注明出处:
在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_15撰写人:伍华聪  

们应该在主程序初始化后把对应的菜单项赋值给辅助类即可。

//指定【最近使用的文件】的菜单项,方便对文档列表菜单进行动态创建
_fileHandler.RecentFilesMenu = this.menuFile_RecentFiles;

整个过程在此基本完成了,最后我们看看实际的效果,符合我们的预期。

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_17

 

在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_15主要研究技术:代码生成工具、会员管理系统、客户关系管理软件、病人资料管理软件、Visio二次开发、酒店管理系统、仓库管理系统等共享软件开发
专注于Winform开发框架/混合式开发框架、Web开发框架、Bootstrap开发框架、微信门户开发框架的研究及应用。
  转载请注明出处:
在Winform界面菜单中实现动态增加【最近使用的文件】菜单项_WinForm界面开发_15撰写人:伍华聪