第二节:从程序集的角度分析MemoryCache,并完成基本封装

时间:2023-03-08 19:56:38
第二节:从程序集的角度分析MemoryCache,并完成基本封装

一. 轻车熟路

有了上一个章节对 System.Web.Caching.Cache 的探究,这里我们按照同样的思路对 MemoryCache 进行探究,相信必定会得心应手。

1. 程序集准备

a. 需要给项目添加 System.Runtime.Cacheing程序集。

第二节:从程序集的角度分析MemoryCache,并完成基本封装

b. 需要给使用的地方添加两个引用。

第二节:从程序集的角度分析MemoryCache,并完成基本封装

2. 程序集探究

 在对应的类中输入关键字 MemoryCache,选中点击F12,查看MemoryCache程序集,如下图所示:

细心的人会发现:MemoryCache继承了ObjectCache,那么我们在使用的时候,是不是可以考虑一下,里氏替换原则呢? 后面揭晓。

第二节:从程序集的角度分析MemoryCache,并完成基本封装

 下面我们一起来分析从上往下来分析一下该程序集。

(1). 构造函数和属性。我们利用Default属性来代替 通过构造函数 new 来实例化对象。

  第二节:从程序集的角度分析MemoryCache,并完成基本封装

(2). 其他特有的新增属性。

可用内存量、可用物理内存百分比、更新内存前等待的时间量。

第二节:从程序集的角度分析MemoryCache,并完成基本封装

 (3). 顾名思义通俗易懂的方法。

  a:Contains方法:根据key,来判断缓存是否存在。

b:Get方法:根据key,来获取对应类型的缓存,通常结合泛型来封装。

c: GetCount方法:获取缓存的个数。

d: Remove方法:移除指定key的缓存。

第二节:从程序集的角度分析MemoryCache,并完成基本封装

 e:缓存的增加。

从程序集中可以看到,从长相貌似与增加相关的有:Add、AddOrGetExisting、Set,事实也是如此,这三类方法确实是与增加缓存相关的。

这样我们优先分析一下他们相同参数。

第二节:从程序集的角度分析MemoryCache,并完成基本封装

参数1: CacheItem item

查看CacheItem的源代码,发现实质上他就是把缓存的key和value转换成属性后的一个实体。

第二节:从程序集的角度分析MemoryCache,并完成基本封装

参数2CacheItemPolicy policy

查看CacheItemPolicy的源代码,发现该实体实体实质上就是把缓存常用的一些参数进行了封装,包括:相对过期时间、绝对过期时间、优先级、缓存失效前的回调、缓存失效后的回调

但注意:没有“缓存依赖”这个选项哦。

与System.Web.Caching.Cache 相比,相对过期时间和绝对过期时间的用法,用哪个,就设置哪个属性,另外一个忽略即可。

第二节:从程序集的角度分析MemoryCache,并完成基本封装

区分:

  A:Add方法插入: 如果插入成功,则为 true;如果缓存中已存在具有与 item 相同的键的项,则为 false。

  B:AddOrGetExisting方法: 如果存在具有相同键的缓存项,则为指定缓存项的值;否则为 null。

  C:Set方法:无返回值,至于存在相同键的情况,会是怎样呢?在后续测试章节中揭晓。

. 框架封装

   我们继续沿用上一章节中的封装思路,新建MemoryCacheHelp类,实现ICache接口,并封装自己特有的方法。

直接上代码吧。

 /// <summary>
/// MemoryCache缓存
/// 需要引用using System.Runtime.Caching;程序集
/// 不支持缓存依赖
/// </summary>
public class MemoryCacheHelp : ICache
{ //一. 实例化的两种方式 #region 1.在属性中直接实例化MemoryCache
protected ObjectCache Cache
{
get
{
return MemoryCache.Default;
}
}
#endregion #region 2.通过构造函数来实例化
//public ObjectCache Cache { get; set; }
//public MemoryCacheHelp()
//{
// Cache = MemoryCache.Default;
//}
#endregion //二. 实现接口中方法 #region 1.获取缓存的个数
/// <summary>
/// 获取缓存的个数
/// </summary>
public int Count
{
get
{
return (int)(Cache.GetCount());
}
}
#endregion #region 2.删除特定键的缓存
/// <summary>
/// 删除特定键的缓存
/// </summary>
/// <param name="key">键名</param>
public void Remove(string key)
{
Cache.Remove(key);
}
#endregion #region 3.移除全部缓存
/// <summary>
/// 移除全部缓存
/// </summary>
public void RemoveAll()
{
foreach (var item in Cache)
{
Cache.Remove(item.Key);
}
}
#endregion #region 4.根据键值获取特定类型的缓存
/// <summary>
/// 根据键值获取特定类型的缓存
/// </summary>
/// <typeparam name="T">泛型T</typeparam>
/// <param name="key">键名</param>
/// <returns></returns>
public T Get<T>(string key)
{
if (Cache.Contains(key))
{
return (T)Cache[key];
}
else
{
//此关键字对于引用类型会返回空,对于数值类型会返回零
return default(T);
}
}
#endregion #region 5.判断缓存是否存在
/// <summary>
/// 缓存是否存在
/// </summary>
/// <param name="key">键名</param>
/// <returns>true:表示存在; false:表示不存在</returns>
public bool Contains(string key)
{
return Cache.Contains(key);
}
#endregion #region 6.获取缓存值的类型(子类创建)
/// <summary>
/// 获取缓存值的类型
/// </summary>
/// <param name="key">键名</param>
/// <returns>键名对应的缓存值的类型</returns>
public Type GetCacheType(string key)
{
return Cache[key].GetType();
}
#endregion #region 7.增加或更新缓存(存在则更新,不存在则添加,采用绝对时间的模式)
/// <summary>
/// 增加或更新缓存
/// </summary>
/// <param name="key"></param>
/// <param name="value"></param>
/// <param name="cacheTime">绝对过期时间,默认为1天</param>
public void AddOrUpdate(string key, object value, int cacheTime = )
{
if (Cache.Contains(key))
{
Cache.Remove(key);
}
var policy = new CacheItemPolicy();
policy.AbsoluteExpiration = DateTime.Now + TimeSpan.FromDays(cacheTime);
Cache.Add(new CacheItem(key, value), policy);
} #endregion //三. 新增接口以外的方法 #region 1.获取全部缓存(子类创建-暂无办法实现)
public IEnumerator<KeyValuePair<string, object>> GetAllCache()
{
IEnumerator<KeyValuePair<string, object>> cacheList =null;
return cacheList;
}
#endregion #region 2.Add模式增加缓存(子类创建)
/// <summary>
/// Add模式增加缓存(如果该缓存已经存在,返回false,不存在,返回true)
/// </summary>
/// <param name="key">键</param>
/// <param name="value">值</param>
/// <param name="absoluteExpiration">绝对过期时间的参数:如:DateTime.Now.AddDays(1); DateTime.Parse("2016-5-28 20:32:00");</param>
/// <param name="slidingExpiration">相对过期时间的参数: 如:new TimeSpan(0,0, 0, 2) 天,小时,分钟,秒</param>
/// <param name="isAbsolute">true代表使用绝对过期时间,填写absoluteExpiration参数,slidingExpiration忽略不需要填写
/// false代表使用绝对过期时间,填写slidingExpiration 参数, absoluteExpiration忽略不需要填写
/// </param>
/// <param name="priority">缓存销毁时的优先级,没有特别要求,使用该封装的默认即可</param>
/// <param name="UpdateCallback">缓存失效前的回调:含有一个参数的委托:CacheEntryUpdateArguments</param>
/// <param name="RemovedCallback">缓存失效后的回调:含有一个参数的委托:CacheEntryRemovedArguments</param>
public bool AddCache(string key, object value, DateTime absoluteExpiration, TimeSpan slidingExpiration, bool isAbsolute = true,
CacheItemPriority priority = CacheItemPriority.Default, CacheEntryUpdateCallback UpdateCallback = null, CacheEntryRemovedCallback RemovedCallback = null)
{
bool flag;
CacheItemPolicy policy = new CacheItemPolicy();
policy.UpdateCallback = UpdateCallback;
policy.RemovedCallback = RemovedCallback;
policy.Priority = priority;
if (isAbsolute)
{
//绝对过期
policy.AbsoluteExpiration = absoluteExpiration;
flag = Cache.Add(key, value, policy); }
else
{
//相对过期
policy.SlidingExpiration = slidingExpiration;
flag = Cache.Add(key, value, policy); }
return flag;
}
#endregion #region 3.AddOrGetExisting模式增加缓存(子类创建)
/// <summary>
/// AddOrGetExisting模式增加缓存(如果该缓存已经存在,返回该缓存的值,不存在,执行插入操作,返回null)
/// </summary>
/// <param name="key">键</param>
/// <param name="value">值</param>
/// <param name="absoluteExpiration">绝对过期时间的参数:如:DateTime.Now.AddDays(1); DateTime.Parse("2016-5-28 20:32:00");</param>
/// <param name="slidingExpiration">相对过期时间的参数: 如:new TimeSpan(0,0, 0, 2) 天,小时,分钟,秒</param>
/// <param name="isAbsolute">true代表使用绝对过期时间,填写absoluteExpiration参数,slidingExpiration忽略不需要填写
/// false代表使用绝对过期时间,填写slidingExpiration 参数, absoluteExpiration忽略不需要填写
/// </param>
/// <param name="priority">缓存销毁时的优先级,没有特别要求,使用该封装的默认即可</param>
/// <param name="UpdateCallback">缓存失效前的回调:含有一个参数的委托:CacheEntryUpdateArguments</param>
/// <param name="RemovedCallback">缓存失效后的回调:含有一个参数的委托:CacheEntryRemovedArguments</param>
public object AddOrGetExisting(string key, object value, DateTime absoluteExpiration, TimeSpan slidingExpiration, bool isAbsolute = true,
CacheItemPriority priority = CacheItemPriority.Default, CacheEntryUpdateCallback UpdateCallback = null, CacheEntryRemovedCallback RemovedCallback = null)
{
object flag;
CacheItemPolicy policy = new CacheItemPolicy();
policy.UpdateCallback = UpdateCallback;
policy.RemovedCallback = RemovedCallback;
policy.Priority = priority;
if (isAbsolute)
{
//绝对过期
policy.AbsoluteExpiration = absoluteExpiration;
flag = Cache.AddOrGetExisting(key, value, policy); }
else
{
//相对过期
policy.SlidingExpiration = slidingExpiration;
flag = Cache.AddOrGetExisting(key, value, policy); }
return flag;
}
#endregion #region 4.Set模式增加缓存(子类创建 需要测试存在和不存在时各自对应什么情况)
/// <summary>
/// Set模式增加缓存(如果该缓存已经存在,??,不存在,??)
/// </summary>
/// <param name="key">键</param>
/// <param name="value">值</param>
/// <param name="absoluteExpiration">绝对过期时间的参数:如:DateTime.Now.AddDays(1); DateTime.Parse("2016-5-28 20:32:00");</param>
/// <param name="slidingExpiration">相对过期时间的参数: 如:new TimeSpan(0,0, 0, 2) 天,小时,分钟,秒</param>
/// <param name="isAbsolute">true代表使用绝对过期时间,填写absoluteExpiration参数,slidingExpiration忽略不需要填写
/// false代表使用绝对过期时间,填写slidingExpiration 参数, absoluteExpiration忽略不需要填写
/// </param>
/// <param name="priority">缓存销毁时的优先级,没有特别要求,使用该封装的默认即可</param>
/// <param name="UpdateCallback">缓存失效前的回调:含有一个参数的委托:CacheEntryUpdateArguments</param>
/// <param name="RemovedCallback">缓存失效后的回调:含有一个参数的委托:CacheEntryRemovedArguments</param>
public void SetCache(string key, object value, DateTime absoluteExpiration, TimeSpan slidingExpiration, bool isAbsolute = true,
CacheItemPriority priority = CacheItemPriority.Default, CacheEntryUpdateCallback UpdateCallback = null, CacheEntryRemovedCallback RemovedCallback = null)
{
CacheItemPolicy policy = new CacheItemPolicy();
policy.UpdateCallback = UpdateCallback;
policy.RemovedCallback = RemovedCallback;
policy.Priority = priority;
if (isAbsolute)
{
//绝对过期
policy.AbsoluteExpiration = absoluteExpiration;
Cache.Set(key, value, policy);
}
else
{
//相对过期
policy.SlidingExpiration = slidingExpiration;
Cache.Set(key, value, policy);
}
}
#endregion

  如何使用,以及使用过程的问题,在后续章节中揭晓。