MemoryCache 的原生插值方式浅谈

共计 2330 个字符，预计需要花费 6 分钟才能阅读完成。

.NET 运行时内置了常用的缓存模块：MemoryCache

标准的 MemoryCache 暴露了如下几个属性和方法：

public int Count {get;}
public void Compact(double percentage);
public ICacheEntry CreateEntry(object key);
public void Dispose();
public void Remove(object key);
public bool TryGetValue(object key, out object result);
protected virtual void Dispose(bool disposing);

但是你使用常规模式去插值 / 获取值，可能会出现意想不到的情况。

就如下这样的常规代码：

var s = new MemoryCache(new MemoryCacheOptions {});
var entry = s.CreateEntry("WeChatID");
entry.Value = "精益码农";

var f = s.TryGetValue("WeChatID",out object obj);

Console.WriteLine(f);
Console.WriteLine(obj);

会输出如下结果：

是不是很意外。

但是看官们一般不会使用 MemoryCache 的原生方法，而是使用位于同一命名空间的 扩展方法 Set。

var s = new MemoryCache(new MemoryCacheOptions {});
s.Set("WeChatID", "精益码农");
var f = s.TryGetValue("WeChatID", out object obj);

Console.WriteLine(f);
Console.WriteLine(obj);

如此便能正确输出。

扩展类源码看一看

public static TItem Set(this IMemoryCache cache, object key, TItem value)
{using ICacheEntry entry = cache.CreateEntry(key);
entry.Value = value;
return value;

扩展方法与原生方法的差异在于 using 关键字 (也说明了 CacheEntry 继承自 IDisposable 接口)。

继续追溯 CacheEntry 实现的 Dispose 方法：

public void Dispose()
{if (!_state.IsDisposed)
{
_state.IsDisposed = true;

if (_cache.TrackLinkedCacheEntries)
{CacheEntryHelper.ExitScope(this, _previous);
}

// Don't commit or propagate options if the CacheEntry Value was never set.
// We assume an exception occurred causing the caller to not set the Value successfully,
// so don't use this entry.
if (_state.IsValueSet)
{_cache.SetEntry(this);

if (_previous != null && CanPropagateOptions())
{PropagateOptions(_previous);
}
}

_previous = null; // we don't want to root unnecessary objects
}
}

注意其中的_cache.SetEntry(this)，表示在 MemoryCache 底层的 ConcurrentDictionary

综上：缓存项 CacheEntry 需要被 Dispose，才能被插入 MemoeyCache。

这是怎样的设计模式?IDisposable 接口不是用来释放资源吗?

为啥要使用 Dispose 方法来向 MemoryCache 插值?

不能使用一个明确的 Commit 方法吗?

这在 Github 上也有 issue 讨论，从 2017 年开始就有大佬质疑这是一个反人类的设计思路，官方为了不引入 Break Change，一直保持到现在。

基于此现状，我们如果使用 MemoryCache 的原生插值方法，需要这样：

var s = new MemoryCache(new MemoryCacheOptions {});
using (var entry = s.CreateEntry("WeChatID"))
{entry.Value = "精益码农";}
var f = s.TryGetValue("WeChatID", out object obj);
...

尽量不要使用 C#8.0 推出的不带大括号的 using 语法

using var entry = s.CreateEntry("WeChatID");
entry.Value = "精益码农";

var f = s.TryGetValue("WeChatID", out object obj);
...

这种没明确指定 using 作用范围的语法，会在函数末尾才执行 Dispose 方法, 导致执行到 TryGetValue 时，缓存项其实还没插入!!!

MemoryCache 插值的实现过程很奇葩
尽量使用带明确大括号范围的 using 语法，C#8.0 推出的不带大括号的 using 语法糖的作用时刻在函数末尾，会带来误导。

阿里云 2 核 2G 服务器 3M 带宽 61 元 1 年，有高配

腾讯云新客低至 82 元 / 年，老客户 99 元 / 年

代金券：在阿里云专用满减优惠券