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

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

一、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包包含下面几个部分的内容。

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等接口，使用起来也很是方便。

 

二、CacheManager缓存框架的应用

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

通常来讲，对于单机版本的应用场景，基本上是无需引入这种缓存框架的，由于客户端的并发量不多，并且数据请求也是寥寥可数的，性能方便不会有任何问题。

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

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

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

为了实现对这个CacheManager缓存框架的使用，咱们须要先进行一个使用测试，以便了解它的各个方便状况，而后才能普遍应用在咱们的数据中间层上。

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

咱们建立一个客户对象类，用来模拟数据的存储和显示的，以下代码所示。

/// <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程序来对这个缓存测试，以方便了解其中的机制。

咱们在测试读取的时候，也就是对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));
}

咱们跟踪记录，能够看到下面的日志信息。

咱们能够看到，其中第一次是缓存没有的状况下进行初始化，初始化的记录数量为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”软件来查看对应的缓存数据的，打开软件咱们能够看到对应的缓存记录以下所示。

从上图咱们能够查看到，咱们添加的全部缓存键值均可以经过这个Redis的客户来进行查看，由于咱们缓存里面有基于Redis缓存的实现，同理若是咱们配置其余的缓存实现，如MemCache等，那么也能够在对应的管理界面上查看到。

咱们完成这些处理后，能够发现缓存数据是能够实现多层缓存的，最为高效的就是内存缓存（也是它的主缓存），它会自动协同好各个分布式缓存的数据版本冲突问题。

引入如Redis的分布式缓存有一个好处，就是咱们的数据能够在程序从新启动的时候，若是没有在内存缓存里面找到（没有击中目标），那么会寻找分布式缓存并进行加载，从而即便程序重启，咱们以前的缓存数据依旧保存无缺。

 

以上就是我基于对缓存框架的总体了解和其角色扮演作的相关介绍，以及介绍CacheManager的使用和一些场景的说明，经过上面简单案例的研究，咱们能够逐步引入到更具实际价值的Web API 框架层面上进行使用，以期把缓存框架发挥其真正强大的价值，同时也为咱们各类不一样的缓存须要进行更高层次的探索，但愿你们继续支持。