Intro
前几天发现代码里的一个 BUG,原因是 MemoryCache 使用不当,可以对于很多人来说可能都知道,但还是想分享记录一下,避免以后写出同样的 BUG
Sample
直接来看下面的示例吧
- await using var services = new ServiceCollection()
- .AddMemoryCache()
- .BuildServiceProvider();
- Console.WriteLine("----- Bad -----");
- GetValidValues(5).Dump();
- GetValidValues(8).Dump();
- List<int> GetValidValues(int threhold)
- {
- var memoryCache = services.GetRequiredService<IMemoryCache>();
- var values = memoryCache.GetOrCreate("test1", entry =>
- {
- return Enumerable.Range(1, 10).ToList();
- });
- values.RemoveAll(x => x > threhold);
- return values;
- }
上面的 Dump 是一个扩展方法就是把 list 内的元素输出出来,实现如下:
- public static void Dump(this List<int> values)
- {
- var value = string.Join(",", values);
- Console.WriteLine(value);
- }
好了,来想一下上面的输出结果会是什么吧,期望的结果应该是每次都输出小于等于输入的值,实际是什么样的呢?实际输出结果如下:
Fix
可以看到第二次输出的结果和我们的期望不同,之所以会出现上面的问题是因为 MemoryCache 的对象是直接保存在内存中的对象,缓存不发生变化时每次都是返回同一个对象,如果发生修改后面再获取的就是修改后的状态了,所以正确的做法应该要返回一个新的对象而不是修改原来的对象,一个修改方法如下:
- List<int> GetValidValues(int threhold)
- {
- var memoryCache = services.GetRequiredService<IMemoryCache>();
- var values = memoryCache.GetOrCreate("test", entry =>
- {
- return Enumerable.Range(1, 10).ToList();
- });
- return values.Where(v => v <= threhold).ToList();
- }
修改后的输出结果如下:
More
MemoryCache 背后实际是一个 ConcurrentDictionary,value 是一个带着过期时间的对象 CacheEntry,
在不过期,没有发生变化的时候每次返回都是同一个对象,作为缓存对象,应该进行只读操作,不应该修改缓存的对象,如果需要修改则应创建新的对象,而非使用原来的对象。
References
https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCache.cs#L26
https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.Extensions.Caching.Memory/src/CacheEntry.cs
https://github.com/WeihanLi/SamplesInPractice/blob/master/MemoryCacheSample/Program.cs